Language

Français English 日本語 한국어 Español

Datadog Site

Site help
US1 US3 US5 EU AP1 AP2 US1-FED
Cette page n'est pas encore disponible en français, sa traduction est en cours.
Si vous avez des questions ou des retours sur notre projet de traduction actuel, n'hésitez pas à nous contacter.

Change Management

View and manage change requests within Change Management. See the Case Management page for more information.

Create a change request

Note: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.

POST https://api.ap1.datadoghq.com/api/v2/change-management/change-requesthttps://api.ap2.datadoghq.com/api/v2/change-management/change-requesthttps://api.datadoghq.eu/api/v2/change-management/change-requesthttps://api.ddog-gov.com/api/v2/change-management/change-requesthttps://api.datadoghq.com/api/v2/change-management/change-requesthttps://api.us3.datadoghq.com/api/v2/change-management/change-requesthttps://api.us5.datadoghq.com/api/v2/change-management/change-request

Présentation

Create a new change request.

OAuth apps require the cases_write authorization scope to access this endpoint.

Requête

Body Data (required)

Change request payload.

Expand All

Champ

Type

Description

data [required]

object

Data object to create a change request.

attributes [required]

object

Attributes for creating a change request.

change_request_linked_incident_uuid

string

The UUID of an incident to link to the change request.

change_request_maintenance_window_query

string

The maintenance window query for the change request.

change_request_plan

string

The plan associated with the change request.

change_request_risk

enum

The risk level of the change request. Allowed enum values: UNDEFINED,LOW,MEDIUM,HIGH

change_request_type

enum

The type of the change request. Allowed enum values: NORMAL,STANDARD,EMERGENCY

description

string

The description of the change request.

end_date

date-time

The planned end date of the change request.

project_id

string

The project UUID to associate with the change request.

requested_teams

[string]

A list of team handles to request decisions from.

start_date

date-time

The planned start date of the change request.

title [required]

string

The title of the change request.

type [required]

enum

Change request resource type. Allowed enum values: change_request

{
  "data": {
    "attributes": {
      "change_request_linked_incident_uuid": "00000000-0000-0000-0000-000000000000",
      "change_request_maintenance_window_query": "",
      "change_request_plan": "1. Deploy to staging 2. Run tests 3. Deploy to production",
      "change_request_risk": "LOW",
      "change_request_type": "NORMAL",
      "description": "Deploying new payment service v2.1",
      "end_date": "2024-01-02T15:00:00Z",
      "project_id": "d4bbe1af-f36e-42f1-87c1-493ca35c320e",
      "requested_teams": [
        "team-handle-1"
      ],
      "start_date": "2024-01-01T03:00:00Z",
      "title": "Deploy new payment service"
    },
    "type": "change_request"
  }
}

Réponse

Created

Response object for a change request.

Expand All

Champ

Type

Description

data [required]

object

Data object for a change request response.

attributes [required]

object

Attributes of a change request response.

archived_at

date-time

Timestamp of when the change request was archived.

attributes [required]

object

Custom attributes of the change request as key-value pairs.

<any-key>

[string]

change_request_linked_incident_uuid [required]

string

The UUID of the linked incident.

change_request_maintenance_window_query [required]

string

The maintenance window query for the change request.

change_request_plan [required]

string

The plan associated with the change request.

change_request_risk [required]

enum

The risk level of the change request. Allowed enum values: UNDEFINED,LOW,MEDIUM,HIGH

change_request_type [required]

enum

The type of the change request. Allowed enum values: NORMAL,STANDARD,EMERGENCY

closed_at

date-time

Timestamp of when the change request was closed.

created_at [required]

date-time

Timestamp of when the change request was created.

creation_source [required]

string

The source from which the change request was created.

description [required]

string

The description of the change request.

end_date

date-time

The planned end date of the change request.

key [required]

string

The human-readable key of the change request.

modified_at [required]

date-time

Timestamp of when the change request was last modified.

plan_notebook_id [required]

int64

The notebook ID associated with the change request plan.

priority [required]

string

The priority of the change request.

project_id [required]

string

The project UUID associated with the change request.

start_date

date-time

The planned start date of the change request.

status [required]

string

The current status of the change request.

title [required]

string

The title of the change request.

type [required]

string

The case type.

id [required]

string

The identifier of the change request.

relationships

object

Relationships of a change request.

change_request_decisions [required]

object

Relationship to change request decisions.

data [required]

[object]

Array of decision relationship data.

id [required]

string

The decision UUID.

type [required]

enum

Change request decision resource type. Allowed enum values: change_request_decision

created_by [required]

object

Relationship to a user.

data [required]

object

User relationship data.

id [required]

string

The user UUID.

type [required]

string

The user resource type.

modified_by [required]

object

Relationship to a user.

data [required]

object

User relationship data.

id [required]

string

The user UUID.

type [required]

string

The user resource type.

type [required]

enum

Change request resource type. Allowed enum values: change_request

included

[ <oneOf>]

Included resources related to the change request.

Option 1

object

An included user resource.

attributes [required]

object

Attributes of an included user.

email [required]

string

The email of the user.

handle [required]

string

The handle of the user.

name [required]

string

The name of the user.

id [required]

string

The user UUID.

type [required]

string

The resource type.

Option 2

object

An included change request decision resource.

attributes [required]

object

Attributes of a change request decision in a response.

change_request_status [required]

enum

The status of a change request decision. Allowed enum values: REQUESTED,APPROVED,DECLINED

decided_at [required]

date-time

Timestamp of when the decision was made.

decision_reason [required]

string

The reason for the decision.

deleted_at [required]

date-time

Timestamp of when the decision was deleted.

request_reason [required]

string

The reason for requesting the decision.

requested_at [required]

date-time

Timestamp of when the decision was requested.

id [required]

string

The decision UUID.

relationships

object

Relationships of a change request decision.

modified_by [required]

object

Relationship to a user.

data [required]

object

User relationship data.

id [required]

string

The user UUID.

type [required]

string

The user resource type.

requested_by_user [required]

object

Relationship to a user.

data [required]

object

User relationship data.

id [required]

string

The user UUID.

type [required]

string

The user resource type.

