Create On-Call schedule overrides
https://api.datadoghq.com/api/v2/on-call/schedules/{schedule_id}/overrideshttps://api.us3.datadoghq.com/api/v2/on-call/schedules/{schedule_id}/overrideshttps://api.us5.datadoghq.com/api/v2/on-call/schedules/{schedule_id}/overrideshttps://api.datadoghq.eu/api/v2/on-call/schedules/{schedule_id}/overrideshttps://api.ap1.datadoghq.com/api/v2/on-call/schedules/{schedule_id}/overrideshttps://api.ap2.datadoghq.com/api/v2/on-call/schedules/{schedule_id}/overrideshttps://api.uk1.datadoghq.com/api/v2/on-call/schedules/{schedule_id}/overrideshttps://api.ddog-gov.com/api/v2/on-call/schedules/{schedule_id}/overrideshttps://api.us2.ddog-gov.com/api/v2/on-call/schedules/{schedule_id}/overridesOverview
Create one or more overrides for the specified On-Call schedule.
Arguments
Path Parameters
schedule_id [required]The ID of the schedule.
Query Strings
includeComma-separated list of included relationships to be returned. Allowed values: user, overridden_user, user.color.
Request
Body Data (required)
data [required]A list of on-call schedule overrides to create.
attributes [required]Attributes for creating an on-call schedule override.
end [required]The end time of the override.
start [required]The start time of the override.
relationshipsRelationships to set when creating an on-call schedule override.
overridden_userDefines the relationship between an override and one of its associated users.
data [required]A reference to a user, containing the user's ID and resource type.
id [required]The unique identifier of the user.
type [required]Indicates that the related resource is of type 'users'.
usersusersuserDefines the relationship between an override and one of its associated users.
data [required]A reference to a user, containing the user's ID and resource type.
id [required]The unique identifier of the user.
type [required]Indicates that the related resource is of type 'users'.
usersuserstype [required]Indicates that the resource is of type 'overrides'.
overridesoverrides{
"data": [
{
"attributes": {
"end": "2024-01-08T02:53:01.000000000Z",
"start": "2024-01-07T02:53:01.000000000Z"
},
"relationships": {
"user": {
"data": {
"id": "00000000-aba1-0000-0000-000000000000",
"type": "users"
}
}
},
"type": "overrides"
}
]
}Response
Created
The on-call schedule overrides that were created, and any related included resources (such as users).
data [required]The on-call schedule overrides that were created.
attributesAttributes for an on-call schedule override.
endThe end time of the override.
inactiveWhether the override is inactive (for example, because its time range has ended).
startThe start time of the override.
id [required]The unique identifier of the override.
relationshipsRelationships for an on-call schedule override.
overridden_userDefines the relationship between an override and one of its associated users.
data [required]A reference to a user, containing the user's ID and resource type.
id [required]The unique identifier of the user.
type [required]Indicates that the related resource is of type 'users'.
usersusersscheduleDefines the relationship between an override and the schedule it belongs to.
data [required]A reference to the schedule the override belongs to, containing the schedule's ID and resource type.
id [required]The unique identifier of the schedule.
type [required]Indicates that the related resource is of type 'schedules'.
schedulesschedulesuserDefines the relationship between an override and one of its associated users.
data [required]A reference to a user, containing the user's ID and resource type.
id [required]The unique identifier of the user.
type [required]Indicates that the related resource is of type 'users'.
usersuserstype [required]Indicates that the resource is of type 'overrides'.
overridesoverridesincludedRelated resources referenced in the overrides' relationships, such as users.
<type=users>Represents a user object in the context of a schedule, including their id, type, and basic attributes.
attributesProvides basic user information for a schedule, including a name and email address.
colorThe user's on-call color, as a hex code (for example, #FF0000). Included only when user.color is requested in the include parameter.
emailThe user's email address.
nameThe user's name.
statusThe user's status.
active, deactivated, pendingid [required]The unique user identifier.
type [required]Users resource type.
usersusers{
"data": [
{
"attributes": {
"end": "2024-01-08T02:53:01.000000000Z",
"inactive": false,
"start": "2024-01-07T02:53:01.000000000Z"
},
"id": "00000000-0000-0000-0000-000000000000",
"relationships": {
"schedule": {
"data": {
"id": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d",
"type": "schedules"
}
},
"user": {
"data": {
"id": "00000000-aba1-0000-0000-000000000000",
"type": "users"
}
}
},
"type": "overrides"
}
],
"included": [
{
"attributes": {
"email": "jane.doe@example.com",
"name": "Jane Doe",
"status": ""
},
"id": "00000000-aba1-0000-0000-000000000000",
"type": "users"
}
]
}Bad Request
API error response.
errors [required]A list of errors.
{
"errors": [
"Bad Request"
]
}Unauthorized
API error response.
errors [required]A list of errors.
{
"errors": [
"Bad Request"
]
}Forbidden
API error response.
errors [required]A list of errors.
{
"errors": [
"Bad Request"
]
}Not Found
API error response.
errors [required]A list of errors.
{
"errors": [
"Bad Request"
]
}Too many requests
API error response.
errors [required]A list of errors.
{
"errors": [
"Bad Request"
]
}Code Example
# Path parameters
export schedule_id="3653d3c6-0c75-11ea-ad28-fb5701eabc7d"
# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/on-call/schedules/${schedule_id}/overrides" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": [
{
"attributes": {
"end": "2024-01-08T02:53:01.000000000Z",
"start": "2024-01-07T02:53:01.000000000Z"
},
"relationships": {
"user": {
"data": {
"id": "00000000-aba1-0000-0000-000000000000",
"type": "users"
}
}
},
"type": "overrides"
}
]
}
EOF# Path parameters
export schedule_id="3653d3c6-0c75-11ea-ad28-fb5701eabc7d"
# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/on-call/schedules/${schedule_id}/overrides" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": [
{
"attributes": {
"end": "2024-01-08T02:53:01.000000000Z",
"start": "2024-01-07T02:53:01.000000000Z"
},
"relationships": {
"user": {
"data": {
"id": "00000000-aba1-0000-0000-000000000000",
"type": "users"
}
}
},
"type": "overrides"
}
]
}
EOF# Path parameters
export schedule_id="3653d3c6-0c75-11ea-ad28-fb5701eabc7d"
# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/on-call/schedules/${schedule_id}/overrides" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": [
{
"attributes": {
"end": "2024-01-08T02:53:01.000000000Z",
"start": "2024-01-07T02:53:01.000000000Z"
},
"relationships": {
"user": {
"data": {
"id": "00000000-aba1-0000-0000-000000000000",
"type": "users"
}
}
},
"type": "overrides"
}
]
}
EOF# Path parameters
export schedule_id="3653d3c6-0c75-11ea-ad28-fb5701eabc7d"
# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/on-call/schedules/${schedule_id}/overrides" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": [
{
"attributes": {
"end": "2024-01-08T02:53:01.000000000Z",
"start": "2024-01-07T02:53:01.000000000Z"
},
"relationships": {
"user": {
"data": {
"id": "00000000-aba1-0000-0000-000000000000",
"type": "users"
}
}
},
"type": "overrides"
}
]
}
EOF# Path parameters
export schedule_id="3653d3c6-0c75-11ea-ad28-fb5701eabc7d"
# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/on-call/schedules/${schedule_id}/overrides" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": [
{
"attributes": {
"end": "2024-01-08T02:53:01.000000000Z",
"start": "2024-01-07T02:53:01.000000000Z"
},
"relationships": {
"user": {
"data": {
"id": "00000000-aba1-0000-0000-000000000000",
"type": "users"
}
}
},
"type": "overrides"
}
]
}
EOF# Path parameters
export schedule_id="3653d3c6-0c75-11ea-ad28-fb5701eabc7d"
# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/on-call/schedules/${schedule_id}/overrides" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": [
{
"attributes": {
"end": "2024-01-08T02:53:01.000000000Z",
"start": "2024-01-07T02:53:01.000000000Z"
},
"relationships": {
"user": {
"data": {
"id": "00000000-aba1-0000-0000-000000000000",
"type": "users"
}
}
},
"type": "overrides"
}
]
}
EOF# Path parameters
export schedule_id="3653d3c6-0c75-11ea-ad28-fb5701eabc7d"
# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/on-call/schedules/${schedule_id}/overrides" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": [
{
"attributes": {
"end": "2024-01-08T02:53:01.000000000Z",
"start": "2024-01-07T02:53:01.000000000Z"
},
"relationships": {
"user": {
"data": {
"id": "00000000-aba1-0000-0000-000000000000",
"type": "users"
}
}
},
"type": "overrides"
}
]
}
EOF# Path parameters
export schedule_id="3653d3c6-0c75-11ea-ad28-fb5701eabc7d"
# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/on-call/schedules/${schedule_id}/overrides" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": [
{
"attributes": {
"end": "2024-01-08T02:53:01.000000000Z",
"start": "2024-01-07T02:53:01.000000000Z"
},
"relationships": {
"user": {
"data": {
"id": "00000000-aba1-0000-0000-000000000000",
"type": "users"
}
}
},
"type": "overrides"
}
]
}
EOF# Path parameters
export schedule_id="3653d3c6-0c75-11ea-ad28-fb5701eabc7d"
# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/on-call/schedules/${schedule_id}/overrides" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": [
{
"attributes": {
"end": "2024-01-08T02:53:01.000000000Z",
"start": "2024-01-07T02:53:01.000000000Z"
},
"relationships": {
"user": {
"data": {
"id": "00000000-aba1-0000-0000-000000000000",
"type": "users"
}
}
},
"type": "overrides"
}
]
}
EOF