On-Call

Configure your Datadog On-Call directly through the Datadog API.

Create on-call schedule

v2 (latest)

POST https://api.ap1.datadoghq.com/api/v2/on-call/scheduleshttps://api.datadoghq.eu/api/v2/on-call/scheduleshttps://api.ddog-gov.com/api/v2/on-call/scheduleshttps://api.datadoghq.com/api/v2/on-call/scheduleshttps://api.us3.datadoghq.com/api/v2/on-call/scheduleshttps://api.us5.datadoghq.com/api/v2/on-call/schedules

개요

Create a new on-call schedule

인수

쿼리 문자열

이름

유형

설명

include

string

Comma-separated list of included relationships to be returned. Allowed values: teams, layers, layers.members, layers.members.user.

요청

Body Data (required)

Expand All

항목

유형

설명

data [required]

object

The core data wrapper for creating a schedule, encompassing attributes, relationships, and the resource type.

{
  "data": {
    "attributes": {
      "layers": [
        {
          "effective_date": "2021-11-01T11:11:11+00:00",
          "end_date": "2021-11-21T11:11:11+00:00",
          "interval": {
            "days": 1
          },
          "members": [
            {
              "user": {
                "id": "string"
              }
            }
          ],
          "name": "Layer 1",
          "restrictions": [
            {
              "end_day": "friday",
              "end_time": "17:00:00",
              "start_day": "monday",
              "start_time": "09:00:00"
            }
          ],
          "rotation_start": "2021-11-06T11:11:11+00:00"
        }
      ],
      "name": "Example-On-Call",
      "tags": [
        "tag1",
        "tag2"
      ],
      "time_zone": "America/New_York"
    },
    "relationships": {
      "teams": {
        "data": [
          {
            "id": "00000000-7ea3-0000-000a-000000000000",
            "type": "teams"
          }
        ]
      }
    },
    "type": "schedules"
  }
}

응답

Created

Top-level container for a schedule object, including both the data payload and any related included resources (such as teams, layers, or members).

Expand All

항목

유형

설명

data

object

Represents the primary data object for a schedule, linking attributes and relationships.

included

[ <oneOf>]

Any additional resources related to this schedule, such as teams and layers.

{
  "data": {
    "attributes": {
      "name": "Primary On-Call",
      "tags": [],
      "time_zone": "America/New_York"
    },
    "id": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d",
    "relationships": {
      "layers": {
        "data": [
          {
            "id": "67963b57-d67c-dfa7-b180-62ee9301d2f5",
            "type": "layers"
          }
        ]
      },
      "teams": {
        "data": [
          {
            "id": "00000000-da3a-0000-0000-000000000000",
            "type": "teams"
          }
        ]
      }
    },
    "type": "string"
  },
  "included": []
}

Bad Request

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Unauthorized

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Forbidden

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Too many requests

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

코드 사례

                          # Curl command
curl -X POST "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/on-call/schedules" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "layers": [
        {
          "effective_date": "2021-11-01T11:11:11+00:00",
          "end_date": "2021-11-21T11:11:11+00:00",
          "interval": {
            "days": 1
          },
          "members": [
            {
              "user": {
                "id": "string"
              }
            }
          ],
          "name": "Layer 1",
          "restrictions": [
            {
              "end_day": "friday",
              "end_time": "17:00:00",
              "start_day": "monday",
              "start_time": "09:00:00"
            }
          ],
          "rotation_start": "2021-11-06T11:11:11+00:00"
        }
      ],
      "name": "Example-On-Call",
      "tags": [
        "tag1",
        "tag2"
      ],
      "time_zone": "America/New_York"
    },
    "relationships": {
      "teams": {
        "data": [
          {
            "id": "00000000-7ea3-0000-000a-000000000000",
            "type": "teams"
          }
        ]
      }
    },
    "type": "schedules"
  }
}
EOF

                        

Get on-call schedule

v2 (latest)