requested_user [required]

object

Relationship to a user.

data [required]

object

User relationship data.

id [required]

string

The user UUID.

type [required]

string

The user resource type.

type [required]

enum

Change request decision resource type. Allowed enum values: change_request_decision

{
  "data": {
    "attributes": {
      "archived_at": "2019-09-19T10:00:00.000Z",
      "attributes": {
        "<any-key>": []
      },
      "change_request_linked_incident_uuid": "",
      "change_request_maintenance_window_query": "",
      "change_request_plan": "",
      "change_request_risk": "LOW",
      "change_request_type": "NORMAL",
      "closed_at": "2019-09-19T10:00:00.000Z",
      "created_at": "2024-01-01T00:00:00Z",
      "creation_source": "CS_MANUAL",
      "description": "Deploying new payment service v2.1",
      "end_date": "2024-01-02T15:00:00Z",
      "key": "CHM-1234",
      "modified_at": "2024-01-01T00:00:00Z",
      "plan_notebook_id": 0,
      "priority": "NOT_DEFINED",
      "project_id": "d4bbe1af-f36e-42f1-87c1-493ca35c320e",
      "start_date": "2024-01-01T03:00:00Z",
      "status": "OPEN",
      "title": "Deploy new payment service",
      "type": "CHANGE_REQUEST"
    },
    "id": "CHM-1234",
    "relationships": {
      "change_request_decisions": {
        "data": [
          {
            "id": "decision-id-0",
            "type": "change_request_decision"
          }
        ]
      },
      "created_by": {
        "data": {
          "id": "00000000-0000-0000-0000-000000000000",
          "type": "user"
        }
      },
      "modified_by": {
        "data": {
          "id": "00000000-0000-0000-0000-000000000000",
          "type": "user"
        }
      }
    },
    "type": "change_request"
  },
  "included": [
    {
      "attributes": {
        "email": "john.doe@example.com",
        "handle": "john.doe@example.com",
        "name": "John Doe"
      },
      "id": "00000000-0000-0000-0000-000000000000",
      "type": "user"
    }
  ]
}

Bad Request

API error response.

Expand All

Champ

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Forbidden

API error response.

Expand All

Champ

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Too many requests

API error response.

Expand All

Champ

Type

Description

errors [required]

[string]

A list of errors.

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

Exemple de code

                  # Curl command
curl -X POST "https://api.ap1.datadoghq.com"https://api.ap2.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/change-management/change-request" \
-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": {
      "title": "Deploy new payment service"
    },
    "type": "change_request"
  }
}
EOF

Get a change request

Note: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.

GET https://api.ap1.datadoghq.com/api/v2/change-management/change-request/{change_request_id}https://api.ap2.datadoghq.com/api/v2/change-management/change-request/{change_request_id}https://api.datadoghq.eu/api/v2/change-management/change-request/{change_request_id}https://api.ddog-gov.com/api/v2/change-management/change-request/{change_request_id}https://api.datadoghq.com/api/v2/change-management/change-request/{change_request_id}https://api.us3.datadoghq.com/api/v2/change-management/change-request/{change_request_id}https://api.us5.datadoghq.com/api/v2/change-management/change-request/{change_request_id}

Présentation

Get the details of a change request by its ID.

OAuth apps require the cases_read authorization scope to access this endpoint.

Arguments

Paramètres du chemin

Nom

Type

Description

change_request_id [required]

string

The identifier of the change request.

Réponse

OK

Response object for a change request.

Expand All

Champ

Type

Description

data [required]

object

Data object for a change request response.

attributes [required]

object

Attributes of a change request response.

archived_at

date-time

Timestamp of when the change request was archived.

attributes [required]

object

Custom attributes of the change request as key-value pairs.

<any-key>

[string]

change_request_linked_incident_uuid [required]

string

The UUID of the linked incident.

change_request_maintenance_window_query [required]

string

The maintenance window query for the change request.

change_request_plan [required]

string

The plan associated with the change request.

change_request_risk [required]

enum

The risk level of the change request. Allowed enum values: UNDEFINED,LOW,MEDIUM,HIGH

change_request_type [required]

enum

The type of the change request. Allowed enum values: NORMAL,STANDARD,EMERGENCY

closed_at

date-time

Timestamp of when the change request was closed.

created_at [required]

date-time

Timestamp of when the change request was created.

creation_source [required]

string

The source from which the change request was created.

description [required]

string

The description of the change request.

end_date

date-time

The planned end date of the change request.

key [required]

string

The human-readable key of the change request.

modified_at [required]

date-time

Timestamp of when the change request was last modified.

plan_notebook_id [required]

int64

The notebook ID associated with the change request plan.

priority [required]

string

The priority of the change request.

project_id [required]

string

The project UUID associated with the change request.

start_date

date-time

The planned start date of the change request.

status [required]

string

The current status of the change request.

title [required]

string

The title of the change request.

type [required]

string

The case type.

id [required]

string

The identifier of the change request.

relationships

object

Relationships of a change request.

change_request_decisions [required]

object

Relationship to change request decisions.

data [required]

[object]

Array of decision relationship data.

id [required]

string

The decision UUID.

type [required]

enum

Change request decision resource type. Allowed enum values: change_request_decision

created_by [required]

object

Relationship to a user.

data [required]

object

User relationship data.

id [required]

string

The user UUID.

type [required]

string

The user resource type.

modified_by [required]

object

Relationship to a user.

data [required]

object

User relationship data.

id [required]

string

The user UUID.

type [required]

string

The user resource type.

type [required]

enum

Change request resource type. Allowed enum values: change_request

included

[ <oneOf>]

Included resources related to the change request.

Option 1

object

An included user resource.

attributes [required]

object

Attributes of an included user.

email [required]

string

The email of the user.

handle [required]

string

The handle of the user.

name [required]

string

The name of the user.

id [required]

string

The user UUID.

type [required]

string

The resource type.

Option 2

object

An included change request decision resource.

attributes [required]

object

Attributes of a change request decision in a response.

change_request_status [required]

enum

The status of a change request decision. Allowed enum values: REQUESTED,APPROVED,DECLINED

decided_at [required]

date-time

