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 Entity 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: Entity
paths:
/api/v2/catalog/entity/{entity_id}:
delete:
description: Delete a single entity in Software Catalog.
operationId: DeleteCatalogEntity
parameters:
- $ref: '#/components/parameters/EntityID'
responses:
'204':
description: OK
'400':
$ref: '#/components/responses/BadRequestResponse'
'403':
$ref: '#/components/responses/ForbiddenResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ:
- apm_service_catalog_write
summary: Datadog Delete a Single Entity
tags:
- Entity
x-menu-order: 3
x-undo:
type: idempotent
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/catalog/relation:
get:
description: Get a list of entity relations from Software Catalog.
operationId: ListCatalogRelation
parameters:
- $ref: '#/components/parameters/PageOffset'
- description: Maximum number of relations in the response.
example: 100
in: query
name: page[limit]
required: false
schema:
default: 100
format: int64
type: integer
- $ref: '#/components/parameters/FilterRelationByType'
- $ref: '#/components/parameters/FilterRelationByFromRef'
- $ref: '#/components/parameters/FilterRelationByToRef'
- $ref: '#/components/parameters/RelationInclude'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ListRelationCatalogResponse'
description: OK
'403':
$ref: '#/components/responses/ForbiddenResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ:
- apm_service_catalog_read
summary: Datadog Get a List of Entity Relations
tags:
- Entity
x-menu-order: 3
x-pagination:
limitParam: page[limit]
pageOffsetParam: page[offset]
resultsPath: data
x-undo:
type: safe
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
components:
schemas:
RelationMeta:
description: Relation metadata.
properties:
createdAt:
description: Relation creation time.
format: date-time
type: string
example: example_value
definedBy:
description: Relation defined by.
type: string
example: example_value
modifiedAt:
description: Relation modification time.
format: date-time
type: string
example: example_value
source:
description: Relation source.
type: string
example: example_value
type: object
EntityAttributes:
description: Entity attributes.
properties:
apiVersion:
description: The API version.
type: string
example: example_value
description:
description: The description.
type: string
example: example_value
displayName:
description: The display name.
type: string
example: Example Monitor
kind:
description: The kind.
type: string
example: example_value
name:
description: The name.
type: string
example: Example Monitor
namespace:
description: The namespace.
type: string
example: Example Monitor
owner:
description: The owner.
type: string
example: example_value
tags:
description: The tags.
items:
type: string
type: array
type: object
RelationResponseMeta:
description: Relation response metadata.
properties:
count:
description: Total relations count.
format: int64
type: integer
example: 42
includeCount:
description: Total included data count.
format: int64
type: integer
example: 42
type: object
EntityRelationships:
description: Entity relationships.
properties:
incidents:
$ref: '#/components/schemas/EntityToIncidents'
oncall:
$ref: '#/components/schemas/EntityToOncalls'
rawSchema:
$ref: '#/components/schemas/EntityToRawSchema'
relatedEntities:
$ref: '#/components/schemas/EntityToRelatedEntities'
schema:
$ref: '#/components/schemas/EntityToSchema'
type: object
EntityToSchema:
description: Entity to detail schema relationship.
properties:
data:
$ref: '#/components/schemas/RelationshipItem'
type: object
ListRelationCatalogResponseIncluded:
description: List relation response included entities.
items:
$ref: '#/components/schemas/EntityData'
type: array
EntityToRawSchema:
description: Entity to raw schema relationship.
properties:
data:
$ref: '#/components/schemas/RelationshipItem'
type: object
RelationshipItem:
description: Relationship entry.
properties:
id:
description: Associated data ID.
type: string
example: abc-123-def
type:
description: Relationship type.
type: string
example: metric alert
type: object
RelationEntity:
description: Relation entity reference.
properties:
kind:
description: Entity kind.
type: string
example: example_value
name:
description: Entity name.
type: string
example: Example Monitor
namespace:
description: Entity namespace.
type: string
example: Example Monitor
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
RelationResponseType:
description: Relation type.
enum:
- relation
type: string
x-enum-varnames:
- RELATION
ListRelationCatalogResponseLinks:
description: List relation response links.
properties:
next:
description: Next link.
example: /api/v2/catalog/relation?filter[from_ref]=service:service-catalog&include=entity&page[limit]=2&page[offset]=2
type: string
previous:
description: Previous link.
type: string
example: example_value
self:
description: Current link.
example: /api/v2/catalog/relation?filter[from_ref]=service:service-catalog&include=entity&page[limit]=2&page[offset]=0
type: string
type: object
EntityMeta:
description: Entity metadata.
properties:
createdAt:
description: The creation time.
type: string
example: example_value
ingestionSource:
description: The ingestion source.
type: string
example: example_value
modifiedAt:
description: The modification time.
type: string
example: example_value
origin:
description: The origin.
type: string
example: example_value
type: object
RelationToEntity:
description: Relation to entity.
properties:
data:
$ref: '#/components/schemas/RelationshipItem'
meta:
$ref: '#/components/schemas/EntityMeta'
type: object
RelationResponse:
description: Relation response data.
properties:
attributes:
$ref: '#/components/schemas/RelationAttributes'
id:
description: Relation ID.
type: string
example: abc-123-def
meta:
$ref: '#/components/schemas/RelationMeta'
relationships:
$ref: '#/components/schemas/RelationRelationships'
subtype:
description: Relation subtype.
type: string
example: metric alert
type:
$ref: '#/components/schemas/RelationResponseType'
type: object
RelationType:
description: Supported relation types.
enum:
- RelationTypeOwns
- RelationTypeOwnedBy
- RelationTypeDependsOn
- RelationTypeDependencyOf
- RelationTypePartsOf
- RelationTypeHasPart
- RelationTypeOtherOwns
- RelationTypeOtherOwnedBy
- RelationTypeImplementedBy
- RelationTypeImplements
type: string
x-enum-varnames:
- RELATIONTYPEOWNS
- RELATIONTYPEOWNEDBY
- RELATIONTYPEDEPENDSON
- RELATIONTYPEDEPENDENCYOF
- RELATIONTYPEPARTSOF
- RELATIONTYPEHASPART
- RELATIONTYPEOTHEROWNS
- RELATIONTYPEOTHEROWNEDBY
- RELATIONTYPEIMPLEMENTEDBY
- RELATIONTYPEIMPLEMENTS
RelationResponseData:
description: Array of relation responses
items:
$ref: '#/components/schemas/RelationResponse'
type: array
EntityToIncidents:
description: Entity to incidents relationship.
properties:
data:
$ref: '#/components/schemas/RelationshipArray'
type: object
RelationAttributes:
description: Relation attributes.
properties:
from:
$ref: '#/components/schemas/RelationEntity'
to:
$ref: '#/components/schemas/RelationEntity'
type:
$ref: '#/components/schemas/RelationType'
type: object
RelationIncludeType:
description: Supported include types for relations.
enum:
- entity
- schema
type: string
x-enum-varnames:
- ENTITY
- SCHEMA
RelationRelationships:
description: Relation relationships.
properties:
fromEntity:
$ref: '#/components/schemas/RelationToEntity'
toEntity:
$ref: '#/components/schemas/RelationToEntity'
type: object
EntityToRelatedEntities:
description: Entity to related entities relationship.
properties:
data:
$ref: '#/components/schemas/RelationshipArray'
type: object
EntityToOncalls:
description: Entity to oncalls relationship.
properties:
data:
$ref: '#/components/schemas/RelationshipArray'
type: object
ListRelationCatalogResponse:
description: List entity relation response.
properties:
data:
$ref: '#/components/schemas/RelationResponseData'
included:
$ref: '#/components/schemas/ListRelationCatalogResponseIncluded'
links:
$ref: '#/components/schemas/ListRelationCatalogResponseLinks'
meta:
$ref: '#/components/schemas/RelationResponseMeta'
type: object
RelationshipArray:
description: Relationships.
items:
$ref: '#/components/schemas/RelationshipItem'
type: array
EntityData:
description: Entity data.
properties:
attributes:
$ref: '#/components/schemas/EntityAttributes'
id:
description: Entity ID.
type: string
example: abc-123-def
meta:
$ref: '#/components/schemas/EntityMeta'
relationships:
$ref: '#/components/schemas/EntityRelationships'
type:
description: Entity.
type: string
example: metric alert
type: object
parameters:
PageOffset:
description: Specific offset to use as the beginning of the returned page.
in: query
name: page[offset]
required: false
schema:
default: 0
example: 0
format: int64
type: integer
EntityID:
description: UUID or Entity Ref.
in: path
name: entity_id
required: true
schema:
example: service:myservice
type: string
FilterRelationByType:
description: Filter relations by type.
explode: true
in: query
name: filter[type]
required: false
schema:
$ref: '#/components/schemas/RelationType'
FilterRelationByToRef:
description: Filter relations by the reference of the second entity in the relation.
example: service:shopping-cart
explode: true
in: query
name: filter[to_ref]
required: false
schema:
type: string
RelationInclude:
description: Include relationship data.
explode: true
in: query
name: include
required: false
schema:
$ref: '#/components/schemas/RelationIncludeType'
FilterRelationByFromRef:
description: Filter relations by the reference of the first entity in the relation.
example: service:shopping-cart
explode: true
in: query
name: filter[from_ref]
required: false
schema:
type: string
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
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