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 Type 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: Type
paths:
/api/v2/incidents/config/types:
post:
description: Create an incident type.
operationId: CreateIncidentType
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/IncidentTypeCreateRequest'
description: Incident type payload.
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/IncidentTypeResponse'
description: CREATED
'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'
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ:
- incident_settings_write
summary: Datadog Create an Incident Type
tags:
- Type
x-codegen-request-body-name: body
x-given:
incident_type:
parameters:
- name: body
value: "{\n \"data\": {\n \"attributes\": {\n \"name\": \"Security Incident\",\n \"description\": \"Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.\",\n \"is_default\": false\n },\n \"type\": \"incident_types\"\n }\n}"
step: there is a valid "incident_type" in the system
x-menu-order: 19
x-permission:
operator: OR
permissions:
- incident_settings_write
x-undo:
operationId: DeleteIncidentType
parameters:
- name: incident_type_id
source: data.id
type: unsafe
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
/api/v2/incidents/config/types/{incident_type_id}:
delete:
description: Delete an incident type.
operationId: DeleteIncidentType
parameters:
- $ref: '#/components/parameters/IncidentTypeIDPathParameter'
responses:
'204':
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'
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ:
- incident_settings_write
summary: Datadog Delete an Incident Type
tags:
- Type
x-codegen-request-body-name: body
x-menu-order: 23
x-permission:
operator: OR
permissions:
- incident_settings_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
get:
description: Get incident type details.
operationId: GetIncidentType
parameters:
- $ref: '#/components/parameters/IncidentTypeIDPathParameter'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/IncidentTypeResponse'
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'
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ:
- incident_read
summary: Datadog Get Incident Type Details
tags:
- Type
x-menu-order: 21
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: Update an incident type.
operationId: UpdateIncidentType
parameters:
- $ref: '#/components/parameters/IncidentTypeIDPathParameter'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/IncidentTypePatchRequest'
description: Incident type payload.
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/IncidentTypeResponse'
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'
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ:
- incident_settings_write
summary: Datadog Update an Incident Type
tags:
- Type
x-codegen-request-body-name: body
x-menu-order: 22
x-permission:
operator: OR
permissions:
- incident_settings_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:
IncidentTypePatchData:
description: Incident type data for a patch request.
properties:
attributes:
$ref: '#/components/schemas/IncidentTypeUpdateAttributes'
id:
description: The incident type's ID.
example: 00000000-0000-0000-0000-000000000000
type: string
type:
$ref: '#/components/schemas/IncidentTypeType'
required:
- id
- type
- attributes
type: object
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
IncidentTypeType:
default: incident_types
description: Incident type resource type.
enum:
- incident_types
example: incident_types
type: string
x-enum-varnames:
- INCIDENT_TYPES
IncidentTypeAttributes:
description: Incident type's attributes.
properties:
createdAt:
description: Timestamp when the incident type was created.
format: date-time
readOnly: true
type: string
example: example_value
createdBy:
description: A unique identifier that represents the user that created the incident type.
example: 00000000-0000-0000-0000-000000000000
readOnly: true
type: string
description:
description: Text that describes the incident type.
example: Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.
type: string
is_default:
default: false
description: If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.
example: false
type: boolean
lastModifiedBy:
description: A unique identifier that represents the user that last modified the incident type.
example: 00000000-0000-0000-0000-000000000000
readOnly: true
type: string
modifiedAt:
description: Timestamp when the incident type was last modified.
format: date-time
readOnly: true
type: string
example: example_value
name:
description: The name of the incident type.
example: Security Incident
type: string
prefix:
description: The string that will be prepended to the incident title across the Datadog app.
example: IR
readOnly: true
type: string
required:
- name
type: object
IncidentTypeObject:
description: Incident type response data.
properties:
attributes:
$ref: '#/components/schemas/IncidentTypeAttributes'
id:
description: The incident type's ID.
example: 00000000-0000-0000-0000-000000000000
type: string
type:
$ref: '#/components/schemas/IncidentTypeType'
required:
- id
- type
type: object
IncidentTypeCreateData:
description: Incident type data for a create request.
properties:
attributes:
$ref: '#/components/schemas/IncidentTypeAttributes'
type:
$ref: '#/components/schemas/IncidentTypeType'
required:
- type
- attributes
type: object
IncidentTypeUpdateAttributes:
description: Incident type's attributes for updates.
properties:
createdAt:
description: Timestamp when the incident type was created.
format: date-time
readOnly: true
type: string
example: example_value
createdBy:
description: A unique identifier that represents the user that created the incident type.
example: 00000000-0000-0000-0000-000000000000
readOnly: true
type: string
description:
description: Text that describes the incident type.
example: 'Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data. Note: This will notify the security team.'
type: string
is_default:
description: When true, this incident type will be used as the default type when an incident type is not specified.
example: false
type: boolean
lastModifiedBy:
description: A unique identifier that represents the user that last modified the incident type.
example: 00000000-0000-0000-0000-000000000000
readOnly: true
type: string
modifiedAt:
description: Timestamp when the incident type was last modified.
format: date-time
readOnly: true
type: string
example: example_value
name:
description: The name of the incident type.
example: Security Incident
type: string
prefix:
description: The string that will be prepended to the incident title across the Datadog app.
example: IR
readOnly: true
type: string
type: object
IncidentTypeCreateRequest:
description: Create request for an incident type.
properties:
data:
$ref: '#/components/schemas/IncidentTypeCreateData'
required:
- data
type: object
IncidentTypeResponse:
description: Incident type response data.
properties:
data:
$ref: '#/components/schemas/IncidentTypeObject'
required:
- data
type: object
IncidentTypePatchRequest:
description: Patch request for an incident type.
properties:
data:
$ref: '#/components/schemas/IncidentTypePatchData'
required:
- data
type: object
responses:
TooManyRequestsResponse:
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
BadRequestResponse:
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
ForbiddenResponse:
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
NotFoundResponse:
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Not Found
UnauthorizedResponse:
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Unauthorized
parameters:
IncidentTypeIDPathParameter:
description: The UUID of the incident type.
in: path
name: incident_type_id
required: true
schema:
type: string
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