Timestamp of when the decision was made.

decision_reason [required]

string

The reason for the decision.

deleted_at [required]

date-time

Timestamp of when the decision was deleted.

request_reason [required]

string

The reason for requesting the decision.

requested_at [required]

date-time

Timestamp of when the decision was requested.

id [required]

string

The decision UUID.

relationships

object

Relationships of a change request decision.

modified_by [required]

object

Relationship to a user.

data [required]

object

User relationship data.

id [required]

string

The user UUID.

type [required]

string

The user resource type.

requested_by_user [required]

object

Relationship to a user.

data [required]

object

User relationship data.

id [required]

string

The user UUID.

type [required]

string

The user resource type.

requested_user [required]

object

Relationship to a user.

data [required]

object

User relationship data.

id [required]

string

The user UUID.

type [required]

string

The user resource type.

type [required]

enum

Change request decision resource type. Allowed enum values: change_request_decision

{
  "data": {
    "attributes": {
      "archived_at": "2019-09-19T10:00:00.000Z",
      "attributes": {
        "<any-key>": []
      },
      "change_request_linked_incident_uuid": "",
      "change_request_maintenance_window_query": "",
      "change_request_plan": "",
      "change_request_risk": "LOW",
      "change_request_type": "NORMAL",
      "closed_at": "2019-09-19T10:00:00.000Z",
      "created_at": "2024-01-01T00:00:00Z",
      "creation_source": "CS_MANUAL",
      "description": "Deploying new payment service v2.1",
      "end_date": "2024-01-02T15:00:00Z",
      "key": "CHM-1234",
      "modified_at": "2024-01-01T00:00:00Z",
      "plan_notebook_id": 0,
      "priority": "NOT_DEFINED",
      "project_id": "d4bbe1af-f36e-42f1-87c1-493ca35c320e",
      "start_date": "2024-01-01T03:00:00Z",
      "status": "OPEN",
      "title": "Deploy new payment service",
      "type": "CHANGE_REQUEST"
    },
    "id": "CHM-1234",
    "relationships": {
      "change_request_decisions": {
        "data": [
          {
            "id": "decision-id-0",
            "type": "change_request_decision"
          }
        ]
      },
      "created_by": {
        "data": {
          "id": "00000000-0000-0000-0000-000000000000",
          "type": "user"
        }
      },
      "modified_by": {
        "data": {
          "id": "00000000-0000-0000-0000-000000000000",
          "type": "user"
        }
      }
    },
    "type": "change_request"
  },
  "included": [
    {
      "attributes": {
        "email": "john.doe@example.com",
        "handle": "john.doe@example.com",
        "name": "John Doe"
      },
      "id": "00000000-0000-0000-0000-000000000000",
      "type": "user"
    }
  ]
}

Bad Request

API error response.

Expand All

Champ

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Not Found

API error response.

Expand All

Champ

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Too many requests

API error response.

Expand All

Champ

Type

Description

errors [required]

[string]

A list of errors.

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

Exemple de code

                  # Path parameters
export change_request_id="CHM-1234"
# Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.ap2.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/change-management/change-request/${change_request_id}" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

Update a change request

Note: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.

PATCH https://api.ap1.datadoghq.com/api/v2/change-management/change-request/{change_request_id}https://api.ap2.datadoghq.com/api/v2/change-management/change-request/{change_request_id}https://api.datadoghq.eu/api/v2/change-management/change-request/{change_request_id}https://api.ddog-gov.com/api/v2/change-management/change-request/{change_request_id}https://api.datadoghq.com/api/v2/change-management/change-request/{change_request_id}https://api.us3.datadoghq.com/api/v2/change-management/change-request/{change_request_id}https://api.us5.datadoghq.com/api/v2/change-management/change-request/{change_request_id}

Présentation

Update the properties of a change request.

OAuth apps require the cases_write authorization scope to access this endpoint.

Arguments

Paramètres du chemin

Nom

Type

Description

change_request_id [required]

string

The identifier of the change request.

Requête

Body Data (required)

Change request update payload.

Expand All

Champ

Type

Description

data [required]

object

Data object to update a change request.

attributes

object

Attributes for updating a change request.

change_request_plan

string

The plan associated with the change request.

change_request_risk

enum

The risk level of the change request. Allowed enum values: UNDEFINED,LOW,MEDIUM,HIGH

change_request_type

enum

The type of the change request. Allowed enum values: NORMAL,STANDARD,EMERGENCY

end_date

date-time

The planned end date of the change request.

id

string

The identifier of the change request to update.

start_date

date-time

The planned start date of the change request.

relationships

object

Relationships for updating a change request.

change_request_decisions

object

Relationship to change request decisions.

data [required]

[object]

Array of decision relationship data.

id [required]

string

The decision UUID.

type [required]

enum

Change request decision resource type. Allowed enum values: change_request_decision

type [required]

enum

Change request resource type. Allowed enum values: change_request

included

[object]

Included resources for the change request update.

attributes

object

Attributes for creating a change request decision.

change_request_status

enum

The status of a change request decision. Allowed enum values: REQUESTED,APPROVED,DECLINED

request_reason

string

The reason for requesting the decision.

id [required]

string

The decision identifier.

relationships

object

Relationships for creating a change request decision.

requested_user

object

Relationship to a user.

data [required]

object

User relationship data.

id [required]

string

The user UUID.

type [required]

string

The user resource type.

type [required]

enum

Change request decision resource type. Allowed enum values: change_request_decision

{
  "data": {
    "attributes": {
      "change_request_plan": "Updated deployment plan",
      "change_request_risk": "LOW",
      "change_request_type": "NORMAL",
      "end_date": "2024-01-02T15:00:00Z",
      "id": "CHM-1234",
      "start_date": "2024-01-01T03:00:00Z"
    },
    "relationships": {
      "change_request_decisions": {
        "data": [
          {
            "id": "decision-id-0",
            "type": "change_request_decision"
          }
        ]
      }
    },
    "type": "change_request"
  },
  "included": [
    {
      "attributes": {
        "change_request_status": "REQUESTED",
        "request_reason": "Please review and approve this change"
      },
      "id": "decision-id-0",
      "relationships": {
        "requested_user": {
          "data": {
            "id": "00000000-0000-0000-0000-000000000000",
            "type": "user"
          }
        }
      },
      "type": "change_request_decision"
    }
  ]
}

