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 Entities 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: Entities paths: /api/v2/catalog/entity: get: description: Get a list of entities from Software Catalog. operationId: ListCatalogEntity parameters: - $ref: '#/components/parameters/PageOffset' - description: Maximum number of entities in the response. example: 100 in: query name: page[limit] required: false schema: default: 100 format: int64 type: integer - $ref: '#/components/parameters/FilterByID' - $ref: '#/components/parameters/FilterByRef' - $ref: '#/components/parameters/FilterByName' - $ref: '#/components/parameters/FilterByKind' - $ref: '#/components/parameters/FilterByOwner' - $ref: '#/components/parameters/FilterByRelationType' - $ref: '#/components/parameters/FilterByExcludeSnapshot' - $ref: '#/components/parameters/Include' responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListEntityCatalogResponse' 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 Entities tags: - Entities x-menu-order: 1 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 post: description: Create or update entities in Software Catalog. operationId: UpsertCatalogEntity requestBody: content: application/json: schema: $ref: '#/components/schemas/UpsertCatalogEntityRequest' description: Entity YAML or JSON. required: true responses: '202': content: application/json: schema: $ref: '#/components/schemas/UpsertCatalogEntityResponse' description: ACCEPTED '400': $ref: '#/components/responses/BadRequestResponse' '403': $ref: '#/components/responses/ForbiddenResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - apm_service_catalog_write summary: Datadog Create or Update Entities tags: - Entities x-codegen-request-body-name: body x-given: entity: parameters: - name: body value: "{\n \"apiVersion\": \"v3\",\n \"kind\": \"service\",\n \"metadata\": {\n \"name\": \"service-{{ unique_lower_alnum }}\",\n \"displayName\": \"Shopping Cart\",\n \"inheritFrom\": \"service:otherService\",\n \"tags\": [\n \"tag:value\"\n ],\n \"links\": [\n {\n \"name\": \"shopping-cart runbook\",\n \"type\": \"runbook\",\n \"url\": \"https://runbook/shopping-cart\"\n },\n {\n \"name\": \"shopping-cart architecture\",\n \"provider\": \"gdoc\",\n \"url\": \"https://google.drive/shopping-cart-architecture\",\n \"type\": \"doc\"\n },\n {\n \"name\": \"shopping-cart Wiki\",\n \"provider\": \"wiki\",\n \"url\": \"https://wiki/shopping-cart\",\n \"type\": \"doc\"\n },\n {\n \"name\": \"shopping-cart source code\",\n \"provider\": \"github\",\n \"url\": \"http://github/shopping-cart\",\n \"type\": \"repo\"\n }\n ],\n \"contacts\": [\n {\n \"name\": \"Support Email\",\n \"type\": \"email\",\n \"contact\": \"team@shopping.com\"\n },\n {\n \"name\": \"Support Slack\",\n \"type\": \"slack\",\n \"contact\": \"https://www.slack.com/archives/shopping-cart\"\n }\n ],\n \"owner\": \"myteam\",\n \"additionalOwners\": [\n {\n \"name\": \"opsTeam\",\n \"type\": \"operator\"\n }\n ]\n },\n \"integrations\": {\n \"pagerduty\": {\n \"serviceURL\": \"https://www.pagerduty.com/service-directory/Pshopping-cart\"\n },\n \"opsgenie\": {\n \"serviceURL\": \"https://www.opsgenie.com/service/shopping-cart\",\n \"region\": \"US\"\n }\n },\n \"extensions\": {\n \"datadoghq.com/shopping-cart\": {\n \"customField\": \"customValue\"\n }\n },\n \"spec\": {\n \"lifecycle\": \"production\",\n \"tier\": \"1\",\n \"type\": \"web\",\n \"languages\": [\n \"go\",\n \"python\"\n ],\n \"dependsOn\": [\n \"service:serviceA\",\n \"service:serviceB\"\n ]\n },\n \"datadog\": {\n \"performanceData\": {\n \"tags\": [\n \"service:shopping-cart\",\n \"hostname:shopping-cart\"\n ]\n },\n \"events\": [\n {\n \"name\": \"deployment events\",\n \"query\": \"app:myapp AND type:github\"\n },\n {\n \"name\": \"event type B\",\n \"query\": \"app:myapp AND type:github\"\n }\n ],\n \"logs\": [\n {\n \"name\": \"critical logs\",\n \"query\": \"app:myapp AND type:github\"\n },\n {\n \"name\": \"ops logs\",\n \"query\": \"app:myapp AND type:github\"\n }\n ],\n \"pipelines\": {\n \"fingerprints\": [\n \"fp1\",\n \"fp2\"\n ]\n },\n \"codeLocations\": [\n {\n \"repositoryURL\": \"http://github/shopping-cart.git\",\n \"paths\": [\n \"baz/*.c\",\n \"bat/**/*\",\n \"../plop/*.java\"\n ]\n },\n {\n \"repositoryURL\": \"http://github/shopping-cart-2.git\",\n \"paths\": [\n \"baz/*.c\",\n \"bat/**/*\",\n \"../plop/*.java\"\n ]\n }\n ]\n }\n}" step: there is a valid entity in the system x-menu-order: 2 x-undo: operationId: DeleteCatalogEntity parameters: - name: entity_id source: data[0].id type: unsafe x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK components: schemas: EntityRaw: description: Entity definition in raw JSON or YAML representation. example: "apiVersion: v3\nkind: service\nmetadata:\n name: myservice\n" type: string EntityToRawSchema: description: Entity to raw schema relationship. properties: data: $ref: '#/components/schemas/RelationshipItem' type: object EntityV3DatadogLogItem: additionalProperties: false description: Log association item. properties: name: description: The name of the query. type: string example: Example Monitor query: description: The query to run. type: string example: avg:system.cpu.user{*} type: object EntityV3: description: Entity schema v3. oneOf: - $ref: '#/components/schemas/EntityV3Service' - $ref: '#/components/schemas/EntityV3Datastore' - $ref: '#/components/schemas/EntityV3Queue' - $ref: '#/components/schemas/EntityV3System' - $ref: '#/components/schemas/EntityV3API' EntityV3APIVersion: description: The schema version of entity type. The field is known as schema-version in the previous version. enum: - v3 example: v3 type: string x-enum-varnames: - V3 EntityV3DatadogEventItem: additionalProperties: false description: Events association item. properties: name: description: The name of the query. type: string example: Example Monitor query: description: The query to run. type: string example: avg:system.cpu.user{*} type: object EntityV3DatadogIntegrationOpsgenie: additionalProperties: false description: An Opsgenie integration schema. properties: region: description: The region for the Opsgenie integration. minLength: 1 type: string example: example_value serviceURL: description: The service URL for the Opsgenie integration. example: https://www.opsgenie.com/service/shopping-cart minLength: 1 type: string required: - serviceURL type: object EntityResponseIncludedRelatedOncallEscalations: description: Oncall escalations. items: $ref: '#/components/schemas/EntityResponseIncludedRelatedOncallEscalationItem' type: array EntityV3APISpecInterfaceDefinition: additionalProperties: false description: The definition of `EntityV3APISpecInterfaceDefinition` object. properties: definition: description: The API definition. type: object type: object EntityV3APISpecInterfaceFileRef: additionalProperties: false description: The definition of `EntityV3APISpecInterfaceFileRef` object. properties: fileRef: description: The reference to the API definition file. type: string example: example_value type: object EntityV3ServiceDatadog: additionalProperties: false description: Datadog product integrations for the service entity. properties: codeLocations: $ref: '#/components/schemas/EntityV3DatadogCodeLocations' events: $ref: '#/components/schemas/EntityV3DatadogEvents' logs: $ref: '#/components/schemas/EntityV3DatadogLogs' performanceData: $ref: '#/components/schemas/EntityV3DatadogPerformance' pipelines: $ref: '#/components/schemas/EntityV3DatadogPipelines' type: object EntityToRelatedEntities: description: Entity to related entities relationship. properties: data: $ref: '#/components/schemas/RelationshipArray' type: object EntityV3DatastoreKind: description: The definition of Entity V3 Datastore Kind object. enum: - datastore example: datastore type: string x-enum-varnames: - DATASTORE EntityToOncalls: description: Entity to oncalls relationship. properties: data: $ref: '#/components/schemas/RelationshipArray' type: object UpsertCatalogEntityRequest: description: Create or update entity request. oneOf: - $ref: '#/components/schemas/EntityV3' - $ref: '#/components/schemas/EntityRaw' ListEntityCatalogResponseIncludedItem: description: List entity response included item. oneOf: - $ref: '#/components/schemas/EntityResponseIncludedSchema' - $ref: '#/components/schemas/EntityResponseIncludedRawSchema' - $ref: '#/components/schemas/EntityResponseIncludedRelatedEntity' - $ref: '#/components/schemas/EntityResponseIncludedOncall' - $ref: '#/components/schemas/EntityResponseIncludedIncident' EntityV3MetadataContactsItems: additionalProperties: false description: The definition of Entity V3 Metadata Contacts Items object. properties: contact: description: Contact value. example: https://slack/ type: string name: description: Contact name. minLength: 2 type: string example: Example Monitor type: description: Contact type. example: slack type: string required: - type - contact type: object EntityResponseIncludedRelatedEntityAttributes: description: Related entity attributes. 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: description: Entity relation type to the associated entity. type: string example: metric alert type: object EntityResponseIncludedRelatedEntity: description: Included related entity. properties: attributes: $ref: '#/components/schemas/EntityResponseIncludedRelatedEntityAttributes' id: description: Entity UUID. type: string example: abc-123-def meta: $ref: '#/components/schemas/EntityResponseIncludedRelatedEntityMeta' type: $ref: '#/components/schemas/EntityResponseIncludedRelatedEntityType' type: object EntityV3Integrations: additionalProperties: false description: A base schema for defining third-party integrations. properties: opsgenie: $ref: '#/components/schemas/EntityV3DatadogIntegrationOpsgenie' pagerduty: $ref: '#/components/schemas/EntityV3DatadogIntegrationPagerduty' type: object EntityV3API: additionalProperties: false description: Schema for API entities. properties: apiVersion: $ref: '#/components/schemas/EntityV3APIVersion' datadog: $ref: '#/components/schemas/EntityV3APIDatadog' extensions: additionalProperties: {} description: Custom extensions. This is the free-formed field to send client-side metadata. No Datadog features are affected by this field. type: object x-ignore-duplicate-object: true integrations: $ref: '#/components/schemas/EntityV3Integrations' kind: $ref: '#/components/schemas/EntityV3APIKind' metadata: $ref: '#/components/schemas/EntityV3Metadata' spec: $ref: '#/components/schemas/EntityV3APISpec' required: - apiVersion - kind - metadata type: object EntityResponseIncludedOncall: description: Included oncall. properties: attributes: $ref: '#/components/schemas/EntityResponseIncludedRelatedOncallAttributes' id: description: Oncall ID. type: string example: abc-123-def type: $ref: '#/components/schemas/EntityResponseIncludedOncallType' type: object EntityV3SystemSpec: additionalProperties: false description: The definition of Entity V3 System Spec object. properties: components: description: A list of components belongs to the system. items: type: string type: array lifecycle: description: The lifecycle state of the component. minLength: 1 type: string example: example_value tier: description: An entity reference to the owner of the component. minLength: 1 type: string example: example_value type: object EntityResponseIncludedRawSchemaType: description: Raw schema type. enum: - rawSchema type: string x-enum-varnames: - RAW_SCHEMA 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 EntityV3DatastoreDatadog: additionalProperties: false description: Datadog product integrations for the datastore entity. properties: events: $ref: '#/components/schemas/EntityV3DatadogEvents' logs: $ref: '#/components/schemas/EntityV3DatadogLogs' performanceData: $ref: '#/components/schemas/EntityV3DatadogPerformance' type: object x-ignore-duplicate-object: true EntityResponseIncludedSchemaAttributes: description: Included schema. properties: schema: $ref: '#/components/schemas/EntityV3' type: object EntityV3Datastore: additionalProperties: false description: Schema for datastore entities. properties: apiVersion: $ref: '#/components/schemas/EntityV3APIVersion' datadog: $ref: '#/components/schemas/EntityV3DatastoreDatadog' extensions: additionalProperties: {} description: Custom extensions. This is the free-formed field to send client side metadata. No Datadog features are affected by this field. type: object x-ignore-duplicate-object: true integrations: $ref: '#/components/schemas/EntityV3Integrations' kind: $ref: '#/components/schemas/EntityV3DatastoreKind' metadata: $ref: '#/components/schemas/EntityV3Metadata' spec: $ref: '#/components/schemas/EntityV3DatastoreSpec' required: - apiVersion - kind - metadata type: object EntityV3DatadogPerformance: additionalProperties: false description: Performance stats association. properties: tags: description: A list of APM entity tags that associates the APM Stats data with the entity. items: type: string type: array type: object EntityToIncidents: description: Entity to incidents relationship. properties: data: $ref: '#/components/schemas/RelationshipArray' type: object EntityResponseIncludedRelatedOncallAttributes: description: Included related oncall attributes. properties: escalations: $ref: '#/components/schemas/EntityResponseIncludedRelatedOncallEscalations' provider: description: Oncall provider. type: string example: abc-123-def type: object EntityResponseData: description: List of entity data. items: $ref: '#/components/schemas/EntityData' type: array EntityV3QueueDatadog: additionalProperties: false description: Datadog product integrations for the datastore entity. properties: events: $ref: '#/components/schemas/EntityV3DatadogEvents' logs: $ref: '#/components/schemas/EntityV3DatadogLogs' performanceData: $ref: '#/components/schemas/EntityV3DatadogPerformance' type: object x-ignore-duplicate-object: true EntityResponseMeta: description: Entity metadata. properties: count: description: Total entities count. format: int64 type: integer example: 42 includeCount: description: Total included data count. format: int64 type: integer example: 42 type: object EntityResponseIncludedRawSchema: description: Included raw schema. properties: attributes: $ref: '#/components/schemas/EntityResponseIncludedRawSchemaAttributes' id: description: Raw schema ID. type: string example: abc-123-def type: $ref: '#/components/schemas/EntityResponseIncludedRawSchemaType' type: object EntityV3QueueSpec: additionalProperties: false description: The definition of Entity V3 Queue Spec object. properties: componentOf: description: A list of components the queue is a part of items: type: string type: array lifecycle: description: The lifecycle state of the queue. minLength: 1 type: string example: example_value tier: description: The importance of the queue. minLength: 1 type: string example: example_value type: description: The type of queue. type: string example: metric alert type: object RelationshipArray: description: Relationships. items: $ref: '#/components/schemas/RelationshipItem' type: array EntityResponseIncludedRelatedIncidentAttributes: description: Incident attributes. properties: createdAt: description: Incident creation time. format: date-time type: string example: example_value htmlURL: description: Incident URL. type: string example: https://app.datadoghq.com provider: description: Incident provider. type: string example: abc-123-def status: description: Incident status. type: string example: OK title: description: Incident title. type: string example: Example Monitor type: object EntityResponseIncludedSchema: description: Included detail entity schema. properties: attributes: $ref: '#/components/schemas/EntityResponseIncludedSchemaAttributes' id: description: Entity ID. type: string example: abc-123-def type: $ref: '#/components/schemas/EntityResponseIncludedSchemaType' 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 EntityV3APIKind: description: The definition of Entity V3 API Kind object. enum: - api example: api type: string x-enum-varnames: - API EntityV3DatadogLogs: additionalProperties: false description: Logs association. items: $ref: '#/components/schemas/EntityV3DatadogLogItem' type: array EntityV3APIDatadog: additionalProperties: false description: Datadog product integrations for the API entity. properties: codeLocations: $ref: '#/components/schemas/EntityV3DatadogCodeLocations' events: $ref: '#/components/schemas/EntityV3DatadogEvents' logs: $ref: '#/components/schemas/EntityV3DatadogLogs' performanceData: $ref: '#/components/schemas/EntityV3DatadogPerformance' pipelines: $ref: '#/components/schemas/EntityV3DatadogPipelines' type: object EntityResponseIncludedIncident: description: Included incident. properties: attributes: $ref: '#/components/schemas/EntityResponseIncludedRelatedIncidentAttributes' id: description: Incident ID. type: string example: abc-123-def type: $ref: '#/components/schemas/EntityResponseIncludedIncidentType' type: object ListEntityCatalogResponseIncluded: description: List entity response included. items: $ref: '#/components/schemas/ListEntityCatalogResponseIncludedItem' type: array 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 UpsertCatalogEntityResponseIncluded: description: Upsert entity response included. items: $ref: '#/components/schemas/UpsertCatalogEntityResponseIncludedItem' type: array ListEntityCatalogResponse: description: List entity response. properties: data: $ref: '#/components/schemas/EntityResponseData' included: $ref: '#/components/schemas/ListEntityCatalogResponseIncluded' links: $ref: '#/components/schemas/ListEntityCatalogResponseLinks' meta: $ref: '#/components/schemas/EntityResponseMeta' type: object EntityV3ServiceSpec: additionalProperties: false description: The definition of Entity V3 Service Spec object. properties: componentOf: description: A list of components the service is a part of items: type: string type: array dependsOn: description: A list of components the service depends on. items: type: string type: array languages: description: The service's programming language. items: type: string type: array lifecycle: description: The lifecycle state of the component. minLength: 1 type: string example: example_value tier: description: The importance of the component. minLength: 1 type: string example: example_value type: description: The type of service. type: string example: metric alert 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 EntityV3Service: additionalProperties: false description: Schema for service entities. properties: apiVersion: $ref: '#/components/schemas/EntityV3APIVersion' datadog: $ref: '#/components/schemas/EntityV3ServiceDatadog' extensions: additionalProperties: {} description: Custom extensions. This is the free-formed field to send client-side metadata. No Datadog features are affected by this field. type: object x-ignore-duplicate-object: true integrations: $ref: '#/components/schemas/EntityV3Integrations' kind: $ref: '#/components/schemas/EntityV3ServiceKind' metadata: $ref: '#/components/schemas/EntityV3Metadata' spec: $ref: '#/components/schemas/EntityV3ServiceSpec' required: - apiVersion - kind - metadata type: object EntityResponseIncludedSchemaType: description: Schema type. enum: - schema type: string x-enum-varnames: - SCHEMA EntityV3Queue: additionalProperties: false description: Schema for queue entities. properties: apiVersion: $ref: '#/components/schemas/EntityV3APIVersion' datadog: $ref: '#/components/schemas/EntityV3QueueDatadog' extensions: additionalProperties: {} description: Custom extensions. This is the free-formed field to send client-side metadata. No Datadog features are affected by this field. type: object x-ignore-duplicate-object: true integrations: $ref: '#/components/schemas/EntityV3Integrations' kind: $ref: '#/components/schemas/EntityV3QueueKind' metadata: $ref: '#/components/schemas/EntityV3Metadata' spec: $ref: '#/components/schemas/EntityV3QueueSpec' required: - apiVersion - kind - metadata type: object EntityV3MetadataAdditionalOwnersItems: description: The definition of Entity V3 Metadata Additional Owners Items object. properties: name: description: Team name. example: '' type: string type: description: Team type. type: string example: metric alert required: - name type: object EntityV3APISpecInterface: additionalProperties: false description: The API definition. oneOf: - $ref: '#/components/schemas/EntityV3APISpecInterfaceFileRef' - $ref: '#/components/schemas/EntityV3APISpecInterfaceDefinition' EntityV3SystemDatadog: additionalProperties: false description: Datadog product integrations for the service entity. properties: events: $ref: '#/components/schemas/EntityV3DatadogEvents' logs: $ref: '#/components/schemas/EntityV3DatadogLogs' performanceData: $ref: '#/components/schemas/EntityV3DatadogPerformance' pipelines: $ref: '#/components/schemas/EntityV3DatadogPipelines' type: object EntityV3DatadogCodeLocationItem: additionalProperties: false description: Code location item. properties: paths: description: The paths (glob) to the source code of the service. items: type: string type: array repositoryURL: description: The repository path of the source code of the entity. type: string example: https://app.datadoghq.com type: object EntityResponseIncludedRelatedEntityMeta: description: Included related entity meta. properties: createdAt: description: Entity creation time. format: date-time type: string example: example_value defined_by: description: Entity relation defined by. type: string example: example_value modifiedAt: description: Entity modification time. format: date-time type: string example: example_value source: description: Entity relation source. type: string example: example_value type: object EntityResponseIncludedRelatedEntityType: description: Related entity. enum: - relatedEntity type: string x-enum-varnames: - RELATED_ENTITY 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 IncludeType: description: Supported include types. enum: - schema - raw_schema - oncall - incident - relation type: string x-enum-varnames: - SCHEMA - RAW_SCHEMA - ONCALL - INCIDENT - RELATION EntityToSchema: description: Entity to detail schema relationship. properties: data: $ref: '#/components/schemas/RelationshipItem' type: object EntityV3DatadogPipelines: additionalProperties: false description: CI Pipelines association. properties: fingerprints: description: A list of CI Fingerprints that associate CI Pipelines with the entity. items: type: string type: array type: object EntityV3DatadogEvents: additionalProperties: false description: Events associations. items: $ref: '#/components/schemas/EntityV3DatadogEventItem' type: array EntityV3System: additionalProperties: false description: Schema for system entities. properties: apiVersion: $ref: '#/components/schemas/EntityV3APIVersion' datadog: $ref: '#/components/schemas/EntityV3SystemDatadog' extensions: additionalProperties: {} description: Custom extensions. This is the free-formed field to send client-side metadata. No Datadog features are affected by this field. type: object x-ignore-duplicate-object: true integrations: $ref: '#/components/schemas/EntityV3Integrations' kind: $ref: '#/components/schemas/EntityV3SystemKind' metadata: $ref: '#/components/schemas/EntityV3Metadata' spec: $ref: '#/components/schemas/EntityV3SystemSpec' required: - apiVersion - kind - metadata 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 EntityResponseIncludedRelatedOncallEscalationItem: description: Oncall escalation. properties: email: description: Oncall email. type: string example: user@example.com escalationLevel: description: Oncall level. format: int64 type: integer example: 42 name: description: Oncall name. type: string example: Example Monitor type: object EntityV3MetadataLinksItems: additionalProperties: false description: The definition of Entity V3 Metadata Links Items object. properties: name: description: Link name. example: mylink type: string provider: description: Link provider. type: string example: abc-123-def type: default: other description: Link type. example: link type: string url: description: Link URL. example: https://mylink type: string required: - name - type - url type: object EntityV3DatadogCodeLocations: additionalProperties: false description: Schema for mapping source code locations to an entity. items: $ref: '#/components/schemas/EntityV3DatadogCodeLocationItem' type: array EntityResponseIncludedIncidentType: description: Incident description. enum: - incident type: string x-enum-varnames: - INCIDENT EntityV3SystemKind: description: The definition of Entity V3 System Kind object. enum: - system example: system type: string x-enum-varnames: - SYSTEM UpsertCatalogEntityResponse: description: Upsert entity response. properties: data: $ref: '#/components/schemas/EntityResponseData' included: $ref: '#/components/schemas/UpsertCatalogEntityResponseIncluded' meta: $ref: '#/components/schemas/EntityResponseMeta' type: object EntityV3ServiceKind: description: The definition of Entity V3 Service Kind object. enum: - service example: service type: string x-enum-varnames: - SERVICE EntityResponseIncludedOncallType: description: Oncall type. enum: - oncall type: string x-enum-varnames: - ONCALL EntityV3APISpec: additionalProperties: false description: The definition of Entity V3 API Spec object. properties: implementedBy: description: Services which implemented the API. items: type: string type: array interface: $ref: '#/components/schemas/EntityV3APISpecInterface' lifecycle: description: The lifecycle state of the component. minLength: 1 type: string example: example_value tier: description: The importance of the component. minLength: 1 type: string example: example_value type: description: The type of API. type: string example: metric alert type: object UpsertCatalogEntityResponseIncludedItem: description: Upsert entity response included item. oneOf: - $ref: '#/components/schemas/EntityResponseIncludedSchema' EntityV3QueueKind: description: The definition of Entity V3 Queue Kind object. enum: - queue example: queue type: string x-enum-varnames: - QUEUE EntityV3DatadogIntegrationPagerduty: additionalProperties: false description: A PagerDuty integration schema. properties: serviceURL: description: The service URL for the PagerDuty integration. example: https://www.pagerduty.com/service-directory/Pshopping-cart minLength: 1 type: string required: - serviceURL type: object EntityResponseIncludedRawSchemaAttributes: description: Included raw schema attributes. properties: rawSchema: description: Schema from user input in base64 encoding. type: string example: example_value type: object EntityV3Metadata: additionalProperties: false description: The definition of Entity V3 Metadata object. properties: additionalOwners: additionalProperties: false description: The additional owners of the entity, usually a team. items: $ref: '#/components/schemas/EntityV3MetadataAdditionalOwnersItems' type: array contacts: additionalProperties: false description: A list of contacts for the entity. items: $ref: '#/components/schemas/EntityV3MetadataContactsItems' type: array description: description: Short description of the entity. The UI can leverage the description for display. type: string example: example_value displayName: description: User friendly name of the entity. The UI can leverage the display name for display. type: string example: Example Monitor id: description: A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored. example: 4b163705-23c0-4573-b2fb-f6cea2163fcb minLength: 1 type: string inheritFrom: description: The entity reference from which to inherit metadata example: application:default/myapp type: string links: additionalProperties: false description: A list of links for the entity. items: $ref: '#/components/schemas/EntityV3MetadataLinksItems' type: array managed: additionalProperties: {} description: A read-only set of Datadog managed attributes generated by Datadog. User supplied values are ignored. type: object name: description: Unique name given to an entity under the kind/namespace. example: myService minLength: 1 type: string namespace: description: Namespace is a part of unique identifier. It has a default value of 'default'. example: default minLength: 1 type: string owner: description: The owner of the entity, usually a team. type: string example: example_value tags: description: A set of custom tags. example: - this:tag - that:tag items: type: string type: array required: - name type: object EntityV3DatastoreSpec: additionalProperties: false description: The definition of Entity V3 Datastore Spec object. properties: componentOf: description: A list of components the datastore is a part of items: type: string type: array lifecycle: description: The lifecycle state of the datastore. minLength: 1 type: string example: example_value tier: description: The importance of the datastore. minLength: 1 type: string example: example_value type: description: The type of datastore. type: string example: metric alert type: object 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 ListEntityCatalogResponseLinks: description: List entity response links. properties: next: description: Next link. type: string example: example_value previous: description: Previous link. type: string example: example_value self: description: Current link. type: string example: example_value type: object parameters: FilterByOwner: description: Filter entities by owner. explode: true in: query name: filter[owner] required: false schema: type: string FilterByName: description: Filter entities by name. explode: true in: query name: filter[name] required: false schema: type: string FilterByExcludeSnapshot: description: Filter entities by excluding snapshotted entities. in: query name: filter[exclude_snapshot] required: false schema: type: string FilterByID: description: Filter entities by UUID. explode: true in: query name: filter[id] required: false schema: type: string 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 FilterByRelationType: description: Filter entities by relation type. explode: true in: query name: filter[relation][type] required: false schema: $ref: '#/components/schemas/RelationType' Include: description: Include relationship data. explode: true in: query name: include required: false schema: $ref: '#/components/schemas/IncludeType' FilterByRef: description: Filter entities by reference example: service:shopping-cart explode: true in: query name: filter[ref] required: false schema: type: string FilterByKind: description: Filter entities by kind. explode: true in: query name: filter[kind] required: false schema: type: string responses: ForbiddenResponse: content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' description: Forbidden 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 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