GET https://api.ap1.datadoghq.com/api/v2/on-call/schedules/{schedule_id}https://api.datadoghq.eu/api/v2/on-call/schedules/{schedule_id}https://api.ddog-gov.com/api/v2/on-call/schedules/{schedule_id}https://api.datadoghq.com/api/v2/on-call/schedules/{schedule_id}https://api.us3.datadoghq.com/api/v2/on-call/schedules/{schedule_id}https://api.us5.datadoghq.com/api/v2/on-call/schedules/{schedule_id}

개요

Get an on-call schedule

인수

경로 파라미터

이름

유형

설명

schedule_id [required]

string

The ID of the schedule

쿼리 문자열

이름

유형

설명

include

string

Comma-separated list of included relationships to be returned. Allowed values: teams, layers, layers.members, layers.members.user.

응답

Top-level container for a schedule object, including both the data payload and any related included resources (such as teams, layers, or members).

Expand All

항목

유형

설명

data

object

Represents the primary data object for a schedule, linking attributes and relationships.

included

[ <oneOf>]

Any additional resources related to this schedule, such as teams and layers.

{
  "data": {
    "attributes": {
      "name": "Primary On-Call",
      "tags": [],
      "time_zone": "America/New_York"
    },
    "id": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d",
    "relationships": {
      "layers": {
        "data": [
          {
            "id": "67963b57-d67c-dfa7-b180-62ee9301d2f5",
            "type": "layers"
          }
        ]
      },
      "teams": {
        "data": [
          {
            "id": "00000000-da3a-0000-0000-000000000000",
            "type": "teams"
          }
        ]
      }
    },
    "type": "string"
  },
  "included": []
}

Unauthorized

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Forbidden

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Not Found

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Too many requests

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

코드 사례

                  # Path parameters
export schedule_id="3653d3c6-0c75-11ea-ad28-fb5701eabc7d"
# Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/on-call/schedules/${schedule_id}" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

                

Delete on-call schedule

v2 (latest)

DELETE https://api.ap1.datadoghq.com/api/v2/on-call/schedules/{schedule_id}https://api.datadoghq.eu/api/v2/on-call/schedules/{schedule_id}https://api.ddog-gov.com/api/v2/on-call/schedules/{schedule_id}https://api.datadoghq.com/api/v2/on-call/schedules/{schedule_id}https://api.us3.datadoghq.com/api/v2/on-call/schedules/{schedule_id}https://api.us5.datadoghq.com/api/v2/on-call/schedules/{schedule_id}

개요

Delete an on-call schedule

인수

경로 파라미터

이름

유형

설명

schedule_id [required]

string

The ID of the schedule

응답

No Content

Unauthorized

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Forbidden

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Not Found

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Too many requests

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

코드 사례

                  # Path parameters
export schedule_id="3653d3c6-0c75-11ea-ad28-fb5701eabc7d"
# Curl command
curl -X DELETE "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/on-call/schedules/${schedule_id}" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

                

Update on-call schedule

v2 (latest)

PUT https://api.ap1.datadoghq.com/api/v2/on-call/schedules/{schedule_id}https://api.datadoghq.eu/api/v2/on-call/schedules/{schedule_id}https://api.ddog-gov.com/api/v2/on-call/schedules/{schedule_id}https://api.datadoghq.com/api/v2/on-call/schedules/{schedule_id}https://api.us3.datadoghq.com/api/v2/on-call/schedules/{schedule_id}https://api.us5.datadoghq.com/api/v2/on-call/schedules/{schedule_id}

개요

Update a new on-call schedule

인수

경로 파라미터

이름

유형

설명

schedule_id [required]

string

The ID of the schedule

쿼리 문자열

이름

유형

설명

include

string

Comma-separated list of included relationships to be returned. Allowed values: teams, layers, layers.members, layers.members.user.

요청

Body Data (required)

Expand All

항목

유형

설명

data [required]

object

Contains all data needed to update an existing schedule, including its attributes (such as name, layers, or tags) and any relationships to teams.