Réponse

OK

Response object for a change request.

Expand All

Champ

Type

Description

data [required]

object

Data object for a change request response.

attributes [required]

object

Attributes of a change request response.

archived_at

date-time

Timestamp of when the change request was archived.

attributes [required]

object

Custom attributes of the change request as key-value pairs.

<any-key>

[string]

change_request_linked_incident_uuid [required]

string

The UUID of the linked incident.

change_request_maintenance_window_query [required]

string

The maintenance window query for the change request.

change_request_plan [required]

string

The plan associated with the change request.

change_request_risk [required]

enum

The risk level of the change request. Allowed enum values: UNDEFINED,LOW,MEDIUM,HIGH

change_request_type [required]

enum

The type of the change request. Allowed enum values: NORMAL,STANDARD,EMERGENCY

closed_at

date-time

Timestamp of when the change request was closed.

created_at [required]

date-time

Timestamp of when the change request was created.

creation_source [required]

string

The source from which the change request was created.

description [required]

string

The description of the change request.

end_date

date-time

The planned end date of the change request.

key [required]

string

The human-readable key of the change request.

modified_at [required]

date-time

Timestamp of when the change request was last modified.

plan_notebook_id [required]

int64

The notebook ID associated with the change request plan.

priority [required]

string

The priority of the change request.

project_id [required]

string

The project UUID associated with the change request.

start_date

date-time

The planned start date of the change request.

status [required]

string

The current status of the change request.

title [required]

string

The title of the change request.

type [required]

string

The case type.

id [required]

string

The identifier of the change request.

relationships

object

Relationships of a change request.

change_request_decisions [required]

object

Relationship to change request decisions.

data [required]

[object]

Array of decision relationship data.

id [required]

string

The decision UUID.

type [required]

enum

Change request decision resource type. Allowed enum values: change_request_decision

created_by [required]

object

Relationship to a user.

data [required]

object

User relationship data.

id [required]

string

The user UUID.

type [required]

string

The user resource type.

modified_by [required]

object

Relationship to a user.

data [required]

object

User relationship data.

id [required]

string

The user UUID.

type [required]

string

The user resource type.

type [required]

enum

Change request resource type. Allowed enum values: change_request

included

[ <oneOf>]

Included resources related to the change request.

Option 1

object

An included user resource.

attributes [required]

object

Attributes of an included user.

email [required]

string

The email of the user.

handle [required]

string

The handle of the user.

name [required]

string

The name of the user.

id [required]

string

The user UUID.

type [required]

string

The resource type.

Option 2

object

An included change request decision resource.

attributes [required]

object

Attributes of a change request decision in a response.

change_request_status [required]

enum

The status of a change request decision. Allowed enum values: REQUESTED,APPROVED,DECLINED

decided_at [required]

date-time

Timestamp of when the decision was made.

decision_reason [required]

string

The reason for the decision.

deleted_at [required]

date-time

Timestamp of when the decision was deleted.

request_reason [required]

string

The reason for requesting the decision.

requested_at [required]

date-time

Timestamp of when the decision was requested.

id [required]

string

The decision UUID.

relationships

object

Relationships of a change request decision.

modified_by [required]

object

Relationship to a user.

data [required]

object

User relationship data.

id [required]

string

The user UUID.

type [required]

string

The user resource type.

requested_by_user [required]

object

Relationship to a user.

data [required]

object

User relationship data.

id [required]

string

The user UUID.

type [required]

string

The user resource type.

requested_user [required]

object

Relationship to a user.

data [required]

object

User relationship data.

id [required]

string

The user UUID.

type [required]

string

The user resource type.

type [required]

enum

Change request decision resource type. Allowed enum values: change_request_decision

{
  "data": {
    "attributes": {
      "archived_at": "2019-09-19T10:00:00.000Z",
      "attributes": {
        "<any-key>": []
      },
      "change_request_linked_incident_uuid": "",
      "change_request_maintenance_window_query": "",
      "change_request_plan": "",
      "change_request_risk": "LOW",
      "change_request_type": "NORMAL",
      "closed_at": "2019-09-19T10:00:00.000Z",
      "created_at": "2024-01-01T00:00:00Z",
      "creation_source": "CS_MANUAL",
      "description": "Deploying new payment service v2.1",
      "end_date": "2024-01-02T15:00:00Z",
      "key": "CHM-1234",
      "modified_at": "2024-01-01T00:00:00Z",
      "plan_notebook_id": 0,
      "priority": "NOT_DEFINED",
      "project_id": "d4bbe1af-f36e-42f1-87c1-493ca35c320e",
      "start_date": "2024-01-01T03:00:00Z",
      "status": "OPEN",
      "title": "Deploy new payment service",
      "type": "CHANGE_REQUEST"
    },
    "id": "CHM-1234",
    "relationships": {
      "change_request_decisions": {
        "data": [
          {
            "id": "decision-id-0",
            "type": "change_request_decision"
          }
        ]
      },
      "created_by": {
        "data": {
          "id": "00000000-0000-0000-0000-000000000000",
          "type": "user"
        }
      },
      "modified_by": {
        "data": {
          "id": "00000000-0000-0000-0000-000000000000",
          "type": "user"
        }
      }
    },
    "type": "change_request"
  },
  "included": [
    {
      "attributes": {
        "email": "john.doe@example.com",
        "handle": "john.doe@example.com",
        "name": "John Doe"
      },
      "id": "00000000-0000-0000-0000-000000000000",
      "type": "user"
    }
  ]
}

Bad Request

API error response.

Expand All

Champ

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Forbidden

API error response.

Expand All

Champ

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Not Found

API error response.

Expand All

Champ

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Too many requests

API error response.

Expand All

Champ

Type

Description

errors [required]

[string]

A list of errors.

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

Exemple de code

                  # Path parameters
