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 Incident Teams 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: Incident Teams
description: Manage teams associated with incidents
paths:
/api/v2/teams:
post:
operationId: createIncidentTeam
summary: Datadog Create a New Incident Team
description: Creates a new incident team that can be associated with incidents for organizing responders. Teams help route incidents to the appropriate on-call groups and provide a way to track ownership and responsibility during incident response. Teams can be referenced when creating or updating incidents.
tags:
- Incident Teams
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/IncidentTeamCreateRequest'
responses:
'201':
description: Incident team created successfully
content:
application/json:
schema:
$ref: '#/components/schemas/IncidentTeamResponse'
'400':
description: Bad request - invalid team configuration
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
'401':
description: Unauthorized - missing or invalid credentials
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
'403':
description: Forbidden - insufficient permissions to create incident teams
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
get:
operationId: listIncidentTeams
summary: Datadog Get a List of Incident Teams
description: Returns a paginated list of all incident teams configured in your Datadog organization. Teams can be filtered by name. Incident teams are used to organize responders and route incidents to appropriate groups. Returns team names and IDs for use when associating teams with incidents.
tags:
- Incident Teams
parameters:
- name: filter[query]
in: query
required: false
description: Filter teams by name using a substring search
schema:
type: string
example: avg:system.cpu.user{*}
- name: page[size]
in: query
required: false
description: The number of teams to return per page
schema:
type: integer
minimum: 1
maximum: 100
default: 10
example: 42
- name: page[offset]
in: query
required: false
description: The number of records to skip for pagination
schema:
type: integer
minimum: 0
default: 0
example: 42
responses:
'200':
description: Successful response with list of incident teams
content:
application/json:
schema:
$ref: '#/components/schemas/IncidentTeamsResponse'
'400':
description: Bad request - invalid filter or pagination parameters
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
'401':
description: Unauthorized - missing or invalid credentials
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
'403':
description: Forbidden - insufficient permissions to list incident teams
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/teams/{team_id}:
get:
operationId: getIncidentTeam
summary: Datadog Get Details of an Incident Team
description: Returns the full details of a specific incident team identified by its unique ID, including the team name, creation time, and optional included resources such as team members.
tags:
- Incident Teams
parameters:
- $ref: '#/components/parameters/teamIdParam'
responses:
'200':
description: Successful response with incident team details
content:
application/json:
schema:
$ref: '#/components/schemas/IncidentTeamResponse'
'401':
description: Unauthorized - missing or invalid credentials
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
'403':
description: Forbidden - insufficient permissions to view this team
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
'404':
description: Not found - team with the specified ID does not exist
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
patch:
operationId: updateIncidentTeam
summary: Datadog Update an Existing Incident Team
description: Updates the name or configuration of an existing incident team. Team membership is managed separately through user management endpoints. Changes take effect immediately for all future incident associations.
tags:
- Incident Teams
parameters:
- $ref: '#/components/parameters/teamIdParam'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/IncidentTeamUpdateRequest'
responses:
'200':
description: Incident team updated successfully
content:
application/json:
schema:
$ref: '#/components/schemas/IncidentTeamResponse'
'400':
description: Bad request - invalid team update payload
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
'401':
description: Unauthorized - missing or invalid credentials
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
'403':
description: Forbidden - insufficient permissions to update this team
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
'404':
description: Not found - team with the specified ID does not exist
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
delete:
operationId: deleteIncidentTeam
summary: Datadog Delete an Existing Incident Team
description: Permanently deletes an incident team. The team is disassociated from any incidents that reference it. This action cannot be undone. Incidents that referenced the deleted team will no longer show the team association.
tags:
- Incident Teams
parameters:
- $ref: '#/components/parameters/teamIdParam'
responses:
'204':
description: No content - incident team deleted successfully
'401':
description: Unauthorized - missing or invalid credentials
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
'403':
description: Forbidden - insufficient permissions to delete this team
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
'404':
description: Not found - team with the specified ID does not exist
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
components:
schemas:
APIErrorResponse:
type: object
description: Standard API error response returned for failed requests
required:
- errors
properties:
errors:
type: array
description: List of error messages describing the failure
items:
type: string
IncidentTeamResponse:
type: object
description: Response wrapper for a single incident team
properties:
data:
$ref: '#/components/schemas/IncidentTeam'
IncidentTeamUpdateRequest:
type: object
description: Request body for updating an existing incident team
required:
- data
properties:
data:
type: object
description: The incident team update data
required:
- type
- id
- attributes
properties:
type:
type: string
description: The resource type identifier for incident teams
enum:
- teams
id:
type: string
description: The unique ID of the incident team to update
attributes:
type: object
description: The updated incident team attributes
required:
- name
properties:
name:
type: string
description: The updated name for the incident team
IncidentTeam:
type: object
description: A team associated with incident response
properties:
id:
type: string
description: The unique string identifier of the incident team
example: abc-123-def
type:
type: string
description: The resource type identifier (always 'teams')
example: metric alert
attributes:
type: object
description: The incident team attributes
properties:
name:
type: string
description: The display name of the incident team
created:
type: string
format: date-time
description: ISO 8601 timestamp when the team was created
modified:
type: string
format: date-time
description: ISO 8601 timestamp when the team was last modified
IncidentTeamCreateRequest:
type: object
description: Request body for creating a new incident team
required:
- data
properties:
data:
type: object
description: The incident team creation data
required:
- type
- attributes
properties:
type:
type: string
description: The resource type identifier for incident teams
enum:
- teams
attributes:
type: object
description: The incident team attributes
required:
- name
properties:
name:
type: string
description: The name of the incident team for display and identification
IncidentTeamsResponse:
type: object
description: Response containing a list of incident teams
properties:
data:
type: array
description: List of incident team objects
items:
$ref: '#/components/schemas/IncidentTeam'
parameters:
teamIdParam:
name: team_id
in: path
required: true
description: The unique string identifier of the incident team
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