{
  "data": {
    "id": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d",
    "attributes": {
      "layers": [
        {
          "id": "67963b57-d67c-dfa7-b180-62ee9301d2f5",
          "effective_date": "2021-11-01T11:11:11+00:00",
          "end_date": "2021-11-21T11:11:11+00:00",
          "interval": {
            "seconds": 300
          },
          "members": [
            {
              "user": {
                "id": "string"
              }
            }
          ],
          "name": "Layer 1",
          "restrictions": [
            {
              "end_day": "friday",
              "end_time": "17:00:00",
              "start_day": "monday",
              "start_time": "09:00:00"
            }
          ],
          "rotation_start": "2021-11-06T11:11:11+00:00"
        }
      ],
      "name": "Example-On-Call",
      "tags": [
        "tag1",
        "tag2",
        "tag3"
      ],
      "time_zone": "America/New_York"
    },
    "relationships": {
      "teams": {
        "data": [
          {
            "id": "00000000-7ea3-0000-000a-000000000000",
            "type": "teams"
          }
        ]
      }
    },
    "type": "schedules"
  }
}

응답

Top-level container for a schedule object, including both the data payload and any related included resources (such as teams, layers, or members).

Expand All

항목

유형

설명

data

object

Represents the primary data object for a schedule, linking attributes and relationships.

included

[ <oneOf>]

Any additional resources related to this schedule, such as teams and layers.

{
  "data": {
    "attributes": {
      "name": "Primary On-Call",
      "tags": [],
      "time_zone": "America/New_York"
    },
    "id": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d",
    "relationships": {
      "layers": {
        "data": [
          {
            "id": "67963b57-d67c-dfa7-b180-62ee9301d2f5",
            "type": "layers"
          }
        ]
      },
      "teams": {
        "data": [
          {
            "id": "00000000-da3a-0000-0000-000000000000",
            "type": "teams"
          }
        ]
      }
    },
    "type": "string"
  },
  "included": []
}

Bad Request

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Unauthorized

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Forbidden

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Not Found

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Too many requests

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

코드 사례

                          # Path parameters
export schedule_id="3653d3c6-0c75-11ea-ad28-fb5701eabc7d"
# Curl command
curl -X PUT "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/on-call/schedules/${schedule_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
  "data": {
    "id": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d",
    "attributes": {
      "layers": [
        {
          "id": "67963b57-d67c-dfa7-b180-62ee9301d2f5",
          "effective_date": "2021-11-01T11:11:11+00:00",
          "end_date": "2021-11-21T11:11:11+00:00",
          "interval": {
            "seconds": 300
          },
          "members": [
            {
              "user": {
                "id": "string"
              }
            }
          ],
          "name": "Layer 1",
          "restrictions": [
            {
              "end_day": "friday",
              "end_time": "17:00:00",
              "start_day": "monday",
              "start_time": "09:00:00"
            }
          ],
          "rotation_start": "2021-11-06T11:11:11+00:00"
        }
      ],
      "name": "Example-On-Call",
      "tags": [
        "tag1",
        "tag2",
        "tag3"
      ],
      "time_zone": "America/New_York"
    },
    "relationships": {
      "teams": {
        "data": [
          {
            "id": "00000000-7ea3-0000-000a-000000000000",
            "type": "teams"
          }
        ]
      }
    },
    "type": "schedules"
  }
}
EOF

                        

On-Call

Create on-call schedule

개요

인수

쿼리 문자열

요청

Body Data (required)

응답

코드 사례

Create on-call schedule returns "Created" response

Get on-call schedule

개요

인수

경로 파라미터

쿼리 문자열

응답

코드 사례

Get on-call schedule

Delete on-call schedule

개요

인수

경로 파라미터

응답

코드 사례

Delete on-call schedule

Update on-call schedule

개요

인수

경로 파라미터

쿼리 문자열

요청

Body Data (required)

응답

코드 사례

Update on-call schedule returns "OK" response