export change_request_id="CHM-1234"
# Curl command
curl -X PATCH "https://api.ap1.datadoghq.com"https://api.ap2.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/change-management/change-request/${change_request_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": {
    "relationships": {
      "change_request_decisions": {
        "data": [
          {
            "id": "decision-id-0",
            "type": "change_request_decision"
          }
        ]
      }
    },
    "type": "change_request"
  },
  "included": [
    {
      "id": "decision-id-0",
      "relationships": {
        "requested_user": {
          "data": {
            "id": "00000000-0000-0000-0000-000000000000",
            "type": "user"
          }
        }
      },
      "type": "change_request_decision"
    }
  ]
}
EOF

Create a change request branch

Note: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.

POST https://api.ap1.datadoghq.com/api/v2/change-management/change-request/{change_request_id}/branchhttps://api.ap2.datadoghq.com/api/v2/change-management/change-request/{change_request_id}/branchhttps://api.datadoghq.eu/api/v2/change-management/change-request/{change_request_id}/branchhttps://api.ddog-gov.com/api/v2/change-management/change-request/{change_request_id}/branchhttps://api.datadoghq.com/api/v2/change-management/change-request/{change_request_id}/branchhttps://api.us3.datadoghq.com/api/v2/change-management/change-request/{change_request_id}/branchhttps://api.us5.datadoghq.com/api/v2/change-management/change-request/{change_request_id}/branch

Présentation

Create a new branch in a repository for a change request.

OAuth apps require the cases_write authorization scope to access this endpoint.

Arguments

Paramètres du chemin

Nom

Type

Description

change_request_id [required]

string

The identifier of the change request.

Requête

Body Data (required)

Branch creation payload.

Expand All

Champ

Type

Description

data [required]

object

Data object to create a change request branch.

attributes [required]

object

Attributes for creating a change request branch.

branch_name [required]

string

The name of the branch to create.

repo_id [required]

string

The repository identifier in the format owner/repository.

type [required]

enum

Change request branch resource type. Allowed enum values: change_request_branch

{
  "data": {
    "attributes": {
      "branch_name": "chm/CHM-1234",
      "repo_id": "DataDog/dd-source"
    },
    "type": "change_request_branch"
  }
}

Réponse

OK

Response object for a change request.

Expand All

Champ

Type

Description

data [required]

object

Data object for a change request response.

attributes [required]

object

Attributes of a change request response.

archived_at

date-time

Timestamp of when the change request was archived.

attributes [required]

object

Custom attributes of the change request as key-value pairs.

<any-key>

[string]

change_request_linked_incident_uuid [required]

string

The UUID of the linked incident.

change_request_maintenance_window_query [required]

string

The maintenance window query for the change request.

change_request_plan [required]

string

The plan associated with the change request.

change_request_risk [required]

enum

The risk level of the change request. Allowed enum values: UNDEFINED,LOW,MEDIUM,HIGH

change_request_type [required]

enum

The type of the change request. Allowed enum values: NORMAL,STANDARD,EMERGENCY

closed_at

date-time

Timestamp of when the change request was closed.

created_at [required]

date-time

Timestamp of when the change request was created.

creation_source [required]

string

The source from which the change request was created.

description [required]

string

The description of the change request.

end_date

date-time

The planned end date of the change request.

key [required]

string

The human-readable key of the change request.

modified_at [required]

date-time

Timestamp of when the change request was last modified.

plan_notebook_id [required]

int64

The notebook ID associated with the change request plan.

priority [required]

string

The priority of the change request.

project_id [required]

string

The project UUID associated with the change request.

start_date

date-time

The planned start date of the change request.

status [required]

string

The current status of the change request.

title [required]

string

The title of the change request.

type [required]

string

The case type.

id [required]

string

The identifier of the change request.

relationships

object

Relationships of a change request.

change_request_decisions [required]

object

Relationship to change request decisions.

data [required]

[object]

Array of decision relationship data.

id [required]

string

The decision UUID.

type [required]

enum

Change request decision resource type. Allowed enum values: change_request_decision

created_by [required]

object

Relationship to a user.

data [required]

object

User relationship data.

id [required]

string

The user UUID.

type [required]

string

The user resource type.

modified_by [required]

object

Relationship to a user.

data [required]

object

User relationship data.

id [required]

string

The user UUID.

type [required]

string

The user resource type.

type [required]

enum

Change request resource type. Allowed enum values: change_request

included

[ <oneOf>]

Included resources related to the change request.

Option 1

object

An included user resource.

attributes [required]

object

Attributes of an included user.

email [required]

string

The email of the user.

handle [required]

string

The handle of the user.

name [required]

string

The name of the user.

id [required]

string

The user UUID.

type [required]

string

The resource type.

Option 2

object

An included change request decision resource.

attributes [required]

object

Attributes of a change request decision in a response.

change_request_status [required]

enum

The status of a change request decision. Allowed enum values: REQUESTED,APPROVED,DECLINED

decided_at [required]

date-time

Timestamp of when the decision was made.

decision_reason [required]

string

The reason for the decision.

deleted_at [required]

date-time

Timestamp of when the decision was deleted.

request_reason [required]

string

The reason for requesting the decision.

requested_at [required]

date-time

Timestamp of when the decision was requested.

id [required]

string

The decision UUID.

relationships

object

Relationships of a change request decision.

modified_by [required]

object

Relationship to a user.

data [required]

object

User relationship data.

id [required]

string

The user UUID.

type [required]

string

The user resource type.

requested_by_user [required]

object

Relationship to a user.

data [required]

object

User relationship data.

id [required]

string

The user UUID.

type [required]

string

The user resource type.

requested_user [required]

object

Relationship to a user.

data [required]

object

User relationship data.

id [required]

string

The user UUID.

type [required]

string

The user resource type.

type [required]

enum

Change request decision resource type. Allowed enum values: change_request_decision

