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 Case 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: Case
paths:
/api/v2/cases:
post:
description: Create a Case
operationId: CreateCase
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CaseCreateRequest'
description: Case payload
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/CaseResponse'
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:
- cases_write
summary: Datadog Create a Case
tags:
- Case
x-given:
case:
parameters:
- name: body
value: "{\n \"data\": {\n \"attributes\": {\n \"title\": \"My new case\",\n \"type\": \"STANDARD\",\n \"priority\": \"P4\"\n },\n \"relationships\": {\n \"project\": {\n \"data\": {\n \"id\": \"d4bbe1af-f36e-42f1-87c1-493ca35c320e\",\n \"type\": \"project\"\n }\n }\n },\n \"type\": \"case\"\n }\n}"
source: data
step: there is a valid "case" in the system
x-menu-order: 2
x-undo:
type: safe
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/cases/{case_id}:
get:
description: Get the details of case by `case_id`
operationId: GetCase
parameters:
- $ref: '#/components/parameters/CaseIDPathParameter'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CaseResponse'
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:
- cases_read
summary: Datadog Get the Details of a Case
tags:
- Case
x-menu-order: 3
x-undo:
type: safe
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/cases/{case_id}/archive:
post:
description: Archive case
operationId: ArchiveCase
parameters:
- $ref: '#/components/parameters/CaseIDPathParameter'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CaseEmptyRequest'
description: Archive case payload
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CaseResponse'
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:
- cases_write
summary: Datadog Archive Case
tags:
- Case
x-menu-order: 8
x-undo:
type: idempotent
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/cases/{case_id}/assign:
post:
description: Assign case to a user
operationId: AssignCase
parameters:
- $ref: '#/components/parameters/CaseIDPathParameter'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CaseAssignRequest'
description: Assign case payload
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CaseResponse'
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:
- cases_write
summary: Datadog Assign Case
tags:
- Case
x-menu-order: 6
x-undo:
type: idempotent
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/cases/{case_id}/priority:
post:
description: Update case priority
operationId: UpdatePriority
parameters:
- $ref: '#/components/parameters/CaseIDPathParameter'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CaseUpdatePriorityRequest'
description: Case priority update payload
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CaseResponse'
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:
- cases_write
summary: Datadog Update Case Priority
tags:
- Case
x-menu-order: 5
x-undo:
type: idempotent
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/cases/{case_id}/status:
post:
description: Update case status
operationId: UpdateStatus
parameters:
- $ref: '#/components/parameters/CaseIDPathParameter'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CaseUpdateStatusRequest'
description: Case status update payload
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CaseResponse'
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:
- cases_write
summary: Datadog Update Case Status
tags:
- Case
x-menu-order: 4
x-undo:
type: idempotent
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/cases/{case_id}/unarchive:
post:
description: Unarchive case
operationId: UnarchiveCase
parameters:
- $ref: '#/components/parameters/CaseIDPathParameter'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CaseEmptyRequest'
description: Unarchive case payload
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CaseResponse'
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:
- cases_write
summary: Datadog Unarchive Case
tags:
- Case
x-menu-order: 9
x-undo:
type: idempotent
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/cases/{case_id}/unassign:
post:
description: Unassign case
operationId: UnassignCase
parameters:
- $ref: '#/components/parameters/CaseIDPathParameter'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CaseEmptyRequest'
description: Unassign case payload
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CaseResponse'
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:
- cases_write
summary: Datadog Unassign Case
tags:
- Case
x-menu-order: 7
x-undo:
type: idempotent
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
components:
schemas:
JiraIssueResult:
description: Jira issue information
properties:
issue_id:
description: Jira issue ID
type: string
example: abc-123-def
issue_key:
description: Jira issue key
type: string
example: example_value
issue_url:
description: Jira issue URL
type: string
example: https://app.datadoghq.com
project_key:
description: Jira project key
type: string
example: example_value
type: object
CaseUpdateStatusAttributes:
description: Case update status attributes
properties:
status:
$ref: '#/components/schemas/CaseStatus'
required:
- status
type: object
ProjectResourceType:
default: project
description: Project resource type
enum:
- project
example: project
type: string
x-enum-varnames:
- PROJECT
CaseCreateRelationships:
description: Relationships formed with the case on creation
properties:
assignee:
$ref: '#/components/schemas/NullableUserRelationship'
project:
$ref: '#/components/schemas/ProjectRelationship'
required:
- project
type: object
CaseCreateAttributes:
description: Case creation attributes
properties:
description:
description: Description
type: string
example: example_value
priority:
$ref: '#/components/schemas/CasePriority'
title:
description: Title
example: Security breach investigation
type: string
type:
$ref: '#/components/schemas/CaseType'
required:
- title
- type
type: object
CaseStatus:
description: Case status
enum:
- OPEN
- IN_PROGRESS
- CLOSED
example: OPEN
type: string
x-enum-varnames:
- OPEN
- IN_PROGRESS
- CLOSED
CaseUpdatePriorityAttributes:
description: Case update priority attributes
properties:
priority:
$ref: '#/components/schemas/CasePriority'
required:
- priority
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
CasePriority:
default: NOT_DEFINED
description: Case priority
enum:
- NOT_DEFINED
- P1
- P2
- P3
- P4
- P5
example: NOT_DEFINED
type: string
x-enum-varnames:
- NOT_DEFINED
- P1
- P2
- P3
- P4
- P5
CaseEmpty:
description: Case empty request data
properties:
type:
$ref: '#/components/schemas/CaseResourceType'
required:
- type
type: object
CaseCreate:
description: Case creation data
properties:
attributes:
$ref: '#/components/schemas/CaseCreateAttributes'
relationships:
$ref: '#/components/schemas/CaseCreateRelationships'
type:
$ref: '#/components/schemas/CaseResourceType'
required:
- attributes
- type
type: object
CaseEmptyRequest:
description: Case empty request
properties:
data:
$ref: '#/components/schemas/CaseEmpty'
required:
- data
type: object
UserResourceType:
default: user
description: User resource type.
enum:
- user
example: user
type: string
x-enum-varnames:
- USER
CaseResponse:
description: Case response
properties:
data:
$ref: '#/components/schemas/Case'
type: object
CaseRelationships:
description: Resources related to a case
properties:
assignee:
$ref: '#/components/schemas/NullableUserRelationship'
created_by:
$ref: '#/components/schemas/NullableUserRelationship'
modified_by:
$ref: '#/components/schemas/NullableUserRelationship'
project:
$ref: '#/components/schemas/ProjectRelationship'
type: object
NullableUserRelationship:
description: Relationship to user.
nullable: true
properties:
data:
$ref: '#/components/schemas/NullableUserRelationshipData'
required:
- data
type: object
ProjectRelationship:
description: Relationship to project
properties:
data:
$ref: '#/components/schemas/ProjectRelationshipData'
required:
- data
type: object
CaseType:
description: Case type
enum:
- STANDARD
example: STANDARD
type: string
x-enum-varnames:
- STANDARD
CaseAttributes:
description: Case attributes
properties:
archived_at:
description: Timestamp of when the case was archived
format: date-time
nullable: true
readOnly: true
type: string
example: example_value
closed_at:
description: Timestamp of when the case was closed
format: date-time
nullable: true
readOnly: true
type: string
example: example_value
created_at:
description: Timestamp of when the case was created
format: date-time
readOnly: true
type: string
example: example_value
description:
description: Description
type: string
example: example_value
jira_issue:
$ref: '#/components/schemas/JiraIssue'
key:
description: Key
example: CASEM-4523
type: string
modified_at:
description: Timestamp of when the case was last modified
format: date-time
nullable: true
readOnly: true
type: string
example: example_value
priority:
$ref: '#/components/schemas/CasePriority'
service_now_ticket:
$ref: '#/components/schemas/ServiceNowTicket'
status:
$ref: '#/components/schemas/CaseStatus'
title:
description: Title
example: Memory leak investigation on API
type: string
type:
$ref: '#/components/schemas/CaseType'
type: object
CaseUpdateStatusRequest:
description: Case update status request
properties:
data:
$ref: '#/components/schemas/CaseUpdateStatus'
required:
- data
type: object
NullableUserRelationshipData:
description: Relationship to user object.
nullable: true
properties:
id:
description: A unique identifier that represents the user.
example: 00000000-0000-0000-0000-000000000000
type: string
type:
$ref: '#/components/schemas/UserResourceType'
required:
- id
- type
type: object
CaseCreateRequest:
description: Case create request
properties:
data:
$ref: '#/components/schemas/CaseCreate'
required:
- data
type: object
CaseUpdatePriorityRequest:
description: Case update priority request
properties:
data:
$ref: '#/components/schemas/CaseUpdatePriority'
required:
- data
type: object
JiraIssue:
description: Jira issue attached to case
nullable: true
properties:
result:
$ref: '#/components/schemas/JiraIssueResult'
status:
$ref: '#/components/schemas/Case3rdPartyTicketStatus'
readOnly: true
type: object
Case3rdPartyTicketStatus:
default: IN_PROGRESS
description: Case status
enum:
- IN_PROGRESS
- COMPLETED
- FAILED
example: COMPLETED
readOnly: true
type: string
x-enum-varnames:
- IN_PROGRESS
- COMPLETED
- FAILED
CaseResourceType:
default: case
description: Case resource type
enum:
- case
example: case
type: string
x-enum-varnames:
- CASE
ProjectRelationshipData:
description: Relationship to project object
properties:
id:
description: A unique identifier that represents the project
example: e555e290-ed65-49bd-ae18-8acbfcf18db7
type: string
type:
$ref: '#/components/schemas/ProjectResourceType'
required:
- id
- type
type: object
CaseUpdateStatus:
description: Case update status
properties:
attributes:
$ref: '#/components/schemas/CaseUpdateStatusAttributes'
type:
$ref: '#/components/schemas/CaseResourceType'
required:
- attributes
- type
type: object
Case:
description: A case
properties:
attributes:
$ref: '#/components/schemas/CaseAttributes'
id:
description: Case's identifier
example: aeadc05e-98a8-11ec-ac2c-da7ad0900001
type: string
relationships:
$ref: '#/components/schemas/CaseRelationships'
type:
$ref: '#/components/schemas/CaseResourceType'
required:
- id
- type
- attributes
type: object
CaseAssignRequest:
description: Case assign request
properties:
data:
$ref: '#/components/schemas/CaseAssign'
required:
- data
type: object
CaseAssignAttributes:
description: Case assign attributes
properties:
assignee_id:
description: Assignee's UUID
example: f98a5a5b-e0ff-45d4-b2f5-afe6e74de504
type: string
required:
- assignee_id
type: object
ServiceNowTicket:
description: ServiceNow ticket attached to case
nullable: true
properties:
result:
$ref: '#/components/schemas/ServiceNowTicketResult'
status:
$ref: '#/components/schemas/Case3rdPartyTicketStatus'
readOnly: true
type: object
ServiceNowTicketResult:
description: ServiceNow ticket information
properties:
sys_target_link:
description: Link to the Incident created on ServiceNow
type: string
example: example_value
type: object
CaseAssign:
description: Case assign
properties:
attributes:
$ref: '#/components/schemas/CaseAssignAttributes'
type:
$ref: '#/components/schemas/CaseResourceType'
required:
- attributes
- type
type: object
CaseUpdatePriority:
description: Case priority status
properties:
attributes:
$ref: '#/components/schemas/CaseUpdatePriorityAttributes'
type:
$ref: '#/components/schemas/CaseResourceType'
required:
- attributes
- type
type: object
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
parameters:
CaseIDPathParameter:
description: Case's UUID or key
example: f98a5a5b-e0ff-45d4-b2f5-afe6e74de504
in: path
name: case_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