openapi: 3.0.0
info:
contact:
email: support@datadoghq.com
name: Datadog Support
url: https://www.datadoghq.com/support/
description: The Datadog API is an HTTP REST API. The API uses resource-oriented URLs to call the API, uses status codes to indicate the success or failure of requests, returns JSON from all requests, and uses standard HTTP response codes. Use the Datadog API to access the Datadog platform programmatically.
title: Datadog Account Attachments API
version: '1.0'
servers:
- url: https://{subdomain}.{site}
variables:
site:
default: datadoghq.com
description: The regional site for Datadog customers.
enum:
- datadoghq.com
- us3.datadoghq.com
- us5.datadoghq.com
- ap1.datadoghq.com
- datadoghq.eu
- ddog-gov.com
subdomain:
default: api
description: The subdomain where the API is deployed.
- url: '{protocol}://{name}'
variables:
name:
default: api.datadoghq.com
description: Full site DNS name.
protocol:
default: https
description: The protocol for accessing the API.
- url: https://{subdomain}.{site}
variables:
site:
default: datadoghq.com
description: Any Datadog deployment.
subdomain:
default: api
description: The subdomain where the API is deployed.
security:
- apiKeyAuth: []
appKeyAuth: []
tags:
- name: Attachments
paths:
/api/v2/incidents/{incident_id}/attachments:
get:
description: Get all attachments for a given incident.
operationId: ListIncidentAttachments
parameters:
- $ref: '#/components/parameters/IncidentIDPathParameter'
- $ref: '#/components/parameters/IncidentAttachmentIncludeQueryParameter'
- $ref: '#/components/parameters/IncidentAttachmentFilterQueryParameter'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/IncidentAttachmentsResponse'
description: OK
'400':
$ref: '#/components/responses/BadRequestResponse'
'401':
$ref: '#/components/responses/UnauthorizedResponse'
'403':
$ref: '#/components/responses/ForbiddenResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Datadog Get a List of Attachments
tags:
- Attachments
x-menu-order: 7
x-permission:
operator: OR
permissions:
- incident_read
x-undo:
type: safe
x-unstable: '**Note**: This endpoint is in public beta.
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
patch:
description: The bulk update endpoint for creating, updating, and deleting attachments for a given incident.
operationId: UpdateIncidentAttachments
parameters:
- $ref: '#/components/parameters/IncidentIDPathParameter'
- $ref: '#/components/parameters/IncidentAttachmentIncludeQueryParameter'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/IncidentAttachmentUpdateRequest'
description: Incident Attachment Payload.
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/IncidentAttachmentUpdateResponse'
description: OK
'400':
$ref: '#/components/responses/BadRequestResponse'
'401':
$ref: '#/components/responses/UnauthorizedResponse'
'403':
$ref: '#/components/responses/ForbiddenResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Datadog Create, Update, and Delete Incident Attachments
tags:
- Attachments
x-codegen-request-body-name: body
x-given:
incident_attachment:
parameters:
- name: incident_id
source: incident.data.id
- name: body
value: "{\n \"data\": [\n {\n \"attributes\": {\n \"attachment_type\": \"link\",\n \"attachment\": {\n \"documentUrl\": \"https://www.example.com/doc\",\n \"title\": \"Important Doc\"\n }\n },\n \"type\": \"incident_attachments\"\n }\n ]\n}"
step: the "incident" has an "incident_attachment"
x-menu-order: 8
x-permission:
operator: OR
permissions:
- incident_write
x-undo:
type: idempotent
x-unstable: '**Note**: This endpoint is in public beta.
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
components:
schemas:
RelationshipToUserData:
description: Relationship to user object.
properties:
id:
description: A unique identifier that represents the user.
example: 00000000-0000-0000-2345-000000000000
type: string
type:
$ref: '#/components/schemas/UsersType'
required:
- id
- type
type: object
x-merge-override:
required: false
UsersType:
default: users
description: Users resource type.
enum:
- users
example: users
type: string
x-enum-varnames:
- USERS
IncidentAttachmentLinkAttachmentType:
default: link
description: The type of link attachment attributes.
enum:
- link
example: link
type: string
x-enum-varnames:
- LINK
IncidentAttachmentAttributes:
description: The attributes object for an attachment.
oneOf:
- $ref: '#/components/schemas/IncidentAttachmentPostmortemAttributes'
- $ref: '#/components/schemas/IncidentAttachmentLinkAttributes'
IncidentAttachmentRelatedObject:
description: The object related to an incident attachment.
enum:
- users
type: string
x-enum-varnames:
- USERS
IncidentAttachmentLinkAttributes:
description: The attributes object for a link attachment.
properties:
attachment:
$ref: '#/components/schemas/IncidentAttachmentLinkAttributesAttachmentObject'
attachment_type:
$ref: '#/components/schemas/IncidentAttachmentLinkAttachmentType'
modified:
description: Timestamp when the incident attachment link was last modified.
format: date-time
readOnly: true
type: string
example: example_value
required:
- attachment_type
- attachment
type: object
RelationshipToRoles:
description: Relationship to roles.
properties:
data:
description: An array containing type and the unique identifier of a role.
items:
$ref: '#/components/schemas/RelationshipToRoleData'
type: array
type: object
x-merge-override:
required: false
IncidentAttachmentAttachmentType:
description: The type of the incident attachment attributes.
enum:
- link
- postmortem
example: link
type: string
x-enum-varnames:
- LINK
- POSTMORTEM
APIErrorResponse:
description: API error response.
properties:
errors:
description: A list of errors.
example:
- Bad Request
items:
description: A list of items.
example: Bad Request
type: string
type: array
required:
- errors
type: object
IncidentAttachmentUpdateData:
description: A single incident attachment.
properties:
attributes:
$ref: '#/components/schemas/IncidentAttachmentUpdateAttributes'
id:
description: A unique identifier that represents the incident attachment.
example: 00000000-abcd-0001-0000-000000000000
type: string
type:
$ref: '#/components/schemas/IncidentAttachmentType'
required:
- type
type: object
UserResponseRelationships:
description: Relationships of the user object returned by the API.
properties:
org:
$ref: '#/components/schemas/RelationshipToOrganization'
other_orgs:
$ref: '#/components/schemas/RelationshipToOrganizations'
other_users:
$ref: '#/components/schemas/RelationshipToUsers'
roles:
$ref: '#/components/schemas/RelationshipToRoles'
type: object
x-merge-override:
properties: false
RelationshipToOrganizations:
description: Relationship to organizations.
properties:
data:
description: Relationships to organization objects.
example: []
items:
$ref: '#/components/schemas/RelationshipToOrganizationData'
type: array
required:
- data
type: object
UserAttributes:
description: Attributes of user object returned by the API.
properties:
created_at:
description: Creation time of the user.
format: date-time
type: string
example: example_value
disabled:
description: Whether the user is disabled.
type: boolean
example: true
email:
description: Email of the user.
type: string
example: user@example.com
handle:
description: Handle of the user.
type: string
example: example_value
icon:
description: URL of the user's icon.
type: string
example: example_value
mfa_enabled:
description: If user has MFA enabled.
readOnly: true
type: boolean
example: true
modified_at:
description: Time that the user was last modified.
format: date-time
type: string
example: example_value
name:
description: Name of the user.
nullable: true
type: string
example: Example Monitor
service_account:
description: Whether the user is a service account.
type: boolean
example: true
status:
description: Status of the user.
type: string
example: OK
title:
description: Title of the user.
nullable: true
type: string
example: Example Monitor
verified:
description: Whether the user is verified.
type: boolean
example: true
type: object
IncidentAttachmentUpdateAttributes:
description: Incident attachment attributes.
oneOf:
- $ref: '#/components/schemas/IncidentAttachmentPostmortemAttributes'
- $ref: '#/components/schemas/IncidentAttachmentLinkAttributes'
IncidentAttachmentRelationships:
description: The incident attachment's relationships.
properties:
last_modified_by_user:
$ref: '#/components/schemas/RelationshipToUser'
type: object
IncidentAttachmentsPostmortemAttributesAttachmentObject:
description: The postmortem attachment.
properties:
documentUrl:
description: The URL of this notebook attachment.
example: https://app.datadoghq.com/notebook/123
type: string
title:
description: The title of this postmortem attachment.
example: Postmortem IR-123
type: string
required:
- documentUrl
- title
type: object
IncidentAttachmentType:
default: incident_attachments
description: The incident attachment resource type.
enum:
- incident_attachments
example: incident_attachments
type: string
x-enum-varnames:
- INCIDENT_ATTACHMENTS
IncidentAttachmentData:
description: A single incident attachment.
example:
attributes:
attachment:
documentUrl: ''
title: Postmortem IR-123
attachment_type: postmortem
id: 00000000-abcd-0002-0000-000000000000
relationships:
last_modified_by_user:
data:
id: 00000000-0000-0000-cccc-000000000000
type: users
type: incident_attachments
properties:
attributes:
$ref: '#/components/schemas/IncidentAttachmentAttributes'
id:
description: A unique identifier that represents the incident attachment.
example: 00000000-abcd-0001-0000-000000000000
type: string
relationships:
$ref: '#/components/schemas/IncidentAttachmentRelationships'
type:
$ref: '#/components/schemas/IncidentAttachmentType'
required:
- type
- attributes
- id
- relationships
type: object
IncidentAttachmentPostmortemAttachmentType:
default: postmortem
description: The type of postmortem attachment attributes.
enum:
- postmortem
example: postmortem
type: string
x-enum-varnames:
- POSTMORTEM
IncidentAttachmentsResponseIncludedItem:
description: An object related to an attachment that is included in the response.
oneOf:
- $ref: '#/components/schemas/User'
RelationshipToRoleData:
description: Relationship to role object.
properties:
id:
description: The unique identifier of the role.
example: 3653d3c6-0c75-11ea-ad28-fb5701eabc7d
type: string
type:
$ref: '#/components/schemas/RolesType'
type: object
x-merge-override:
required: false
IncidentAttachmentLinkAttributesAttachmentObject:
description: The link attachment.
properties:
documentUrl:
description: The URL of this link attachment.
example: https://www.example.com/webstore-failure-runbook
type: string
title:
description: The title of this link attachment.
example: Runbook for webstore service failures
type: string
required:
- documentUrl
- title
type: object
IncidentAttachmentsResponse:
description: The response object containing an incident's attachments.
properties:
data:
description: An array of incident attachments.
example:
- attributes:
attachment:
documentUrl: ''
title: Postmortem IR-123
attachment_type: postmortem
id: 00000000-abcd-0002-0000-000000000000
relationships:
last_modified_by_user:
data:
id: 00000000-0000-0000-cccc-000000000000
type: users
type: incident_attachments
items:
$ref: '#/components/schemas/IncidentAttachmentData'
type: array
included:
description: Included related resources that the user requested.
items:
$ref: '#/components/schemas/IncidentAttachmentsResponseIncludedItem'
type: array
required:
- data
type: object
User:
description: User object returned by the API.
properties:
attributes:
$ref: '#/components/schemas/UserAttributes'
id:
description: ID of the user.
type: string
example: abc-123-def
relationships:
$ref: '#/components/schemas/UserResponseRelationships'
type:
$ref: '#/components/schemas/UsersType'
type: object
x-merge-override:
required: false
RelationshipToOrganizationData:
description: Relationship to organization object.
properties:
id:
description: ID of the organization.
example: 00000000-0000-beef-0000-000000000000
type: string
type:
$ref: '#/components/schemas/OrganizationsType'
required:
- id
- type
type: object
IncidentAttachmentPostmortemAttributes:
description: The attributes object for a postmortem attachment.
properties:
attachment:
$ref: '#/components/schemas/IncidentAttachmentsPostmortemAttributesAttachmentObject'
attachment_type:
$ref: '#/components/schemas/IncidentAttachmentPostmortemAttachmentType'
required:
- attachment_type
- attachment
type: object
RelationshipToUser:
description: Relationship to user.
properties:
data:
$ref: '#/components/schemas/RelationshipToUserData'
required:
- data
type: object
RolesType:
default: roles
description: Roles type.
enum:
- roles
example: roles
type: string
x-enum-varnames:
- ROLES
OrganizationsType:
default: orgs
description: Organizations resource type.
enum:
- orgs
example: orgs
type: string
x-enum-varnames:
- ORGS
IncidentAttachmentUpdateRequest:
description: The update request for an incident's attachments.
properties:
data:
description: 'An array of incident attachments. An attachment object without an "id" key indicates that you want to
create that attachment. An attachment object without an "attributes" key indicates that you want to
delete that attachment. An attachment object with both the "id" key and a populated "attributes" object
indicates that you want to update that attachment.'
example:
- attributes:
attachment:
documentUrl: https://app.datadoghq.com/notebook/123
title: Postmortem IR-123
attachment_type: postmortem
id: 00000000-abcd-0002-0000-000000000000
type: incident_attachments
- attributes:
attachment:
documentUrl: https://www.example.com/webstore-failure-runbook
title: Runbook for webstore service failures
attachment_type: link
type: incident_attachments
- id: 00000000-abcd-0003-0000-000000000000
type: incident_attachments
items:
$ref: '#/components/schemas/IncidentAttachmentUpdateData'
type: array
required:
- data
type: object
IncidentAttachmentUpdateResponse:
description: The response object containing the created or updated incident attachments.
properties:
data:
description: 'An array of incident attachments. Only the attachments that were created or updated by the request are
returned.'
example:
- attributes:
attachment:
documentUrl: ''
title: Postmortem IR-123
attachment_type: postmortem
id: 00000000-abcd-0002-0000-000000000000
relationships:
last_modified_by_user:
data:
id: 00000000-0000-0000-cccc-000000000000
type: users
type: incident_attachments
items:
$ref: '#/components/schemas/IncidentAttachmentData'
type: array
included:
description: Included related resources that the user requested.
items:
$ref: '#/components/schemas/IncidentAttachmentsResponseIncludedItem'
type: array
required:
- data
type: object
RelationshipToUsers:
description: Relationship to users.
properties:
data:
description: Relationships to user objects.
example: []
items:
$ref: '#/components/schemas/RelationshipToUserData'
type: array
required:
- data
type: object
RelationshipToOrganization:
description: Relationship to an organization.
properties:
data:
$ref: '#/components/schemas/RelationshipToOrganizationData'
required:
- data
type: object
parameters:
IncidentAttachmentFilterQueryParameter:
description: Specifies which types of attachments are included in the response.
explode: false
in: query
name: filter[attachment_type]
required: false
schema:
items:
$ref: '#/components/schemas/IncidentAttachmentAttachmentType'
type: array
IncidentIDPathParameter:
description: The UUID of the incident.
in: path
name: incident_id
required: true
schema:
type: string
IncidentAttachmentIncludeQueryParameter:
description: Specifies which types of related objects are included in the response.
explode: false
in: query
name: include
required: false
schema:
items:
$ref: '#/components/schemas/IncidentAttachmentRelatedObject'
type: array
responses:
TooManyRequestsResponse:
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
NotFoundResponse:
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Not Found
UnauthorizedResponse:
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Unauthorized
BadRequestResponse:
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
ForbiddenResponse:
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
securitySchemes:
AuthZ:
description: This API uses OAuth 2 with the implicit grant flow.
flows:
authorizationCode:
authorizationUrl: /oauth2/v1/authorize
scopes:
apm_api_catalog_read: View API catalog and API definitions.
apm_api_catalog_write: Add, modify, and delete API catalog definitions.
apm_read: Read and query APM and Trace Analytics.
apm_service_catalog_read: View service catalog and service definitions.
apm_service_catalog_write: Add, modify, and delete service catalog definitions when those definitions are maintained by Datadog.
appsec_vm_read: View infrastructure, application code, and library vulnerabilities. This does not restrict API or inventory SQL access to the vulnerability data source.
cases_read: View Cases.
cases_write: Create and update cases.
ci_visibility_pipelines_write: Create CI Visibility pipeline spans using the API.
ci_visibility_read: View CI Visibility.
cloud_cost_management_read: View Cloud Cost pages and the cloud cost data source in dashboards and notebooks. For more details, see the Cloud Cost Management docs.
cloud_cost_management_write: Configure cloud cost accounts and global customizations. For more details, see the Cloud Cost Management docs.
code_analysis_read: View Code Analysis.
continuous_profiler_pgo_read: Read and query Continuous Profiler data for Profile-Guided Optimization (PGO).
create_webhooks: Create webhooks integrations.
dashboards_embed_share: Create, modify, and delete shared dashboards with share type 'embed'.
dashboards_invite_share: Create, modify, and delete shared dashboards with share type 'invite'.
dashboards_public_share: Generate public and authenticated links to share dashboards or embeddable graphs externally.
dashboards_read: View dashboards.
dashboards_write: Create and change dashboards.
data_scanner_read: View Data Scanner configurations.
data_scanner_write: Edit Data Scanner configurations.
embeddable_graphs_share: Generate public links to share embeddable graphs externally.
events_read: Read Events data.
hosts_read: List hosts and their attributes.
incident_notification_settings_write: Configure Incidents Notification settings.
incident_read: View incidents in Datadog.
incident_settings_write: Configure Incident Settings.
incident_write: Create, view, and manage incidents in Datadog.
metrics_read: View custom metrics.
monitor_config_policy_write: Edit and delete monitor configuration.
monitors_downtime: Set downtimes to suppress alerts from any monitor in an organization. Mute and unmute monitors. The ability to write monitors is not required to set downtimes.
monitors_read: View monitors.
monitors_write: Edit, delete, and resolve individual monitors.
org_management: Edit org configurations, including authentication and certain security preferences such as configuring SAML, renaming an org, configuring allowed login methods, creating child orgs, subscribing & unsubscribing from apps in the marketplace, and enabling & disabling Remote Configuration for the entire organization.
security_comments_read: Read comments of vulnerabilities.
security_monitoring_filters_read: Read Security Filters.
security_monitoring_filters_write: Create, edit, and delete Security Filters.
security_monitoring_findings_read: View a list of findings that include both misconfigurations and identity risks.
security_monitoring_notification_profiles_read: View Rule Security Notification rules.
security_monitoring_notification_profiles_write: Create, edit, and delete Security Notification rules.
security_monitoring_rules_read: Read Detection Rules.
security_monitoring_rules_write: Create and edit Detection Rules.
security_monitoring_signals_read: View Security Signals.
security_monitoring_suppressions_read: Read Rule Suppressions.
security_monitoring_suppressions_write: Write Rule Suppressions.
security_pipelines_read: View Security Pipelines.
security_pipelines_write: Create, edit, and delete CSM Security Pipelines.
slos_corrections: Apply, edit, and delete SLO status corrections. A user with this permission can make status corrections, even if they do not have permission to edit those SLOs.
slos_read: View SLOs and status corrections.
slos_write: Create, edit, and delete SLOs.
synthetics_global_variable_read: View, search, and use Synthetics global variables.
synthetics_global_variable_write: Create, edit, and delete global variables for Synthetics.
synthetics_private_location_read: View, search, and use Synthetics private locations.
synthetics_private_location_write: Create and delete private locations in addition to having access to the associated installation guidelines.
synthetics_read: List and view configured Synthetic tests and test results.
synthetics_write: Create, edit, and delete Synthetic tests.
teams_manage: Manage Teams. Create, delete, rename, and edit metadata of all Teams. To control Team membership across all Teams, use the User Access Manage permission.
teams_read: Read Teams data. A User with this permission can view Team names, metadata, and which Users are on each Team.
test_optimization_read: View Test Optimization.
timeseries_query: Query Timeseries data.
usage_read: View your organization's usage and usage attribution.
user_access_invite: Invite other users to your organization.
user_access_manage: Disable users, manage user roles, manage SAML-to-role mappings, and configure logs restriction queries.
user_access_read: View users and their roles and settings.
workflows_read: View workflows.
workflows_run: Run workflows.
workflows_write: Create, edit, and delete workflows.
tokenUrl: /oauth2/v1/token
type: oauth2
apiKeyAuth:
description: Your Datadog API Key.
in: header
name: DD-API-KEY
type: apiKey
x-env-name: DD_API_KEY
appKeyAuth:
description: Your Datadog APP Key.
in: header
name: DD-APPLICATION-KEY
type: apiKey
x-env-name: DD_APP_KEY
bearerAuth:
scheme: bearer
type: http
x-env-name: DD_BEARER_TOKEN
x-group-parameters: true
x-merge-override:
paths: false