{
  "data": {
    "attributes": {
      "archived_at": "2019-09-19T10:00:00.000Z",
      "attributes": {
        "<any-key>": []
      },
      "change_request_linked_incident_uuid": "",
      "change_request_maintenance_window_query": "",
      "change_request_plan": "",
      "change_request_risk": "LOW",
      "change_request_type": "NORMAL",
      "closed_at": "2019-09-19T10:00:00.000Z",
      "created_at": "2024-01-01T00:00:00Z",
      "creation_source": "CS_MANUAL",
      "description": "Deploying new payment service v2.1",
      "end_date": "2024-01-02T15:00:00Z",
      "key": "CHM-1234",
      "modified_at": "2024-01-01T00:00:00Z",
      "plan_notebook_id": 0,
      "priority": "NOT_DEFINED",
      "project_id": "d4bbe1af-f36e-42f1-87c1-493ca35c320e",
      "start_date": "2024-01-01T03:00:00Z",
      "status": "OPEN",
      "title": "Deploy new payment service",
      "type": "CHANGE_REQUEST"
    },
    "id": "CHM-1234",
    "relationships": {
      "change_request_decisions": {
        "data": [
          {
            "id": "decision-id-0",
            "type": "change_request_decision"
          }
        ]
      },
      "created_by": {
        "data": {
          "id": "00000000-0000-0000-0000-000000000000",
          "type": "user"
        }
      },
      "modified_by": {
        "data": {
          "id": "00000000-0000-0000-0000-000000000000",
          "type": "user"
        }
      }
    },
    "type": "change_request"
  },
  "included": [
    {
      "attributes": {
        "email": "john.doe@example.com",
        "handle": "john.doe@example.com",
        "name": "John Doe"
      },
      "id": "00000000-0000-0000-0000-000000000000",
      "type": "user"
    }
  ]
}

Bad Request

API error response.

Expand All

Champ

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Not Found

API error response.

Expand All

Champ

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Too many requests

API error response.

Expand All

Champ

Type

Description

errors [required]

[string]

A list of errors.

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

Exemple de code

                  # Path parameters
export change_request_id="CHM-1234"
# Curl command
curl -X POST "https://api.ap1.datadoghq.com"https://api.ap2.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/change-management/change-request/${change_request_id}/branch" \
-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": {
      "branch_name": "chm/CHM-1234",
      "repo_id": "DataDog/dd-source"
    },
    "type": "change_request_branch"
  }
}
EOF

Update a change request decision

Note: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.

PATCH https://api.ap1.datadoghq.com/api/v2/change-management/change-request/{change_request_id}/decisions/{decision_id}https://api.ap2.datadoghq.com/api/v2/change-management/change-request/{change_request_id}/decisions/{decision_id}https://api.datadoghq.eu/api/v2/change-management/change-request/{change_request_id}/decisions/{decision_id}https://api.ddog-gov.com/api/v2/change-management/change-request/{change_request_id}/decisions/{decision_id}https://api.datadoghq.com/api/v2/change-management/change-request/{change_request_id}/decisions/{decision_id}https://api.us3.datadoghq.com/api/v2/change-management/change-request/{change_request_id}/decisions/{decision_id}https://api.us5.datadoghq.com/api/v2/change-management/change-request/{change_request_id}/decisions/{decision_id}

Présentation

Update a decision on a change request, such as approving or declining it.

OAuth apps require the cases_write authorization scope to access this endpoint.

Arguments

Paramètres du chemin

Nom

Type

Description

change_request_id [required]

string

The identifier of the change request.

decision_id [required]

string

The identifier of the change request decision.

Requête

Body Data (required)

Decision update payload.

Expand All

Champ

Type

Description

data [required]

object

Data object to update a change request decision.

attributes

object

Attributes of the parent change request for a decision update.

id

string

The identifier of the change request.

relationships

object

Relationships for updating a change request decision.

change_request_decisions [required]

object

Relationship to change request decisions.

data [required]

[object]

Array of decision relationship data.

id [required]

string

The decision UUID.

type [required]

enum

Change request decision resource type. Allowed enum values: change_request_decision

type [required]

enum

Change request resource type. Allowed enum values: change_request

included

[object]

Included resources for the change request update.

attributes

object

Attributes for creating a change request decision.

change_request_status

enum

The status of a change request decision. Allowed enum values: REQUESTED,APPROVED,DECLINED

request_reason

string

The reason for requesting the decision.

id [required]

string

The decision identifier.

relationships

object

Relationships for creating a change request decision.

requested_user

object

Relationship to a user.

data [required]

object

User relationship data.

id [required]

string

The user UUID.

type [required]

string

The user resource type.

type [required]

enum

Change request decision resource type. Allowed enum values: change_request_decision

{
  "data": {
    "attributes": {
      "id": "CHM-1234"
    },
    "relationships": {
      "change_request_decisions": {
        "data": [
          {
            "id": "decision-id-0",
            "type": "change_request_decision"
          }
        ]
      }
    },
    "type": "change_request"
  },
  "included": [
    {
      "attributes": {
        "change_request_status": "REQUESTED",
        "request_reason": "Please review and approve this change"
      },
      "id": "decision-id-0",
      "relationships": {
        "requested_user": {
          "data": {
            "id": "00000000-0000-0000-0000-000000000000",
            "type": "user"
          }
        }
      },
      "type": "change_request_decision"
    }
  ]
}

Réponse

OK

Response object for a change request.

Expand All

Champ

Type

Description

data [required]

object

Data object for a change request response.

attributes [required]

object

Attributes of a change request response.

archived_at

date-time

Timestamp of when the change request was archived.

attributes [required]

object

Custom attributes of the change request as key-value pairs.

<any-key>

[string]

change_request_linked_incident_uuid [required]

string

The UUID of the linked incident.

change_request_maintenance_window_query [required]

string

The maintenance window query for the change request.

change_request_plan [required]

string

The plan associated with the change request.

change_request_risk [required]

enum

The risk level of the change request. Allowed enum values: UNDEFINED,LOW,MEDIUM,HIGH

change_request_type [required]

enum

The type of the change request. Allowed enum values: NORMAL,STANDARD,EMERGENCY

closed_at

date-time

Timestamp of when the change request was closed.

created_at [required]

date-time

Timestamp of when the change request was created.

creation_source [required]

string

The source from which the change request was created.

description [required]

string

The description of the change request.

end_date

date-time

The planned end date of the change request.

key [required]

string

The human-readable key of the change request.

modified_at [required]

date-time

Timestamp of when the change request was last modified.

plan_notebook_id [required]

int64

The notebook ID associated with the change request plan.

priority [required]

string

The priority of the change request.

project_id [required]

string

The project UUID associated with the change request.

start_date

date-time

The planned start date of the change request.

status [required]

string

The current status of the change request.

title [required]

string

The title of the change request.

type [required]

string

The case type.

id [required]

string

The identifier of the change request.

relationships

object

Relationships of a change request.

change_request_decisions [required]

object

Relationship to change request decisions.

data [required]

[object]

Array of decision relationship data.

id [required]

string

The decision UUID.

type [required]

enum

Change request decision resource type. Allowed enum values: change_request_decision

created_by [required]

object

Relationship to a user.

data [required]

object

User relationship data.

id [required]

string

The user UUID.

type [required]

string

The user resource type.

modified_by [required]

object

Relationship to a user.

data [required]

object

User relationship data.

id [required]

string

The user UUID.

type [required]

string

The user resource type.

type [required]

enum

Change request resource type. Allowed enum values: change_request

included

[ <oneOf>]

Included resources related to the change request.

Option 1

object

An included user resource.

attributes [required]

object

Attributes of an included user.

email [required]

string

The email of the user.

handle [required]

string

The handle of the user.

name [required]

string

The name of the user.

id [required]

string

The user UUID.

type [required]

string

The resource type.

Option 2

object

An included change request decision resource.

attributes [required]

object

Attributes of a change request decision in a response.

change_request_status [required]

enum

The status of a change request decision. Allowed enum values: REQUESTED,APPROVED,DECLINED

decided_at [required]

date-time

Timestamp of when the decision was made.

decision_reason [required]

string

The reason for the decision.

deleted_at [required]

date-time

Timestamp of when the decision was deleted.

request_reason [required]

string

The reason for requesting the decision.

requested_at [required]

date-time

Timestamp of when the decision was requested.

id [required]

string

The decision UUID.

relationships

object

Relationships of a change request decision.

modified_by [required]

object

Relationship to a user.

data [required]

object

User relationship data.

id [required]

string

The user UUID.

type [required]

string

The user resource type.

requested_by_user [required]

object

Relationship to a user.

data [required]

object

User relationship data.

id [required]

string

The user UUID.

type [required]

string

The user resource type.

requested_user [required]

object

Relationship to a user.

data [required]

object

User relationship data.

id [required]

string

The user UUID.

type [required]

string

The user resource type.

type [required]

enum

Change request decision resource type. Allowed enum values: change_request_decision

{
  "data": {
    "attributes": {
      "archived_at": "2019-09-19T10:00:00.000Z",
      "attributes": {
        "<any-key>": []
      },
      "change_request_linked_incident_uuid": "",
      "change_request_maintenance_window_query": "",
      "change_request_plan": "",
      "change_request_risk": "LOW",
      "change_request_type": "NORMAL",
      "closed_at": "2019-09-19T10:00:00.000Z",
      "created_at": "2024-01-01T00:00:00Z",
      "creation_source": "CS_MANUAL",
      "description": "Deploying new payment service v2.1",
      "end_date": "2024-01-02T15:00:00Z",
      "key": "CHM-1234",
      "modified_at": "2024-01-01T00:00:00Z",
      "plan_notebook_id": 0,
      "priority": "NOT_DEFINED",
      "project_id": "d4bbe1af-f36e-42f1-87c1-493ca35c320e",
      "start_date": "2024-01-01T03:00:00Z",
      "status": "OPEN",
      "title": "Deploy new payment service",
      "type": "CHANGE_REQUEST"
    },
    "id": "CHM-1234",
    "relationships": {
      "change_request_decisions": {
        "data": [
          {
            "id": "decision-id-0",
            "type": "change_request_decision"
          }
        ]
      },
      "created_by": {
        "data": {
          "id": "00000000-0000-0000-0000-000000000000",
          "type": "user"
        }
      },
      "modified_by": {
        "data": {
          "id": "00000000-0000-0000-0000-000000000000",
          "type": "user"
        }
      }
    },
    "type": "change_request"
  },
  "included": [
    {
      "attributes": {
        "email": "john.doe@example.com",
        "handle": "john.doe@example.com",
        "name": "John Doe"
      },
      "id": "00000000-0000-0000-0000-000000000000",
      "type": "user"
    }
  ]
}

Bad Request

API error response.

Expand All

Champ

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Not Found

API error response.

Expand All

Champ

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Too many requests

API error response.

Expand All

Champ

Type

Description

errors [required]

[string]

A list of errors.

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

Exemple de code

                  # Path parameters
export change_request_id="CHM-1234"
export decision_id="decision-id-0"
# Curl command
curl -X PATCH "https://api.ap1.datadoghq.com"https://api.ap2.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/change-management/change-request/${change_request_id}/decisions/${decision_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": {
    "relationships": {
      "change_request_decisions": {
        "data": [
          {
            "id": "decision-id-0",
            "type": "change_request_decision"
          }
        ]
      }
    },
    "type": "change_request"
  },
  "included": [
    {
      "id": "decision-id-0",
      "relationships": {
        "requested_user": {
          "data": {
            "id": "00000000-0000-0000-0000-000000000000",
            "type": "user"
          }
        }
      },
      "type": "change_request_decision"
    }
  ]
}
EOF

Delete a change request decision

Note: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.

DELETE https://api.ap1.datadoghq.com/api/v2/change-management/change-request/{change_request_id}/decisions/{decision_id}https://api.ap2.datadoghq.com/api/v2/change-management/change-request/{change_request_id}/decisions/{decision_id}https://api.datadoghq.eu/api/v2/change-management/change-request/{change_request_id}/decisions/{decision_id}https://api.ddog-gov.com/api/v2/change-management/change-request/{change_request_id}/decisions/{decision_id}https://api.datadoghq.com/api/v2/change-management/change-request/{change_request_id}/decisions/{decision_id}https://api.us3.datadoghq.com/api/v2/change-management/change-request/{change_request_id}/decisions/{decision_id}https://api.us5.datadoghq.com/api/v2/change-management/change-request/{change_request_id}/decisions/{decision_id}

Présentation

Delete a decision from a change request.

OAuth apps require the cases_write authorization scope to access this endpoint.

Arguments

Paramètres du chemin

Nom

Type

Description

change_request_id [required]

string

The identifier of the change request.

decision_id [required]

string

The identifier of the change request decision.

Réponse

OK

Response object for a change request.

Expand All

Champ

Type

Description

data [required]

object

Data object for a change request response.

attributes [required]

object

Attributes of a change request response.

archived_at

date-time

Timestamp of when the change request was archived.

attributes [required]

object

Custom attributes of the change request as key-value pairs.

<any-key>

[string]

change_request_linked_incident_uuid [required]

string

The UUID of the linked incident.

change_request_maintenance_window_query [required]

string

The maintenance window query for the change request.

change_request_plan [required]

string

The plan associated with the change request.

change_request_risk [required]

enum

The risk level of the change request. Allowed enum values: UNDEFINED,LOW,MEDIUM,HIGH

change_request_type [required]

enum

The type of the change request. Allowed enum values: NORMAL,STANDARD,EMERGENCY

closed_at

date-time

Timestamp of when the change request was closed.

created_at [required]

date-time

Timestamp of when the change request was created.

creation_source [required]

string

The source from which the change request was created.

description [required]

string

The description of the change request.

end_date

date-time

The planned end date of the change request.

key [required]

string

The human-readable key of the change request.

modified_at [required]

date-time

Timestamp of when the change request was last modified.

plan_notebook_id [required]

int64

The notebook ID associated with the change request plan.

priority [required]

string

The priority of the change request.

project_id [required]

string

The project UUID associated with the change request.

start_date

date-time

The planned start date of the change request.

status [required]

string

The current status of the change request.

title [required]

string

The title of the change request.

type [required]

string

The case type.

id [required]

string

The identifier of the change request.

relationships

object

Relationships of a change request.

change_request_decisions [required]

object

Relationship to change request decisions.

data [required]

[object]

Array of decision relationship data.

id [required]

string

The decision UUID.

type [required]

enum

Change request decision resource type. Allowed enum values: change_request_decision

created_by [required]

object

Relationship to a user.

data [required]

object

User relationship data.

id [required]

string

The user UUID.

type [required]

string

The user resource type.

modified_by [required]

object

Relationship to a user.

data [required]

object

User relationship data.

id [required]

string

The user UUID.

type [required]

string

The user resource type.

type [required]

enum

Change request resource type. Allowed enum values: change_request

included

[ <oneOf>]

Included resources related to the change request.

Option 1

object

An included user resource.

attributes [required]

object

Attributes of an included user.

email [required]

string

The email of the user.

handle [required]

string

The handle of the user.

name [required]

string

The name of the user.

id [required]

string

The user UUID.

type [required]

string

The resource type.

Option 2

object

An included change request decision resource.

attributes [required]

object

Attributes of a change request decision in a response.

change_request_status [required]

enum

The status of a change request decision. Allowed enum values: REQUESTED,APPROVED,DECLINED

decided_at [required]

date-time

Timestamp of when the decision was made.

decision_reason [required]

string

The reason for the decision.

deleted_at [required]

date-time

Timestamp of when the decision was deleted.

request_reason [required]

string

The reason for requesting the decision.

requested_at [required]

date-time

Timestamp of when the decision was requested.

id [required]

string

The decision UUID.

relationships

object

Relationships of a change request decision.

modified_by [required]

object

Relationship to a user.

data [required]

object

User relationship data.

id [required]

string

The user UUID.

type [required]

string

The user resource type.

requested_by_user [required]

object

Relationship to a user.

data [required]

object

User relationship data.

id [required]

string

The user UUID.

type [required]

string

The user resource type.

requested_user [required]

object

Relationship to a user.

data [required]

object

User relationship data.

id [required]

string

The user UUID.

type [required]

string

The user resource type.

type [required]

enum

Change request decision resource type. Allowed enum values: change_request_decision

{
  "data": {
    "attributes": {
      "archived_at": "2019-09-19T10:00:00.000Z",
      "attributes": {
        "<any-key>": []
      },
      "change_request_linked_incident_uuid": "",
      "change_request_maintenance_window_query": "",
      "change_request_plan": "",
      "change_request_risk": "LOW",
      "change_request_type": "NORMAL",
      "closed_at": "2019-09-19T10:00:00.000Z",
      "created_at": "2024-01-01T00:00:00Z",
      "creation_source": "CS_MANUAL",
      "description": "Deploying new payment service v2.1",
      "end_date": "2024-01-02T15:00:00Z",
      "key": "CHM-1234",
      "modified_at": "2024-01-01T00:00:00Z",
      "plan_notebook_id": 0,
      "priority": "NOT_DEFINED",
      "project_id": "d4bbe1af-f36e-42f1-87c1-493ca35c320e",
      "start_date": "2024-01-01T03:00:00Z",
      "status": "OPEN",
      "title": "Deploy new payment service",
      "type": "CHANGE_REQUEST"
    },
    "id": "CHM-1234",
    "relationships": {
      "change_request_decisions": {
        "data": [
          {
            "id": "decision-id-0",
            "type": "change_request_decision"
          }
        ]
      },
      "created_by": {
        "data": {
          "id": "00000000-0000-0000-0000-000000000000",
          "type": "user"
        }
      },
      "modified_by": {
        "data": {
          "id": "00000000-0000-0000-0000-000000000000",
          "type": "user"
        }
      }
    },
    "type": "change_request"
  },
  "included": [
    {
      "attributes": {
        "email": "john.doe@example.com",
        "handle": "john.doe@example.com",
        "name": "John Doe"
      },
      "id": "00000000-0000-0000-0000-000000000000",
      "type": "user"
    }
  ]
}

Bad Request

API error response.

Expand All

Champ

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Not Found

API error response.

Expand All

Champ

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Too many requests

API error response.

Expand All

Champ

Type

Description

errors [required]

[string]

A list of errors.

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

Exemple de code

                  # Path parameters
export change_request_id="CHM-1234"
export decision_id="decision-id-0"
# Curl command
curl -X DELETE "https://api.ap1.datadoghq.com"https://api.ap2.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/change-management/change-request/${change_request_id}/decisions/${decision_id}" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"