From cae7800503a751dd674689b3bf1d14d4e77140e6 Mon Sep 17 00:00:00 2001 From: "ci.datadog-api-spec" Date: Wed, 9 Jul 2025 18:07:04 +0000 Subject: [PATCH] Regenerate client from commit c5b3557c of spec repo --- .apigentools-info | 8 +- .../en/api/v2/software-catalog/examples.json | 6 +- data/api/v2/full_spec.yaml | 11 +- data/api/v2/full_spec_deref.json | 852 +++++++++++++----- static/resources/json/full_spec_v2.json | 852 +++++++++++++----- 5 files changed, 1294 insertions(+), 435 deletions(-) diff --git a/.apigentools-info b/.apigentools-info index 53e59a4915a1f..fba992b7e7638 100644 --- a/.apigentools-info +++ b/.apigentools-info @@ -4,13 +4,13 @@ "spec_versions": { "v1": { "apigentools_version": "1.6.6", - "regenerated": "2025-07-09 16:50:36.830016", - "spec_repo_commit": "d0906173" + "regenerated": "2025-07-09 18:06:41.625080", + "spec_repo_commit": "c5b3557c" }, "v2": { "apigentools_version": "1.6.6", - "regenerated": "2025-07-09 16:50:46.124503", - "spec_repo_commit": "d0906173" + "regenerated": "2025-07-09 18:06:50.885571", + "spec_repo_commit": "c5b3557c" } } } \ No newline at end of file diff --git a/content/en/api/v2/software-catalog/examples.json b/content/en/api/v2/software-catalog/examples.json index 348eed6449462..3eeba97c25596 100644 --- a/content/en/api/v2/software-catalog/examples.json +++ b/content/en/api/v2/software-catalog/examples.json @@ -164,7 +164,7 @@ "includeCount": "integer" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

List of entity data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Entity attributes.

\n
\n
\n
\n
\n
\n

apiVersion

\n
\n

string

\n

The API version.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The description.

\n
\n \n
\n
\n
\n
\n
\n

displayName

\n
\n

string

\n

The display name.

\n
\n \n
\n
\n
\n
\n
\n

kind

\n
\n

string

\n

The kind.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name.

\n
\n \n
\n
\n
\n
\n
\n

namespace

\n
\n

string

\n

The namespace.

\n
\n \n
\n
\n
\n
\n
\n

owner

\n
\n

string

\n

The owner.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

The tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Entity ID.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Entity metadata.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

string

\n

The creation time.

\n
\n \n
\n
\n
\n
\n
\n

ingestionSource

\n
\n

string

\n

The ingestion source.

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt

\n
\n

string

\n

The modification time.

\n
\n \n
\n
\n
\n
\n
\n

origin

\n
\n

string

\n

The origin.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Entity relationships.

\n
\n
\n
\n
\n
\n

incidents

\n
\n

object

\n

Entity to incidents relationship.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Relationships.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Associated data ID.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Relationship type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

oncall

\n
\n

object

\n

Entity to oncalls relationship.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Relationships.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Associated data ID.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Relationship type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

rawSchema

\n
\n

object

\n

Entity to raw schema relationship.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Relationship entry.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Associated data ID.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Relationship type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

relatedEntities

\n
\n

object

\n

Entity to related entities relationship.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Relationships.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Associated data ID.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Relationship type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

schema

\n
\n

object

\n

Entity to detail schema relationship.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Relationship entry.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Associated data ID.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Relationship type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

List entity response included.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Included detail entity schema.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Included schema.

\n
\n
\n
\n
\n
\n

schema

\n
\n

 <oneOf>

\n

Entity schema v3.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Schema for service entities.

\n
\n
\n
\n
\n
\n

apiVersion [required]

\n
\n

enum

\n

The schema version of entity type. The field is known as schema-version in the previous version. \nAllowed enum values: v3

\n
\n \n
\n
\n
\n
\n
\n

datadog

\n
\n

object

\n

Datadog product integrations for the service entity.

\n
\n
\n
\n
\n
\n

codeLocations

\n
\n

[object]

\n

Schema for mapping source code locations to an entity.

\n
\n
\n
\n
\n
\n

paths

\n
\n

[string]

\n

The paths (glob) to the source code of the service.

\n
\n \n
\n
\n
\n
\n
\n

repositoryURL

\n
\n

string

\n

The repository path of the source code of the entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

events

\n
\n

[object]

\n

Events associations.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The query to run.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

logs

\n
\n

[object]

\n

Logs association.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The query to run.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

performanceData

\n
\n

object

\n

Performance stats association.

\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A list of APM entity tags that associates the APM Stats data with the entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

pipelines

\n
\n

object

\n

CI Pipelines association.

\n
\n
\n
\n
\n
\n

fingerprints

\n
\n

[string]

\n

A list of CI Fingerprints that associate CI Pipelines with the entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

extensions

\n
\n

object

\n

Custom extensions. This is the free-formed field to send client-side metadata. No Datadog features are affected by this field.

\n
\n \n
\n
\n
\n
\n
\n

integrations

\n
\n

object

\n

A base schema for defining third-party integrations.

\n
\n
\n
\n
\n
\n

opsgenie

\n
\n

object

\n

An Opsgenie integration schema.

\n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

The region for the Opsgenie integration.

\n
\n \n
\n
\n
\n
\n
\n

serviceURL [required]

\n
\n

string

\n

The service URL for the Opsgenie integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

pagerduty

\n
\n

object

\n

A PagerDuty integration schema.

\n
\n
\n
\n
\n
\n

serviceURL [required]

\n
\n

string

\n

The service URL for the PagerDuty integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of Entity V3 Service Kind object. \nAllowed enum values: service

\n
\n \n
\n
\n
\n
\n
\n

metadata [required]

\n
\n

object

\n

The definition of Entity V3 Metadata object.

\n
\n
\n
\n
\n
\n

additionalOwners

\n
\n

[object]

\n

The additional owners of the entity, usually a team.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Team name.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Team type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

contacts

\n
\n

[object]

\n

A list of contacts for the entity.

\n
\n
\n
\n
\n
\n

contact [required]

\n
\n

string

\n

Contact value.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Contact name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Contact type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Short description of the entity. The UI can leverage the description for display.

\n
\n \n
\n
\n
\n
\n
\n

displayName

\n
\n

string

\n

User friendly name of the entity. The UI can leverage the display name for display.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored.

\n
\n \n
\n
\n
\n
\n
\n

inheritFrom

\n
\n

string

\n

The entity reference from which to inherit metadata

\n
\n \n
\n
\n
\n
\n
\n

links

\n
\n

[object]

\n

A list of links for the entity.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Link name.

\n
\n \n
\n
\n
\n
\n
\n

provider

\n
\n

string

\n

Link provider.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Link type.

default: other

\n
\n \n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

Link URL.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

managed

\n
\n

object

\n

A read-only set of Datadog managed attributes generated by Datadog. User supplied values are ignored.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Unique name given to an entity under the kind/namespace.

\n
\n \n
\n
\n
\n
\n
\n

namespace

\n
\n

string

\n

Namespace is a part of unique identifier. It has a default value of 'default'.

\n
\n \n
\n
\n
\n
\n
\n

owner

\n
\n

string

\n

The owner of the entity, usually a team.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A set of custom tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

spec

\n
\n

object

\n

The definition of Entity V3 Service Spec object.

\n
\n
\n
\n
\n
\n

componentOf

\n
\n

[string]

\n

A list of components the service is a part of

\n
\n \n
\n
\n
\n
\n
\n

dependsOn

\n
\n

[string]

\n

A list of components the service depends on.

\n
\n \n
\n
\n
\n
\n
\n

languages

\n
\n

[string]

\n

The service's programming language.

\n
\n \n
\n
\n
\n
\n
\n

lifecycle

\n
\n

string

\n

The lifecycle state of the component.

\n
\n \n
\n
\n
\n
\n
\n

tier

\n
\n

string

\n

The importance of the component.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

The type of service.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Schema for datastore entities.

\n
\n
\n
\n
\n
\n

apiVersion [required]

\n
\n

enum

\n

The schema version of entity type. The field is known as schema-version in the previous version. \nAllowed enum values: v3

\n
\n \n
\n
\n
\n
\n
\n

datadog

\n
\n

object

\n

Datadog product integrations for the datastore entity.

\n
\n
\n
\n
\n
\n

events

\n
\n

[object]

\n

Events associations.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The query to run.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

logs

\n
\n

[object]

\n

Logs association.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The query to run.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

performanceData

\n
\n

object

\n

Performance stats association.

\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A list of APM entity tags that associates the APM Stats data with the entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

extensions

\n
\n

object

\n

Custom extensions. This is the free-formed field to send client side metadata. No Datadog features are affected by this field.

\n
\n \n
\n
\n
\n
\n
\n

integrations

\n
\n

object

\n

A base schema for defining third-party integrations.

\n
\n
\n
\n
\n
\n

opsgenie

\n
\n

object

\n

An Opsgenie integration schema.

\n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

The region for the Opsgenie integration.

\n
\n \n
\n
\n
\n
\n
\n

serviceURL [required]

\n
\n

string

\n

The service URL for the Opsgenie integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

pagerduty

\n
\n

object

\n

A PagerDuty integration schema.

\n
\n
\n
\n
\n
\n

serviceURL [required]

\n
\n

string

\n

The service URL for the PagerDuty integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of Entity V3 Datastore Kind object. \nAllowed enum values: datastore

\n
\n \n
\n
\n
\n
\n
\n

metadata [required]

\n
\n

object

\n

The definition of Entity V3 Metadata object.

\n
\n
\n
\n
\n
\n

additionalOwners

\n
\n

[object]

\n

The additional owners of the entity, usually a team.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Team name.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Team type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

contacts

\n
\n

[object]

\n

A list of contacts for the entity.

\n
\n
\n
\n
\n
\n

contact [required]

\n
\n

string

\n

Contact value.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Contact name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Contact type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Short description of the entity. The UI can leverage the description for display.

\n
\n \n
\n
\n
\n
\n
\n

displayName

\n
\n

string

\n

User friendly name of the entity. The UI can leverage the display name for display.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored.

\n
\n \n
\n
\n
\n
\n
\n

inheritFrom

\n
\n

string

\n

The entity reference from which to inherit metadata

\n
\n \n
\n
\n
\n
\n
\n

links

\n
\n

[object]

\n

A list of links for the entity.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Link name.

\n
\n \n
\n
\n
\n
\n
\n

provider

\n
\n

string

\n

Link provider.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Link type.

default: other

\n
\n \n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

Link URL.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

managed

\n
\n

object

\n

A read-only set of Datadog managed attributes generated by Datadog. User supplied values are ignored.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Unique name given to an entity under the kind/namespace.

\n
\n \n
\n
\n
\n
\n
\n

namespace

\n
\n

string

\n

Namespace is a part of unique identifier. It has a default value of 'default'.

\n
\n \n
\n
\n
\n
\n
\n

owner

\n
\n

string

\n

The owner of the entity, usually a team.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A set of custom tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

spec

\n
\n

object

\n

The definition of Entity V3 Datastore Spec object.

\n
\n
\n
\n
\n
\n

componentOf

\n
\n

[string]

\n

A list of components the datastore is a part of

\n
\n \n
\n
\n
\n
\n
\n

lifecycle

\n
\n

string

\n

The lifecycle state of the datastore.

\n
\n \n
\n
\n
\n
\n
\n

tier

\n
\n

string

\n

The importance of the datastore.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

The type of datastore.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Schema for queue entities.

\n
\n
\n
\n
\n
\n

apiVersion [required]

\n
\n

enum

\n

The schema version of entity type. The field is known as schema-version in the previous version. \nAllowed enum values: v3

\n
\n \n
\n
\n
\n
\n
\n

datadog

\n
\n

object

\n

Datadog product integrations for the datastore entity.

\n
\n
\n
\n
\n
\n

events

\n
\n

[object]

\n

Events associations.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The query to run.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

logs

\n
\n

[object]

\n

Logs association.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The query to run.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

performanceData

\n
\n

object

\n

Performance stats association.

\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A list of APM entity tags that associates the APM Stats data with the entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

extensions

\n
\n

object

\n

Custom extensions. This is the free-formed field to send client-side metadata. No Datadog features are affected by this field.

\n
\n \n
\n
\n
\n
\n
\n

integrations

\n
\n

object

\n

A base schema for defining third-party integrations.

\n
\n
\n
\n
\n
\n

opsgenie

\n
\n

object

\n

An Opsgenie integration schema.

\n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

The region for the Opsgenie integration.

\n
\n \n
\n
\n
\n
\n
\n

serviceURL [required]

\n
\n

string

\n

The service URL for the Opsgenie integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

pagerduty

\n
\n

object

\n

A PagerDuty integration schema.

\n
\n
\n
\n
\n
\n

serviceURL [required]

\n
\n

string

\n

The service URL for the PagerDuty integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of Entity V3 Queue Kind object. \nAllowed enum values: queue

\n
\n \n
\n
\n
\n
\n
\n

metadata [required]

\n
\n

object

\n

The definition of Entity V3 Metadata object.

\n
\n
\n
\n
\n
\n

additionalOwners

\n
\n

[object]

\n

The additional owners of the entity, usually a team.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Team name.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Team type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

contacts

\n
\n

[object]

\n

A list of contacts for the entity.

\n
\n
\n
\n
\n
\n

contact [required]

\n
\n

string

\n

Contact value.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Contact name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Contact type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Short description of the entity. The UI can leverage the description for display.

\n
\n \n
\n
\n
\n
\n
\n

displayName

\n
\n

string

\n

User friendly name of the entity. The UI can leverage the display name for display.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored.

\n
\n \n
\n
\n
\n
\n
\n

inheritFrom

\n
\n

string

\n

The entity reference from which to inherit metadata

\n
\n \n
\n
\n
\n
\n
\n

links

\n
\n

[object]

\n

A list of links for the entity.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Link name.

\n
\n \n
\n
\n
\n
\n
\n

provider

\n
\n

string

\n

Link provider.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Link type.

default: other

\n
\n \n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

Link URL.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

managed

\n
\n

object

\n

A read-only set of Datadog managed attributes generated by Datadog. User supplied values are ignored.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Unique name given to an entity under the kind/namespace.

\n
\n \n
\n
\n
\n
\n
\n

namespace

\n
\n

string

\n

Namespace is a part of unique identifier. It has a default value of 'default'.

\n
\n \n
\n
\n
\n
\n
\n

owner

\n
\n

string

\n

The owner of the entity, usually a team.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A set of custom tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

spec

\n
\n

object

\n

The definition of Entity V3 Queue Spec object.

\n
\n
\n
\n
\n
\n

componentOf

\n
\n

[string]

\n

A list of components the queue is a part of

\n
\n \n
\n
\n
\n
\n
\n

lifecycle

\n
\n

string

\n

The lifecycle state of the queue.

\n
\n \n
\n
\n
\n
\n
\n

tier

\n
\n

string

\n

The importance of the queue.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

The type of queue.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Schema for system entities.

\n
\n
\n
\n
\n
\n

apiVersion [required]

\n
\n

enum

\n

The schema version of entity type. The field is known as schema-version in the previous version. \nAllowed enum values: v3

\n
\n \n
\n
\n
\n
\n
\n

datadog

\n
\n

object

\n

Datadog product integrations for the service entity.

\n
\n
\n
\n
\n
\n

events

\n
\n

[object]

\n

Events associations.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The query to run.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

logs

\n
\n

[object]

\n

Logs association.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The query to run.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

performanceData

\n
\n

object

\n

Performance stats association.

\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A list of APM entity tags that associates the APM Stats data with the entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

pipelines

\n
\n

object

\n

CI Pipelines association.

\n
\n
\n
\n
\n
\n

fingerprints

\n
\n

[string]

\n

A list of CI Fingerprints that associate CI Pipelines with the entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

extensions

\n
\n

object

\n

Custom extensions. This is the free-formed field to send client-side metadata. No Datadog features are affected by this field.

\n
\n \n
\n
\n
\n
\n
\n

integrations

\n
\n

object

\n

A base schema for defining third-party integrations.

\n
\n
\n
\n
\n
\n

opsgenie

\n
\n

object

\n

An Opsgenie integration schema.

\n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

The region for the Opsgenie integration.

\n
\n \n
\n
\n
\n
\n
\n

serviceURL [required]

\n
\n

string

\n

The service URL for the Opsgenie integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

pagerduty

\n
\n

object

\n

A PagerDuty integration schema.

\n
\n
\n
\n
\n
\n

serviceURL [required]

\n
\n

string

\n

The service URL for the PagerDuty integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of Entity V3 System Kind object. \nAllowed enum values: system

\n
\n \n
\n
\n
\n
\n
\n

metadata [required]

\n
\n

object

\n

The definition of Entity V3 Metadata object.

\n
\n
\n
\n
\n
\n

additionalOwners

\n
\n

[object]

\n

The additional owners of the entity, usually a team.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Team name.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Team type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

contacts

\n
\n

[object]

\n

A list of contacts for the entity.

\n
\n
\n
\n
\n
\n

contact [required]

\n
\n

string

\n

Contact value.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Contact name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Contact type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Short description of the entity. The UI can leverage the description for display.

\n
\n \n
\n
\n
\n
\n
\n

displayName

\n
\n

string

\n

User friendly name of the entity. The UI can leverage the display name for display.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored.

\n
\n \n
\n
\n
\n
\n
\n

inheritFrom

\n
\n

string

\n

The entity reference from which to inherit metadata

\n
\n \n
\n
\n
\n
\n
\n

links

\n
\n

[object]

\n

A list of links for the entity.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Link name.

\n
\n \n
\n
\n
\n
\n
\n

provider

\n
\n

string

\n

Link provider.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Link type.

default: other

\n
\n \n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

Link URL.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

managed

\n
\n

object

\n

A read-only set of Datadog managed attributes generated by Datadog. User supplied values are ignored.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Unique name given to an entity under the kind/namespace.

\n
\n \n
\n
\n
\n
\n
\n

namespace

\n
\n

string

\n

Namespace is a part of unique identifier. It has a default value of 'default'.

\n
\n \n
\n
\n
\n
\n
\n

owner

\n
\n

string

\n

The owner of the entity, usually a team.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A set of custom tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

spec

\n
\n

object

\n

The definition of Entity V3 System Spec object.

\n
\n
\n
\n
\n
\n

components

\n
\n

[string]

\n

A list of components belongs to the system.

\n
\n \n
\n
\n
\n
\n
\n

lifecycle

\n
\n

string

\n

The lifecycle state of the component.

\n
\n \n
\n
\n
\n
\n
\n

tier

\n
\n

string

\n

An entity reference to the owner of the component.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Schema for API entities.

\n
\n
\n
\n
\n
\n

apiVersion [required]

\n
\n

enum

\n

The schema version of entity type. The field is known as schema-version in the previous version. \nAllowed enum values: v3

\n
\n \n
\n
\n
\n
\n
\n

datadog

\n
\n

object

\n

Datadog product integrations for the API entity.

\n
\n
\n
\n
\n
\n

codeLocations

\n
\n

[object]

\n

Schema for mapping source code locations to an entity.

\n
\n
\n
\n
\n
\n

paths

\n
\n

[string]

\n

The paths (glob) to the source code of the service.

\n
\n \n
\n
\n
\n
\n
\n

repositoryURL

\n
\n

string

\n

The repository path of the source code of the entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

events

\n
\n

[object]

\n

Events associations.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The query to run.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

logs

\n
\n

[object]

\n

Logs association.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The query to run.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

performanceData

\n
\n

object

\n

Performance stats association.

\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A list of APM entity tags that associates the APM Stats data with the entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

pipelines

\n
\n

object

\n

CI Pipelines association.

\n
\n
\n
\n
\n
\n

fingerprints

\n
\n

[string]

\n

A list of CI Fingerprints that associate CI Pipelines with the entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

extensions

\n
\n

object

\n

Custom extensions. This is the free-formed field to send client-side metadata. No Datadog features are affected by this field.

\n
\n \n
\n
\n
\n
\n
\n

integrations

\n
\n

object

\n

A base schema for defining third-party integrations.

\n
\n
\n
\n
\n
\n

opsgenie

\n
\n

object

\n

An Opsgenie integration schema.

\n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

The region for the Opsgenie integration.

\n
\n \n
\n
\n
\n
\n
\n

serviceURL [required]

\n
\n

string

\n

The service URL for the Opsgenie integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

pagerduty

\n
\n

object

\n

A PagerDuty integration schema.

\n
\n
\n
\n
\n
\n

serviceURL [required]

\n
\n

string

\n

The service URL for the PagerDuty integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of Entity V3 API Kind object. \nAllowed enum values: api

\n
\n \n
\n
\n
\n
\n
\n

metadata [required]

\n
\n

object

\n

The definition of Entity V3 Metadata object.

\n
\n
\n
\n
\n
\n

additionalOwners

\n
\n

[object]

\n

The additional owners of the entity, usually a team.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Team name.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Team type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

contacts

\n
\n

[object]

\n

A list of contacts for the entity.

\n
\n
\n
\n
\n
\n

contact [required]

\n
\n

string

\n

Contact value.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Contact name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Contact type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Short description of the entity. The UI can leverage the description for display.

\n
\n \n
\n
\n
\n
\n
\n

displayName

\n
\n

string

\n

User friendly name of the entity. The UI can leverage the display name for display.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored.

\n
\n \n
\n
\n
\n
\n
\n

inheritFrom

\n
\n

string

\n

The entity reference from which to inherit metadata

\n
\n \n
\n
\n
\n
\n
\n

links

\n
\n

[object]

\n

A list of links for the entity.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Link name.

\n
\n \n
\n
\n
\n
\n
\n

provider

\n
\n

string

\n

Link provider.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Link type.

default: other

\n
\n \n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

Link URL.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

managed

\n
\n

object

\n

A read-only set of Datadog managed attributes generated by Datadog. User supplied values are ignored.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Unique name given to an entity under the kind/namespace.

\n
\n \n
\n
\n
\n
\n
\n

namespace

\n
\n

string

\n

Namespace is a part of unique identifier. It has a default value of 'default'.

\n
\n \n
\n
\n
\n
\n
\n

owner

\n
\n

string

\n

The owner of the entity, usually a team.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A set of custom tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

spec

\n
\n

object

\n

The definition of Entity V3 API Spec object.

\n
\n
\n
\n
\n
\n

implementedBy

\n
\n

[string]

\n

Services which implemented the API.

\n
\n \n
\n
\n
\n
\n
\n

interface

\n
\n

 <oneOf>

\n

The API definition.

\n
\n \n
\n
\n
\n
\n
\n

lifecycle

\n
\n

string

\n

The lifecycle state of the component.

\n
\n \n
\n
\n
\n
\n
\n

tier

\n
\n

string

\n

The importance of the component.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

The type of API.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Entity ID.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Schema type. \nAllowed enum values: schema

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Included raw schema.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Included raw schema attributes.

\n
\n
\n
\n
\n
\n

rawSchema

\n
\n

string

\n

Schema from user input in base64 encoding.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Raw schema ID.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Raw schema type. \nAllowed enum values: rawSchema

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Included related entity.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Related entity attributes.

\n
\n
\n
\n
\n
\n

kind

\n
\n

string

\n

Entity kind.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Entity name.

\n
\n \n
\n
\n
\n
\n
\n

namespace

\n
\n

string

\n

Entity namespace.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Entity relation type to the associated entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Entity UUID.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Included related entity meta.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

Entity creation time.

\n
\n \n
\n
\n
\n
\n
\n

defined_by

\n
\n

string

\n

Entity relation defined by.

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt

\n
\n

date-time

\n

Entity modification time.

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

string

\n

Entity relation source.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Related entity. \nAllowed enum values: relatedEntity

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Included oncall.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Included related oncall attributes.

\n
\n
\n
\n
\n
\n

escalations

\n
\n

[object]

\n

Oncall escalations.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Oncall email.

\n
\n \n
\n
\n
\n
\n
\n

escalationLevel

\n
\n

int64

\n

Oncall level.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Oncall name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

provider

\n
\n

string

\n

Oncall provider.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Oncall ID.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Oncall type. \nAllowed enum values: oncall

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Included incident.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident attributes.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

Incident creation time.

\n
\n \n
\n
\n
\n
\n
\n

htmlURL

\n
\n

string

\n

Incident URL.

\n
\n \n
\n
\n
\n
\n
\n

provider

\n
\n

string

\n

Incident provider.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Incident status.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Incident title.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Incident ID.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Incident description. \nAllowed enum values: incident

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

List entity response links.

\n
\n
\n
\n
\n
\n

next

\n
\n

string

\n

Next link.

\n
\n \n
\n
\n
\n
\n
\n

previous

\n
\n

string

\n

Previous link.

\n
\n \n
\n
\n
\n
\n
\n

self

\n
\n

string

\n

Current link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Entity metadata.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

Total entities count.

\n
\n \n
\n
\n
\n
\n
\n

includeCount

\n
\n

int64

\n

Total included data count.

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

List of entity data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Entity attributes.

\n
\n
\n
\n
\n
\n

apiVersion

\n
\n

string

\n

The API version.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The description.

\n
\n \n
\n
\n
\n
\n
\n

displayName

\n
\n

string

\n

The display name.

\n
\n \n
\n
\n
\n
\n
\n

kind

\n
\n

string

\n

The kind.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name.

\n
\n \n
\n
\n
\n
\n
\n

namespace

\n
\n

string

\n

The namespace.

\n
\n \n
\n
\n
\n
\n
\n

owner

\n
\n

string

\n

The owner.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

The tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Entity ID.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Entity metadata.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

string

\n

The creation time.

\n
\n \n
\n
\n
\n
\n
\n

ingestionSource

\n
\n

string

\n

The ingestion source.

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt

\n
\n

string

\n

The modification time.

\n
\n \n
\n
\n
\n
\n
\n

origin

\n
\n

string

\n

The origin.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Entity relationships.

\n
\n
\n
\n
\n
\n

incidents

\n
\n

object

\n

Entity to incidents relationship.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Relationships.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Associated data ID.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Relationship type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

oncall

\n
\n

object

\n

Entity to oncalls relationship.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Relationships.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Associated data ID.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Relationship type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

rawSchema

\n
\n

object

\n

Entity to raw schema relationship.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Relationship entry.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Associated data ID.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Relationship type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

relatedEntities

\n
\n

object

\n

Entity to related entities relationship.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Relationships.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Associated data ID.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Relationship type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

schema

\n
\n

object

\n

Entity to detail schema relationship.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Relationship entry.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Associated data ID.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Relationship type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

List entity response included.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Included detail entity schema.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Included schema.

\n
\n
\n
\n
\n
\n

schema

\n
\n

 <oneOf>

\n

Entity schema v3.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Schema for service entities.

\n
\n
\n
\n
\n
\n

apiVersion [required]

\n
\n

enum

\n

The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version. \nAllowed enum values: v3,v2.2,v2.1,v2

\n
\n \n
\n
\n
\n
\n
\n

datadog

\n
\n

object

\n

Datadog product integrations for the service entity.

\n
\n
\n
\n
\n
\n

codeLocations

\n
\n

[object]

\n

Schema for mapping source code locations to an entity.

\n
\n
\n
\n
\n
\n

paths

\n
\n

[string]

\n

The paths (glob) to the source code of the service.

\n
\n \n
\n
\n
\n
\n
\n

repositoryURL

\n
\n

string

\n

The repository path of the source code of the entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

events

\n
\n

[object]

\n

Events associations.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The query to run.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

logs

\n
\n

[object]

\n

Logs association.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The query to run.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

performanceData

\n
\n

object

\n

Performance stats association.

\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A list of APM entity tags that associates the APM Stats data with the entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

pipelines

\n
\n

object

\n

CI Pipelines association.

\n
\n
\n
\n
\n
\n

fingerprints

\n
\n

[string]

\n

A list of CI Fingerprints that associate CI Pipelines with the entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

extensions

\n
\n

object

\n

Custom extensions. This is the free-formed field to send client-side metadata. No Datadog features are affected by this field.

\n
\n \n
\n
\n
\n
\n
\n

integrations

\n
\n

object

\n

A base schema for defining third-party integrations.

\n
\n
\n
\n
\n
\n

opsgenie

\n
\n

object

\n

An Opsgenie integration schema.

\n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

The region for the Opsgenie integration.

\n
\n \n
\n
\n
\n
\n
\n

serviceURL [required]

\n
\n

string

\n

The service URL for the Opsgenie integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

pagerduty

\n
\n

object

\n

A PagerDuty integration schema.

\n
\n
\n
\n
\n
\n

serviceURL [required]

\n
\n

string

\n

The service URL for the PagerDuty integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of Entity V3 Service Kind object. \nAllowed enum values: service

\n
\n \n
\n
\n
\n
\n
\n

metadata [required]

\n
\n

object

\n

The definition of Entity V3 Metadata object.

\n
\n
\n
\n
\n
\n

additionalOwners

\n
\n

[object]

\n

The additional owners of the entity, usually a team.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Team name.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Team type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

contacts

\n
\n

[object]

\n

A list of contacts for the entity.

\n
\n
\n
\n
\n
\n

contact [required]

\n
\n

string

\n

Contact value.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Contact name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Contact type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Short description of the entity. The UI can leverage the description for display.

\n
\n \n
\n
\n
\n
\n
\n

displayName

\n
\n

string

\n

User friendly name of the entity. The UI can leverage the display name for display.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored.

\n
\n \n
\n
\n
\n
\n
\n

inheritFrom

\n
\n

string

\n

The entity reference from which to inherit metadata

\n
\n \n
\n
\n
\n
\n
\n

links

\n
\n

[object]

\n

A list of links for the entity.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Link name.

\n
\n \n
\n
\n
\n
\n
\n

provider

\n
\n

string

\n

Link provider.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Link type.

default: other

\n
\n \n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

Link URL.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

managed

\n
\n

object

\n

A read-only set of Datadog managed attributes generated by Datadog. User supplied values are ignored.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Unique name given to an entity under the kind/namespace.

\n
\n \n
\n
\n
\n
\n
\n

namespace

\n
\n

string

\n

Namespace is a part of unique identifier. It has a default value of 'default'.

\n
\n \n
\n
\n
\n
\n
\n

owner

\n
\n

string

\n

The owner of the entity, usually a team.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A set of custom tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

spec

\n
\n

object

\n

The definition of Entity V3 Service Spec object.

\n
\n
\n
\n
\n
\n

componentOf

\n
\n

[string]

\n

A list of components the service is a part of

\n
\n \n
\n
\n
\n
\n
\n

dependsOn

\n
\n

[string]

\n

A list of components the service depends on.

\n
\n \n
\n
\n
\n
\n
\n

languages

\n
\n

[string]

\n

The service's programming language.

\n
\n \n
\n
\n
\n
\n
\n

lifecycle

\n
\n

string

\n

The lifecycle state of the component.

\n
\n \n
\n
\n
\n
\n
\n

tier

\n
\n

string

\n

The importance of the component.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

The type of service.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Schema for datastore entities.

\n
\n
\n
\n
\n
\n

apiVersion [required]

\n
\n

enum

\n

The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version. \nAllowed enum values: v3,v2.2,v2.1,v2

\n
\n \n
\n
\n
\n
\n
\n

datadog

\n
\n

object

\n

Datadog product integrations for the datastore entity.

\n
\n
\n
\n
\n
\n

events

\n
\n

[object]

\n

Events associations.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The query to run.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

logs

\n
\n

[object]

\n

Logs association.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The query to run.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

performanceData

\n
\n

object

\n

Performance stats association.

\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A list of APM entity tags that associates the APM Stats data with the entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

extensions

\n
\n

object

\n

Custom extensions. This is the free-formed field to send client side metadata. No Datadog features are affected by this field.

\n
\n \n
\n
\n
\n
\n
\n

integrations

\n
\n

object

\n

A base schema for defining third-party integrations.

\n
\n
\n
\n
\n
\n

opsgenie

\n
\n

object

\n

An Opsgenie integration schema.

\n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

The region for the Opsgenie integration.

\n
\n \n
\n
\n
\n
\n
\n

serviceURL [required]

\n
\n

string

\n

The service URL for the Opsgenie integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

pagerduty

\n
\n

object

\n

A PagerDuty integration schema.

\n
\n
\n
\n
\n
\n

serviceURL [required]

\n
\n

string

\n

The service URL for the PagerDuty integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of Entity V3 Datastore Kind object. \nAllowed enum values: datastore

\n
\n \n
\n
\n
\n
\n
\n

metadata [required]

\n
\n

object

\n

The definition of Entity V3 Metadata object.

\n
\n
\n
\n
\n
\n

additionalOwners

\n
\n

[object]

\n

The additional owners of the entity, usually a team.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Team name.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Team type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

contacts

\n
\n

[object]

\n

A list of contacts for the entity.

\n
\n
\n
\n
\n
\n

contact [required]

\n
\n

string

\n

Contact value.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Contact name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Contact type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Short description of the entity. The UI can leverage the description for display.

\n
\n \n
\n
\n
\n
\n
\n

displayName

\n
\n

string

\n

User friendly name of the entity. The UI can leverage the display name for display.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored.

\n
\n \n
\n
\n
\n
\n
\n

inheritFrom

\n
\n

string

\n

The entity reference from which to inherit metadata

\n
\n \n
\n
\n
\n
\n
\n

links

\n
\n

[object]

\n

A list of links for the entity.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Link name.

\n
\n \n
\n
\n
\n
\n
\n

provider

\n
\n

string

\n

Link provider.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Link type.

default: other

\n
\n \n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

Link URL.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

managed

\n
\n

object

\n

A read-only set of Datadog managed attributes generated by Datadog. User supplied values are ignored.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Unique name given to an entity under the kind/namespace.

\n
\n \n
\n
\n
\n
\n
\n

namespace

\n
\n

string

\n

Namespace is a part of unique identifier. It has a default value of 'default'.

\n
\n \n
\n
\n
\n
\n
\n

owner

\n
\n

string

\n

The owner of the entity, usually a team.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A set of custom tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

spec

\n
\n

object

\n

The definition of Entity V3 Datastore Spec object.

\n
\n
\n
\n
\n
\n

componentOf

\n
\n

[string]

\n

A list of components the datastore is a part of

\n
\n \n
\n
\n
\n
\n
\n

lifecycle

\n
\n

string

\n

The lifecycle state of the datastore.

\n
\n \n
\n
\n
\n
\n
\n

tier

\n
\n

string

\n

The importance of the datastore.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

The type of datastore.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Schema for queue entities.

\n
\n
\n
\n
\n
\n

apiVersion [required]

\n
\n

enum

\n

The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version. \nAllowed enum values: v3,v2.2,v2.1,v2

\n
\n \n
\n
\n
\n
\n
\n

datadog

\n
\n

object

\n

Datadog product integrations for the datastore entity.

\n
\n
\n
\n
\n
\n

events

\n
\n

[object]

\n

Events associations.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The query to run.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

logs

\n
\n

[object]

\n

Logs association.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The query to run.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

performanceData

\n
\n

object

\n

Performance stats association.

\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A list of APM entity tags that associates the APM Stats data with the entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

extensions

\n
\n

object

\n

Custom extensions. This is the free-formed field to send client-side metadata. No Datadog features are affected by this field.

\n
\n \n
\n
\n
\n
\n
\n

integrations

\n
\n

object

\n

A base schema for defining third-party integrations.

\n
\n
\n
\n
\n
\n

opsgenie

\n
\n

object

\n

An Opsgenie integration schema.

\n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

The region for the Opsgenie integration.

\n
\n \n
\n
\n
\n
\n
\n

serviceURL [required]

\n
\n

string

\n

The service URL for the Opsgenie integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

pagerduty

\n
\n

object

\n

A PagerDuty integration schema.

\n
\n
\n
\n
\n
\n

serviceURL [required]

\n
\n

string

\n

The service URL for the PagerDuty integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of Entity V3 Queue Kind object. \nAllowed enum values: queue

\n
\n \n
\n
\n
\n
\n
\n

metadata [required]

\n
\n

object

\n

The definition of Entity V3 Metadata object.

\n
\n
\n
\n
\n
\n

additionalOwners

\n
\n

[object]

\n

The additional owners of the entity, usually a team.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Team name.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Team type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

contacts

\n
\n

[object]

\n

A list of contacts for the entity.

\n
\n
\n
\n
\n
\n

contact [required]

\n
\n

string

\n

Contact value.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Contact name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Contact type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Short description of the entity. The UI can leverage the description for display.

\n
\n \n
\n
\n
\n
\n
\n

displayName

\n
\n

string

\n

User friendly name of the entity. The UI can leverage the display name for display.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored.

\n
\n \n
\n
\n
\n
\n
\n

inheritFrom

\n
\n

string

\n

The entity reference from which to inherit metadata

\n
\n \n
\n
\n
\n
\n
\n

links

\n
\n

[object]

\n

A list of links for the entity.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Link name.

\n
\n \n
\n
\n
\n
\n
\n

provider

\n
\n

string

\n

Link provider.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Link type.

default: other

\n
\n \n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

Link URL.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

managed

\n
\n

object

\n

A read-only set of Datadog managed attributes generated by Datadog. User supplied values are ignored.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Unique name given to an entity under the kind/namespace.

\n
\n \n
\n
\n
\n
\n
\n

namespace

\n
\n

string

\n

Namespace is a part of unique identifier. It has a default value of 'default'.

\n
\n \n
\n
\n
\n
\n
\n

owner

\n
\n

string

\n

The owner of the entity, usually a team.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A set of custom tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

spec

\n
\n

object

\n

The definition of Entity V3 Queue Spec object.

\n
\n
\n
\n
\n
\n

componentOf

\n
\n

[string]

\n

A list of components the queue is a part of

\n
\n \n
\n
\n
\n
\n
\n

lifecycle

\n
\n

string

\n

The lifecycle state of the queue.

\n
\n \n
\n
\n
\n
\n
\n

tier

\n
\n

string

\n

The importance of the queue.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

The type of queue.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Schema for system entities.

\n
\n
\n
\n
\n
\n

apiVersion [required]

\n
\n

enum

\n

The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version. \nAllowed enum values: v3,v2.2,v2.1,v2

\n
\n \n
\n
\n
\n
\n
\n

datadog

\n
\n

object

\n

Datadog product integrations for the service entity.

\n
\n
\n
\n
\n
\n

events

\n
\n

[object]

\n

Events associations.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The query to run.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

logs

\n
\n

[object]

\n

Logs association.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The query to run.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

performanceData

\n
\n

object

\n

Performance stats association.

\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A list of APM entity tags that associates the APM Stats data with the entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

pipelines

\n
\n

object

\n

CI Pipelines association.

\n
\n
\n
\n
\n
\n

fingerprints

\n
\n

[string]

\n

A list of CI Fingerprints that associate CI Pipelines with the entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

extensions

\n
\n

object

\n

Custom extensions. This is the free-formed field to send client-side metadata. No Datadog features are affected by this field.

\n
\n \n
\n
\n
\n
\n
\n

integrations

\n
\n

object

\n

A base schema for defining third-party integrations.

\n
\n
\n
\n
\n
\n

opsgenie

\n
\n

object

\n

An Opsgenie integration schema.

\n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

The region for the Opsgenie integration.

\n
\n \n
\n
\n
\n
\n
\n

serviceURL [required]

\n
\n

string

\n

The service URL for the Opsgenie integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

pagerduty

\n
\n

object

\n

A PagerDuty integration schema.

\n
\n
\n
\n
\n
\n

serviceURL [required]

\n
\n

string

\n

The service URL for the PagerDuty integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of Entity V3 System Kind object. \nAllowed enum values: system

\n
\n \n
\n
\n
\n
\n
\n

metadata [required]

\n
\n

object

\n

The definition of Entity V3 Metadata object.

\n
\n
\n
\n
\n
\n

additionalOwners

\n
\n

[object]

\n

The additional owners of the entity, usually a team.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Team name.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Team type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

contacts

\n
\n

[object]

\n

A list of contacts for the entity.

\n
\n
\n
\n
\n
\n

contact [required]

\n
\n

string

\n

Contact value.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Contact name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Contact type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Short description of the entity. The UI can leverage the description for display.

\n
\n \n
\n
\n
\n
\n
\n

displayName

\n
\n

string

\n

User friendly name of the entity. The UI can leverage the display name for display.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored.

\n
\n \n
\n
\n
\n
\n
\n

inheritFrom

\n
\n

string

\n

The entity reference from which to inherit metadata

\n
\n \n
\n
\n
\n
\n
\n

links

\n
\n

[object]

\n

A list of links for the entity.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Link name.

\n
\n \n
\n
\n
\n
\n
\n

provider

\n
\n

string

\n

Link provider.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Link type.

default: other

\n
\n \n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

Link URL.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

managed

\n
\n

object

\n

A read-only set of Datadog managed attributes generated by Datadog. User supplied values are ignored.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Unique name given to an entity under the kind/namespace.

\n
\n \n
\n
\n
\n
\n
\n

namespace

\n
\n

string

\n

Namespace is a part of unique identifier. It has a default value of 'default'.

\n
\n \n
\n
\n
\n
\n
\n

owner

\n
\n

string

\n

The owner of the entity, usually a team.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A set of custom tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

spec

\n
\n

object

\n

The definition of Entity V3 System Spec object.

\n
\n
\n
\n
\n
\n

components

\n
\n

[string]

\n

A list of components belongs to the system.

\n
\n \n
\n
\n
\n
\n
\n

lifecycle

\n
\n

string

\n

The lifecycle state of the component.

\n
\n \n
\n
\n
\n
\n
\n

tier

\n
\n

string

\n

An entity reference to the owner of the component.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Schema for API entities.

\n
\n
\n
\n
\n
\n

apiVersion [required]

\n
\n

enum

\n

The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version. \nAllowed enum values: v3,v2.2,v2.1,v2

\n
\n \n
\n
\n
\n
\n
\n

datadog

\n
\n

object

\n

Datadog product integrations for the API entity.

\n
\n
\n
\n
\n
\n

codeLocations

\n
\n

[object]

\n

Schema for mapping source code locations to an entity.

\n
\n
\n
\n
\n
\n

paths

\n
\n

[string]

\n

The paths (glob) to the source code of the service.

\n
\n \n
\n
\n
\n
\n
\n

repositoryURL

\n
\n

string

\n

The repository path of the source code of the entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

events

\n
\n

[object]

\n

Events associations.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The query to run.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

logs

\n
\n

[object]

\n

Logs association.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The query to run.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

performanceData

\n
\n

object

\n

Performance stats association.

\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A list of APM entity tags that associates the APM Stats data with the entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

pipelines

\n
\n

object

\n

CI Pipelines association.

\n
\n
\n
\n
\n
\n

fingerprints

\n
\n

[string]

\n

A list of CI Fingerprints that associate CI Pipelines with the entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

extensions

\n
\n

object

\n

Custom extensions. This is the free-formed field to send client-side metadata. No Datadog features are affected by this field.

\n
\n \n
\n
\n
\n
\n
\n

integrations

\n
\n

object

\n

A base schema for defining third-party integrations.

\n
\n
\n
\n
\n
\n

opsgenie

\n
\n

object

\n

An Opsgenie integration schema.

\n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

The region for the Opsgenie integration.

\n
\n \n
\n
\n
\n
\n
\n

serviceURL [required]

\n
\n

string

\n

The service URL for the Opsgenie integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

pagerduty

\n
\n

object

\n

A PagerDuty integration schema.

\n
\n
\n
\n
\n
\n

serviceURL [required]

\n
\n

string

\n

The service URL for the PagerDuty integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of Entity V3 API Kind object. \nAllowed enum values: api

\n
\n \n
\n
\n
\n
\n
\n

metadata [required]

\n
\n

object

\n

The definition of Entity V3 Metadata object.

\n
\n
\n
\n
\n
\n

additionalOwners

\n
\n

[object]

\n

The additional owners of the entity, usually a team.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Team name.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Team type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

contacts

\n
\n

[object]

\n

A list of contacts for the entity.

\n
\n
\n
\n
\n
\n

contact [required]

\n
\n

string

\n

Contact value.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Contact name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Contact type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Short description of the entity. The UI can leverage the description for display.

\n
\n \n
\n
\n
\n
\n
\n

displayName

\n
\n

string

\n

User friendly name of the entity. The UI can leverage the display name for display.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored.

\n
\n \n
\n
\n
\n
\n
\n

inheritFrom

\n
\n

string

\n

The entity reference from which to inherit metadata

\n
\n \n
\n
\n
\n
\n
\n

links

\n
\n

[object]

\n

A list of links for the entity.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Link name.

\n
\n \n
\n
\n
\n
\n
\n

provider

\n
\n

string

\n

Link provider.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Link type.

default: other

\n
\n \n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

Link URL.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

managed

\n
\n

object

\n

A read-only set of Datadog managed attributes generated by Datadog. User supplied values are ignored.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Unique name given to an entity under the kind/namespace.

\n
\n \n
\n
\n
\n
\n
\n

namespace

\n
\n

string

\n

Namespace is a part of unique identifier. It has a default value of 'default'.

\n
\n \n
\n
\n
\n
\n
\n

owner

\n
\n

string

\n

The owner of the entity, usually a team.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A set of custom tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

spec

\n
\n

object

\n

The definition of Entity V3 API Spec object.

\n
\n
\n
\n
\n
\n

implementedBy

\n
\n

[string]

\n

Services which implemented the API.

\n
\n \n
\n
\n
\n
\n
\n

interface

\n
\n

 <oneOf>

\n

The API definition.

\n
\n \n
\n
\n
\n
\n
\n

lifecycle

\n
\n

string

\n

The lifecycle state of the component.

\n
\n \n
\n
\n
\n
\n
\n

tier

\n
\n

string

\n

The importance of the component.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

The type of API.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Entity ID.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Schema type. \nAllowed enum values: schema

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Included raw schema.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Included raw schema attributes.

\n
\n
\n
\n
\n
\n

rawSchema

\n
\n

string

\n

Schema from user input in base64 encoding.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Raw schema ID.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Raw schema type. \nAllowed enum values: rawSchema

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Included related entity.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Related entity attributes.

\n
\n
\n
\n
\n
\n

kind

\n
\n

string

\n

Entity kind.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Entity name.

\n
\n \n
\n
\n
\n
\n
\n

namespace

\n
\n

string

\n

Entity namespace.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Entity relation type to the associated entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Entity UUID.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Included related entity meta.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

Entity creation time.

\n
\n \n
\n
\n
\n
\n
\n

defined_by

\n
\n

string

\n

Entity relation defined by.

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt

\n
\n

date-time

\n

Entity modification time.

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

string

\n

Entity relation source.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Related entity. \nAllowed enum values: relatedEntity

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Included oncall.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Included related oncall attributes.

\n
\n
\n
\n
\n
\n

escalations

\n
\n

[object]

\n

Oncall escalations.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Oncall email.

\n
\n \n
\n
\n
\n
\n
\n

escalationLevel

\n
\n

int64

\n

Oncall level.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Oncall name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

provider

\n
\n

string

\n

Oncall provider.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Oncall ID.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Oncall type. \nAllowed enum values: oncall

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Included incident.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Incident attributes.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

Incident creation time.

\n
\n \n
\n
\n
\n
\n
\n

htmlURL

\n
\n

string

\n

Incident URL.

\n
\n \n
\n
\n
\n
\n
\n

provider

\n
\n

string

\n

Incident provider.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Incident status.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Incident title.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Incident ID.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Incident description. \nAllowed enum values: incident

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

List entity response links.

\n
\n
\n
\n
\n
\n

next

\n
\n

string

\n

Next link.

\n
\n \n
\n
\n
\n
\n
\n

previous

\n
\n

string

\n

Previous link.

\n
\n \n
\n
\n
\n
\n
\n

self

\n
\n

string

\n

Current link.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Entity metadata.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

Total entities count.

\n
\n \n
\n
\n
\n
\n
\n

includeCount

\n
\n

int64

\n

Total included data count.

\n
\n \n
\n
\n
\n
" }, "403": { "json": { @@ -349,7 +349,7 @@ "includeCount": "integer" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

List of entity data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Entity attributes.

\n
\n
\n
\n
\n
\n

apiVersion

\n
\n

string

\n

The API version.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The description.

\n
\n \n
\n
\n
\n
\n
\n

displayName

\n
\n

string

\n

The display name.

\n
\n \n
\n
\n
\n
\n
\n

kind

\n
\n

string

\n

The kind.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name.

\n
\n \n
\n
\n
\n
\n
\n

namespace

\n
\n

string

\n

The namespace.

\n
\n \n
\n
\n
\n
\n
\n

owner

\n
\n

string

\n

The owner.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

The tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Entity ID.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Entity metadata.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

string

\n

The creation time.

\n
\n \n
\n
\n
\n
\n
\n

ingestionSource

\n
\n

string

\n

The ingestion source.

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt

\n
\n

string

\n

The modification time.

\n
\n \n
\n
\n
\n
\n
\n

origin

\n
\n

string

\n

The origin.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Entity relationships.

\n
\n
\n
\n
\n
\n

incidents

\n
\n

object

\n

Entity to incidents relationship.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Relationships.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Associated data ID.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Relationship type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

oncall

\n
\n

object

\n

Entity to oncalls relationship.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Relationships.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Associated data ID.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Relationship type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

rawSchema

\n
\n

object

\n

Entity to raw schema relationship.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Relationship entry.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Associated data ID.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Relationship type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

relatedEntities

\n
\n

object

\n

Entity to related entities relationship.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Relationships.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Associated data ID.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Relationship type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

schema

\n
\n

object

\n

Entity to detail schema relationship.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Relationship entry.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Associated data ID.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Relationship type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Upsert entity response included.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Included detail entity schema.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Included schema.

\n
\n
\n
\n
\n
\n

schema

\n
\n

 <oneOf>

\n

Entity schema v3.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Schema for service entities.

\n
\n
\n
\n
\n
\n

apiVersion [required]

\n
\n

enum

\n

The schema version of entity type. The field is known as schema-version in the previous version. \nAllowed enum values: v3

\n
\n \n
\n
\n
\n
\n
\n

datadog

\n
\n

object

\n

Datadog product integrations for the service entity.

\n
\n
\n
\n
\n
\n

codeLocations

\n
\n

[object]

\n

Schema for mapping source code locations to an entity.

\n
\n
\n
\n
\n
\n

paths

\n
\n

[string]

\n

The paths (glob) to the source code of the service.

\n
\n \n
\n
\n
\n
\n
\n

repositoryURL

\n
\n

string

\n

The repository path of the source code of the entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

events

\n
\n

[object]

\n

Events associations.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The query to run.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

logs

\n
\n

[object]

\n

Logs association.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The query to run.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

performanceData

\n
\n

object

\n

Performance stats association.

\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A list of APM entity tags that associates the APM Stats data with the entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

pipelines

\n
\n

object

\n

CI Pipelines association.

\n
\n
\n
\n
\n
\n

fingerprints

\n
\n

[string]

\n

A list of CI Fingerprints that associate CI Pipelines with the entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

extensions

\n
\n

object

\n

Custom extensions. This is the free-formed field to send client-side metadata. No Datadog features are affected by this field.

\n
\n \n
\n
\n
\n
\n
\n

integrations

\n
\n

object

\n

A base schema for defining third-party integrations.

\n
\n
\n
\n
\n
\n

opsgenie

\n
\n

object

\n

An Opsgenie integration schema.

\n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

The region for the Opsgenie integration.

\n
\n \n
\n
\n
\n
\n
\n

serviceURL [required]

\n
\n

string

\n

The service URL for the Opsgenie integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

pagerduty

\n
\n

object

\n

A PagerDuty integration schema.

\n
\n
\n
\n
\n
\n

serviceURL [required]

\n
\n

string

\n

The service URL for the PagerDuty integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of Entity V3 Service Kind object. \nAllowed enum values: service

\n
\n \n
\n
\n
\n
\n
\n

metadata [required]

\n
\n

object

\n

The definition of Entity V3 Metadata object.

\n
\n
\n
\n
\n
\n

additionalOwners

\n
\n

[object]

\n

The additional owners of the entity, usually a team.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Team name.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Team type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

contacts

\n
\n

[object]

\n

A list of contacts for the entity.

\n
\n
\n
\n
\n
\n

contact [required]

\n
\n

string

\n

Contact value.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Contact name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Contact type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Short description of the entity. The UI can leverage the description for display.

\n
\n \n
\n
\n
\n
\n
\n

displayName

\n
\n

string

\n

User friendly name of the entity. The UI can leverage the display name for display.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored.

\n
\n \n
\n
\n
\n
\n
\n

inheritFrom

\n
\n

string

\n

The entity reference from which to inherit metadata

\n
\n \n
\n
\n
\n
\n
\n

links

\n
\n

[object]

\n

A list of links for the entity.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Link name.

\n
\n \n
\n
\n
\n
\n
\n

provider

\n
\n

string

\n

Link provider.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Link type.

default: other

\n
\n \n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

Link URL.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

managed

\n
\n

object

\n

A read-only set of Datadog managed attributes generated by Datadog. User supplied values are ignored.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Unique name given to an entity under the kind/namespace.

\n
\n \n
\n
\n
\n
\n
\n

namespace

\n
\n

string

\n

Namespace is a part of unique identifier. It has a default value of 'default'.

\n
\n \n
\n
\n
\n
\n
\n

owner

\n
\n

string

\n

The owner of the entity, usually a team.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A set of custom tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

spec

\n
\n

object

\n

The definition of Entity V3 Service Spec object.

\n
\n
\n
\n
\n
\n

componentOf

\n
\n

[string]

\n

A list of components the service is a part of

\n
\n \n
\n
\n
\n
\n
\n

dependsOn

\n
\n

[string]

\n

A list of components the service depends on.

\n
\n \n
\n
\n
\n
\n
\n

languages

\n
\n

[string]

\n

The service's programming language.

\n
\n \n
\n
\n
\n
\n
\n

lifecycle

\n
\n

string

\n

The lifecycle state of the component.

\n
\n \n
\n
\n
\n
\n
\n

tier

\n
\n

string

\n

The importance of the component.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

The type of service.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Schema for datastore entities.

\n
\n
\n
\n
\n
\n

apiVersion [required]

\n
\n

enum

\n

The schema version of entity type. The field is known as schema-version in the previous version. \nAllowed enum values: v3

\n
\n \n
\n
\n
\n
\n
\n

datadog

\n
\n

object

\n

Datadog product integrations for the datastore entity.

\n
\n
\n
\n
\n
\n

events

\n
\n

[object]

\n

Events associations.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The query to run.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

logs

\n
\n

[object]

\n

Logs association.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The query to run.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

performanceData

\n
\n

object

\n

Performance stats association.

\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A list of APM entity tags that associates the APM Stats data with the entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

extensions

\n
\n

object

\n

Custom extensions. This is the free-formed field to send client side metadata. No Datadog features are affected by this field.

\n
\n \n
\n
\n
\n
\n
\n

integrations

\n
\n

object

\n

A base schema for defining third-party integrations.

\n
\n
\n
\n
\n
\n

opsgenie

\n
\n

object

\n

An Opsgenie integration schema.

\n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

The region for the Opsgenie integration.

\n
\n \n
\n
\n
\n
\n
\n

serviceURL [required]

\n
\n

string

\n

The service URL for the Opsgenie integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

pagerduty

\n
\n

object

\n

A PagerDuty integration schema.

\n
\n
\n
\n
\n
\n

serviceURL [required]

\n
\n

string

\n

The service URL for the PagerDuty integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of Entity V3 Datastore Kind object. \nAllowed enum values: datastore

\n
\n \n
\n
\n
\n
\n
\n

metadata [required]

\n
\n

object

\n

The definition of Entity V3 Metadata object.

\n
\n
\n
\n
\n
\n

additionalOwners

\n
\n

[object]

\n

The additional owners of the entity, usually a team.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Team name.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Team type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

contacts

\n
\n

[object]

\n

A list of contacts for the entity.

\n
\n
\n
\n
\n
\n

contact [required]

\n
\n

string

\n

Contact value.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Contact name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Contact type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Short description of the entity. The UI can leverage the description for display.

\n
\n \n
\n
\n
\n
\n
\n

displayName

\n
\n

string

\n

User friendly name of the entity. The UI can leverage the display name for display.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored.

\n
\n \n
\n
\n
\n
\n
\n

inheritFrom

\n
\n

string

\n

The entity reference from which to inherit metadata

\n
\n \n
\n
\n
\n
\n
\n

links

\n
\n

[object]

\n

A list of links for the entity.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Link name.

\n
\n \n
\n
\n
\n
\n
\n

provider

\n
\n

string

\n

Link provider.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Link type.

default: other

\n
\n \n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

Link URL.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

managed

\n
\n

object

\n

A read-only set of Datadog managed attributes generated by Datadog. User supplied values are ignored.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Unique name given to an entity under the kind/namespace.

\n
\n \n
\n
\n
\n
\n
\n

namespace

\n
\n

string

\n

Namespace is a part of unique identifier. It has a default value of 'default'.

\n
\n \n
\n
\n
\n
\n
\n

owner

\n
\n

string

\n

The owner of the entity, usually a team.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A set of custom tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

spec

\n
\n

object

\n

The definition of Entity V3 Datastore Spec object.

\n
\n
\n
\n
\n
\n

componentOf

\n
\n

[string]

\n

A list of components the datastore is a part of

\n
\n \n
\n
\n
\n
\n
\n

lifecycle

\n
\n

string

\n

The lifecycle state of the datastore.

\n
\n \n
\n
\n
\n
\n
\n

tier

\n
\n

string

\n

The importance of the datastore.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

The type of datastore.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Schema for queue entities.

\n
\n
\n
\n
\n
\n

apiVersion [required]

\n
\n

enum

\n

The schema version of entity type. The field is known as schema-version in the previous version. \nAllowed enum values: v3

\n
\n \n
\n
\n
\n
\n
\n

datadog

\n
\n

object

\n

Datadog product integrations for the datastore entity.

\n
\n
\n
\n
\n
\n

events

\n
\n

[object]

\n

Events associations.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The query to run.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

logs

\n
\n

[object]

\n

Logs association.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The query to run.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

performanceData

\n
\n

object

\n

Performance stats association.

\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A list of APM entity tags that associates the APM Stats data with the entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

extensions

\n
\n

object

\n

Custom extensions. This is the free-formed field to send client-side metadata. No Datadog features are affected by this field.

\n
\n \n
\n
\n
\n
\n
\n

integrations

\n
\n

object

\n

A base schema for defining third-party integrations.

\n
\n
\n
\n
\n
\n

opsgenie

\n
\n

object

\n

An Opsgenie integration schema.

\n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

The region for the Opsgenie integration.

\n
\n \n
\n
\n
\n
\n
\n

serviceURL [required]

\n
\n

string

\n

The service URL for the Opsgenie integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

pagerduty

\n
\n

object

\n

A PagerDuty integration schema.

\n
\n
\n
\n
\n
\n

serviceURL [required]

\n
\n

string

\n

The service URL for the PagerDuty integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of Entity V3 Queue Kind object. \nAllowed enum values: queue

\n
\n \n
\n
\n
\n
\n
\n

metadata [required]

\n
\n

object

\n

The definition of Entity V3 Metadata object.

\n
\n
\n
\n
\n
\n

additionalOwners

\n
\n

[object]

\n

The additional owners of the entity, usually a team.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Team name.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Team type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

contacts

\n
\n

[object]

\n

A list of contacts for the entity.

\n
\n
\n
\n
\n
\n

contact [required]

\n
\n

string

\n

Contact value.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Contact name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Contact type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Short description of the entity. The UI can leverage the description for display.

\n
\n \n
\n
\n
\n
\n
\n

displayName

\n
\n

string

\n

User friendly name of the entity. The UI can leverage the display name for display.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored.

\n
\n \n
\n
\n
\n
\n
\n

inheritFrom

\n
\n

string

\n

The entity reference from which to inherit metadata

\n
\n \n
\n
\n
\n
\n
\n

links

\n
\n

[object]

\n

A list of links for the entity.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Link name.

\n
\n \n
\n
\n
\n
\n
\n

provider

\n
\n

string

\n

Link provider.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Link type.

default: other

\n
\n \n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

Link URL.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

managed

\n
\n

object

\n

A read-only set of Datadog managed attributes generated by Datadog. User supplied values are ignored.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Unique name given to an entity under the kind/namespace.

\n
\n \n
\n
\n
\n
\n
\n

namespace

\n
\n

string

\n

Namespace is a part of unique identifier. It has a default value of 'default'.

\n
\n \n
\n
\n
\n
\n
\n

owner

\n
\n

string

\n

The owner of the entity, usually a team.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A set of custom tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

spec

\n
\n

object

\n

The definition of Entity V3 Queue Spec object.

\n
\n
\n
\n
\n
\n

componentOf

\n
\n

[string]

\n

A list of components the queue is a part of

\n
\n \n
\n
\n
\n
\n
\n

lifecycle

\n
\n

string

\n

The lifecycle state of the queue.

\n
\n \n
\n
\n
\n
\n
\n

tier

\n
\n

string

\n

The importance of the queue.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

The type of queue.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Schema for system entities.

\n
\n
\n
\n
\n
\n

apiVersion [required]

\n
\n

enum

\n

The schema version of entity type. The field is known as schema-version in the previous version. \nAllowed enum values: v3

\n
\n \n
\n
\n
\n
\n
\n

datadog

\n
\n

object

\n

Datadog product integrations for the service entity.

\n
\n
\n
\n
\n
\n

events

\n
\n

[object]

\n

Events associations.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The query to run.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

logs

\n
\n

[object]

\n

Logs association.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The query to run.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

performanceData

\n
\n

object

\n

Performance stats association.

\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A list of APM entity tags that associates the APM Stats data with the entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

pipelines

\n
\n

object

\n

CI Pipelines association.

\n
\n
\n
\n
\n
\n

fingerprints

\n
\n

[string]

\n

A list of CI Fingerprints that associate CI Pipelines with the entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

extensions

\n
\n

object

\n

Custom extensions. This is the free-formed field to send client-side metadata. No Datadog features are affected by this field.

\n
\n \n
\n
\n
\n
\n
\n

integrations

\n
\n

object

\n

A base schema for defining third-party integrations.

\n
\n
\n
\n
\n
\n

opsgenie

\n
\n

object

\n

An Opsgenie integration schema.

\n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

The region for the Opsgenie integration.

\n
\n \n
\n
\n
\n
\n
\n

serviceURL [required]

\n
\n

string

\n

The service URL for the Opsgenie integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

pagerduty

\n
\n

object

\n

A PagerDuty integration schema.

\n
\n
\n
\n
\n
\n

serviceURL [required]

\n
\n

string

\n

The service URL for the PagerDuty integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of Entity V3 System Kind object. \nAllowed enum values: system

\n
\n \n
\n
\n
\n
\n
\n

metadata [required]

\n
\n

object

\n

The definition of Entity V3 Metadata object.

\n
\n
\n
\n
\n
\n

additionalOwners

\n
\n

[object]

\n

The additional owners of the entity, usually a team.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Team name.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Team type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

contacts

\n
\n

[object]

\n

A list of contacts for the entity.

\n
\n
\n
\n
\n
\n

contact [required]

\n
\n

string

\n

Contact value.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Contact name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Contact type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Short description of the entity. The UI can leverage the description for display.

\n
\n \n
\n
\n
\n
\n
\n

displayName

\n
\n

string

\n

User friendly name of the entity. The UI can leverage the display name for display.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored.

\n
\n \n
\n
\n
\n
\n
\n

inheritFrom

\n
\n

string

\n

The entity reference from which to inherit metadata

\n
\n \n
\n
\n
\n
\n
\n

links

\n
\n

[object]

\n

A list of links for the entity.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Link name.

\n
\n \n
\n
\n
\n
\n
\n

provider

\n
\n

string

\n

Link provider.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Link type.

default: other

\n
\n \n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

Link URL.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

managed

\n
\n

object

\n

A read-only set of Datadog managed attributes generated by Datadog. User supplied values are ignored.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Unique name given to an entity under the kind/namespace.

\n
\n \n
\n
\n
\n
\n
\n

namespace

\n
\n

string

\n

Namespace is a part of unique identifier. It has a default value of 'default'.

\n
\n \n
\n
\n
\n
\n
\n

owner

\n
\n

string

\n

The owner of the entity, usually a team.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A set of custom tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

spec

\n
\n

object

\n

The definition of Entity V3 System Spec object.

\n
\n
\n
\n
\n
\n

components

\n
\n

[string]

\n

A list of components belongs to the system.

\n
\n \n
\n
\n
\n
\n
\n

lifecycle

\n
\n

string

\n

The lifecycle state of the component.

\n
\n \n
\n
\n
\n
\n
\n

tier

\n
\n

string

\n

An entity reference to the owner of the component.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Schema for API entities.

\n
\n
\n
\n
\n
\n

apiVersion [required]

\n
\n

enum

\n

The schema version of entity type. The field is known as schema-version in the previous version. \nAllowed enum values: v3

\n
\n \n
\n
\n
\n
\n
\n

datadog

\n
\n

object

\n

Datadog product integrations for the API entity.

\n
\n
\n
\n
\n
\n

codeLocations

\n
\n

[object]

\n

Schema for mapping source code locations to an entity.

\n
\n
\n
\n
\n
\n

paths

\n
\n

[string]

\n

The paths (glob) to the source code of the service.

\n
\n \n
\n
\n
\n
\n
\n

repositoryURL

\n
\n

string

\n

The repository path of the source code of the entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

events

\n
\n

[object]

\n

Events associations.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The query to run.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

logs

\n
\n

[object]

\n

Logs association.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The query to run.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

performanceData

\n
\n

object

\n

Performance stats association.

\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A list of APM entity tags that associates the APM Stats data with the entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

pipelines

\n
\n

object

\n

CI Pipelines association.

\n
\n
\n
\n
\n
\n

fingerprints

\n
\n

[string]

\n

A list of CI Fingerprints that associate CI Pipelines with the entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

extensions

\n
\n

object

\n

Custom extensions. This is the free-formed field to send client-side metadata. No Datadog features are affected by this field.

\n
\n \n
\n
\n
\n
\n
\n

integrations

\n
\n

object

\n

A base schema for defining third-party integrations.

\n
\n
\n
\n
\n
\n

opsgenie

\n
\n

object

\n

An Opsgenie integration schema.

\n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

The region for the Opsgenie integration.

\n
\n \n
\n
\n
\n
\n
\n

serviceURL [required]

\n
\n

string

\n

The service URL for the Opsgenie integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

pagerduty

\n
\n

object

\n

A PagerDuty integration schema.

\n
\n
\n
\n
\n
\n

serviceURL [required]

\n
\n

string

\n

The service URL for the PagerDuty integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of Entity V3 API Kind object. \nAllowed enum values: api

\n
\n \n
\n
\n
\n
\n
\n

metadata [required]

\n
\n

object

\n

The definition of Entity V3 Metadata object.

\n
\n
\n
\n
\n
\n

additionalOwners

\n
\n

[object]

\n

The additional owners of the entity, usually a team.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Team name.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Team type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

contacts

\n
\n

[object]

\n

A list of contacts for the entity.

\n
\n
\n
\n
\n
\n

contact [required]

\n
\n

string

\n

Contact value.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Contact name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Contact type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Short description of the entity. The UI can leverage the description for display.

\n
\n \n
\n
\n
\n
\n
\n

displayName

\n
\n

string

\n

User friendly name of the entity. The UI can leverage the display name for display.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored.

\n
\n \n
\n
\n
\n
\n
\n

inheritFrom

\n
\n

string

\n

The entity reference from which to inherit metadata

\n
\n \n
\n
\n
\n
\n
\n

links

\n
\n

[object]

\n

A list of links for the entity.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Link name.

\n
\n \n
\n
\n
\n
\n
\n

provider

\n
\n

string

\n

Link provider.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Link type.

default: other

\n
\n \n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

Link URL.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

managed

\n
\n

object

\n

A read-only set of Datadog managed attributes generated by Datadog. User supplied values are ignored.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Unique name given to an entity under the kind/namespace.

\n
\n \n
\n
\n
\n
\n
\n

namespace

\n
\n

string

\n

Namespace is a part of unique identifier. It has a default value of 'default'.

\n
\n \n
\n
\n
\n
\n
\n

owner

\n
\n

string

\n

The owner of the entity, usually a team.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A set of custom tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

spec

\n
\n

object

\n

The definition of Entity V3 API Spec object.

\n
\n
\n
\n
\n
\n

implementedBy

\n
\n

[string]

\n

Services which implemented the API.

\n
\n \n
\n
\n
\n
\n
\n

interface

\n
\n

 <oneOf>

\n

The API definition.

\n
\n \n
\n
\n
\n
\n
\n

lifecycle

\n
\n

string

\n

The lifecycle state of the component.

\n
\n \n
\n
\n
\n
\n
\n

tier

\n
\n

string

\n

The importance of the component.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

The type of API.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Entity ID.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Schema type. \nAllowed enum values: schema

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Entity metadata.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

Total entities count.

\n
\n \n
\n
\n
\n
\n
\n

includeCount

\n
\n

int64

\n

Total included data count.

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

List of entity data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Entity attributes.

\n
\n
\n
\n
\n
\n

apiVersion

\n
\n

string

\n

The API version.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The description.

\n
\n \n
\n
\n
\n
\n
\n

displayName

\n
\n

string

\n

The display name.

\n
\n \n
\n
\n
\n
\n
\n

kind

\n
\n

string

\n

The kind.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name.

\n
\n \n
\n
\n
\n
\n
\n

namespace

\n
\n

string

\n

The namespace.

\n
\n \n
\n
\n
\n
\n
\n

owner

\n
\n

string

\n

The owner.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

The tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Entity ID.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Entity metadata.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

string

\n

The creation time.

\n
\n \n
\n
\n
\n
\n
\n

ingestionSource

\n
\n

string

\n

The ingestion source.

\n
\n \n
\n
\n
\n
\n
\n

modifiedAt

\n
\n

string

\n

The modification time.

\n
\n \n
\n
\n
\n
\n
\n

origin

\n
\n

string

\n

The origin.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Entity relationships.

\n
\n
\n
\n
\n
\n

incidents

\n
\n

object

\n

Entity to incidents relationship.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Relationships.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Associated data ID.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Relationship type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

oncall

\n
\n

object

\n

Entity to oncalls relationship.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Relationships.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Associated data ID.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Relationship type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

rawSchema

\n
\n

object

\n

Entity to raw schema relationship.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Relationship entry.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Associated data ID.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Relationship type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

relatedEntities

\n
\n

object

\n

Entity to related entities relationship.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Relationships.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Associated data ID.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Relationship type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

schema

\n
\n

object

\n

Entity to detail schema relationship.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Relationship entry.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Associated data ID.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Relationship type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Upsert entity response included.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Included detail entity schema.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Included schema.

\n
\n
\n
\n
\n
\n

schema

\n
\n

 <oneOf>

\n

Entity schema v3.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Schema for service entities.

\n
\n
\n
\n
\n
\n

apiVersion [required]

\n
\n

enum

\n

The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version. \nAllowed enum values: v3,v2.2,v2.1,v2

\n
\n \n
\n
\n
\n
\n
\n

datadog

\n
\n

object

\n

Datadog product integrations for the service entity.

\n
\n
\n
\n
\n
\n

codeLocations

\n
\n

[object]

\n

Schema for mapping source code locations to an entity.

\n
\n
\n
\n
\n
\n

paths

\n
\n

[string]

\n

The paths (glob) to the source code of the service.

\n
\n \n
\n
\n
\n
\n
\n

repositoryURL

\n
\n

string

\n

The repository path of the source code of the entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

events

\n
\n

[object]

\n

Events associations.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The query to run.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

logs

\n
\n

[object]

\n

Logs association.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The query to run.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

performanceData

\n
\n

object

\n

Performance stats association.

\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A list of APM entity tags that associates the APM Stats data with the entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

pipelines

\n
\n

object

\n

CI Pipelines association.

\n
\n
\n
\n
\n
\n

fingerprints

\n
\n

[string]

\n

A list of CI Fingerprints that associate CI Pipelines with the entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

extensions

\n
\n

object

\n

Custom extensions. This is the free-formed field to send client-side metadata. No Datadog features are affected by this field.

\n
\n \n
\n
\n
\n
\n
\n

integrations

\n
\n

object

\n

A base schema for defining third-party integrations.

\n
\n
\n
\n
\n
\n

opsgenie

\n
\n

object

\n

An Opsgenie integration schema.

\n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

The region for the Opsgenie integration.

\n
\n \n
\n
\n
\n
\n
\n

serviceURL [required]

\n
\n

string

\n

The service URL for the Opsgenie integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

pagerduty

\n
\n

object

\n

A PagerDuty integration schema.

\n
\n
\n
\n
\n
\n

serviceURL [required]

\n
\n

string

\n

The service URL for the PagerDuty integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of Entity V3 Service Kind object. \nAllowed enum values: service

\n
\n \n
\n
\n
\n
\n
\n

metadata [required]

\n
\n

object

\n

The definition of Entity V3 Metadata object.

\n
\n
\n
\n
\n
\n

additionalOwners

\n
\n

[object]

\n

The additional owners of the entity, usually a team.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Team name.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Team type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

contacts

\n
\n

[object]

\n

A list of contacts for the entity.

\n
\n
\n
\n
\n
\n

contact [required]

\n
\n

string

\n

Contact value.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Contact name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Contact type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Short description of the entity. The UI can leverage the description for display.

\n
\n \n
\n
\n
\n
\n
\n

displayName

\n
\n

string

\n

User friendly name of the entity. The UI can leverage the display name for display.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored.

\n
\n \n
\n
\n
\n
\n
\n

inheritFrom

\n
\n

string

\n

The entity reference from which to inherit metadata

\n
\n \n
\n
\n
\n
\n
\n

links

\n
\n

[object]

\n

A list of links for the entity.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Link name.

\n
\n \n
\n
\n
\n
\n
\n

provider

\n
\n

string

\n

Link provider.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Link type.

default: other

\n
\n \n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

Link URL.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

managed

\n
\n

object

\n

A read-only set of Datadog managed attributes generated by Datadog. User supplied values are ignored.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Unique name given to an entity under the kind/namespace.

\n
\n \n
\n
\n
\n
\n
\n

namespace

\n
\n

string

\n

Namespace is a part of unique identifier. It has a default value of 'default'.

\n
\n \n
\n
\n
\n
\n
\n

owner

\n
\n

string

\n

The owner of the entity, usually a team.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A set of custom tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

spec

\n
\n

object

\n

The definition of Entity V3 Service Spec object.

\n
\n
\n
\n
\n
\n

componentOf

\n
\n

[string]

\n

A list of components the service is a part of

\n
\n \n
\n
\n
\n
\n
\n

dependsOn

\n
\n

[string]

\n

A list of components the service depends on.

\n
\n \n
\n
\n
\n
\n
\n

languages

\n
\n

[string]

\n

The service's programming language.

\n
\n \n
\n
\n
\n
\n
\n

lifecycle

\n
\n

string

\n

The lifecycle state of the component.

\n
\n \n
\n
\n
\n
\n
\n

tier

\n
\n

string

\n

The importance of the component.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

The type of service.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Schema for datastore entities.

\n
\n
\n
\n
\n
\n

apiVersion [required]

\n
\n

enum

\n

The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version. \nAllowed enum values: v3,v2.2,v2.1,v2

\n
\n \n
\n
\n
\n
\n
\n

datadog

\n
\n

object

\n

Datadog product integrations for the datastore entity.

\n
\n
\n
\n
\n
\n

events

\n
\n

[object]

\n

Events associations.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The query to run.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

logs

\n
\n

[object]

\n

Logs association.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The query to run.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

performanceData

\n
\n

object

\n

Performance stats association.

\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A list of APM entity tags that associates the APM Stats data with the entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

extensions

\n
\n

object

\n

Custom extensions. This is the free-formed field to send client side metadata. No Datadog features are affected by this field.

\n
\n \n
\n
\n
\n
\n
\n

integrations

\n
\n

object

\n

A base schema for defining third-party integrations.

\n
\n
\n
\n
\n
\n

opsgenie

\n
\n

object

\n

An Opsgenie integration schema.

\n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

The region for the Opsgenie integration.

\n
\n \n
\n
\n
\n
\n
\n

serviceURL [required]

\n
\n

string

\n

The service URL for the Opsgenie integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

pagerduty

\n
\n

object

\n

A PagerDuty integration schema.

\n
\n
\n
\n
\n
\n

serviceURL [required]

\n
\n

string

\n

The service URL for the PagerDuty integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of Entity V3 Datastore Kind object. \nAllowed enum values: datastore

\n
\n \n
\n
\n
\n
\n
\n

metadata [required]

\n
\n

object

\n

The definition of Entity V3 Metadata object.

\n
\n
\n
\n
\n
\n

additionalOwners

\n
\n

[object]

\n

The additional owners of the entity, usually a team.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Team name.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Team type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

contacts

\n
\n

[object]

\n

A list of contacts for the entity.

\n
\n
\n
\n
\n
\n

contact [required]

\n
\n

string

\n

Contact value.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Contact name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Contact type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Short description of the entity. The UI can leverage the description for display.

\n
\n \n
\n
\n
\n
\n
\n

displayName

\n
\n

string

\n

User friendly name of the entity. The UI can leverage the display name for display.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored.

\n
\n \n
\n
\n
\n
\n
\n

inheritFrom

\n
\n

string

\n

The entity reference from which to inherit metadata

\n
\n \n
\n
\n
\n
\n
\n

links

\n
\n

[object]

\n

A list of links for the entity.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Link name.

\n
\n \n
\n
\n
\n
\n
\n

provider

\n
\n

string

\n

Link provider.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Link type.

default: other

\n
\n \n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

Link URL.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

managed

\n
\n

object

\n

A read-only set of Datadog managed attributes generated by Datadog. User supplied values are ignored.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Unique name given to an entity under the kind/namespace.

\n
\n \n
\n
\n
\n
\n
\n

namespace

\n
\n

string

\n

Namespace is a part of unique identifier. It has a default value of 'default'.

\n
\n \n
\n
\n
\n
\n
\n

owner

\n
\n

string

\n

The owner of the entity, usually a team.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A set of custom tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

spec

\n
\n

object

\n

The definition of Entity V3 Datastore Spec object.

\n
\n
\n
\n
\n
\n

componentOf

\n
\n

[string]

\n

A list of components the datastore is a part of

\n
\n \n
\n
\n
\n
\n
\n

lifecycle

\n
\n

string

\n

The lifecycle state of the datastore.

\n
\n \n
\n
\n
\n
\n
\n

tier

\n
\n

string

\n

The importance of the datastore.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

The type of datastore.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Schema for queue entities.

\n
\n
\n
\n
\n
\n

apiVersion [required]

\n
\n

enum

\n

The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version. \nAllowed enum values: v3,v2.2,v2.1,v2

\n
\n \n
\n
\n
\n
\n
\n

datadog

\n
\n

object

\n

Datadog product integrations for the datastore entity.

\n
\n
\n
\n
\n
\n

events

\n
\n

[object]

\n

Events associations.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The query to run.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

logs

\n
\n

[object]

\n

Logs association.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The query to run.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

performanceData

\n
\n

object

\n

Performance stats association.

\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A list of APM entity tags that associates the APM Stats data with the entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

extensions

\n
\n

object

\n

Custom extensions. This is the free-formed field to send client-side metadata. No Datadog features are affected by this field.

\n
\n \n
\n
\n
\n
\n
\n

integrations

\n
\n

object

\n

A base schema for defining third-party integrations.

\n
\n
\n
\n
\n
\n

opsgenie

\n
\n

object

\n

An Opsgenie integration schema.

\n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

The region for the Opsgenie integration.

\n
\n \n
\n
\n
\n
\n
\n

serviceURL [required]

\n
\n

string

\n

The service URL for the Opsgenie integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

pagerduty

\n
\n

object

\n

A PagerDuty integration schema.

\n
\n
\n
\n
\n
\n

serviceURL [required]

\n
\n

string

\n

The service URL for the PagerDuty integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of Entity V3 Queue Kind object. \nAllowed enum values: queue

\n
\n \n
\n
\n
\n
\n
\n

metadata [required]

\n
\n

object

\n

The definition of Entity V3 Metadata object.

\n
\n
\n
\n
\n
\n

additionalOwners

\n
\n

[object]

\n

The additional owners of the entity, usually a team.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Team name.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Team type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

contacts

\n
\n

[object]

\n

A list of contacts for the entity.

\n
\n
\n
\n
\n
\n

contact [required]

\n
\n

string

\n

Contact value.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Contact name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Contact type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Short description of the entity. The UI can leverage the description for display.

\n
\n \n
\n
\n
\n
\n
\n

displayName

\n
\n

string

\n

User friendly name of the entity. The UI can leverage the display name for display.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored.

\n
\n \n
\n
\n
\n
\n
\n

inheritFrom

\n
\n

string

\n

The entity reference from which to inherit metadata

\n
\n \n
\n
\n
\n
\n
\n

links

\n
\n

[object]

\n

A list of links for the entity.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Link name.

\n
\n \n
\n
\n
\n
\n
\n

provider

\n
\n

string

\n

Link provider.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Link type.

default: other

\n
\n \n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

Link URL.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

managed

\n
\n

object

\n

A read-only set of Datadog managed attributes generated by Datadog. User supplied values are ignored.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Unique name given to an entity under the kind/namespace.

\n
\n \n
\n
\n
\n
\n
\n

namespace

\n
\n

string

\n

Namespace is a part of unique identifier. It has a default value of 'default'.

\n
\n \n
\n
\n
\n
\n
\n

owner

\n
\n

string

\n

The owner of the entity, usually a team.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A set of custom tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

spec

\n
\n

object

\n

The definition of Entity V3 Queue Spec object.

\n
\n
\n
\n
\n
\n

componentOf

\n
\n

[string]

\n

A list of components the queue is a part of

\n
\n \n
\n
\n
\n
\n
\n

lifecycle

\n
\n

string

\n

The lifecycle state of the queue.

\n
\n \n
\n
\n
\n
\n
\n

tier

\n
\n

string

\n

The importance of the queue.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

The type of queue.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Schema for system entities.

\n
\n
\n
\n
\n
\n

apiVersion [required]

\n
\n

enum

\n

The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version. \nAllowed enum values: v3,v2.2,v2.1,v2

\n
\n \n
\n
\n
\n
\n
\n

datadog

\n
\n

object

\n

Datadog product integrations for the service entity.

\n
\n
\n
\n
\n
\n

events

\n
\n

[object]

\n

Events associations.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The query to run.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

logs

\n
\n

[object]

\n

Logs association.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The query to run.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

performanceData

\n
\n

object

\n

Performance stats association.

\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A list of APM entity tags that associates the APM Stats data with the entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

pipelines

\n
\n

object

\n

CI Pipelines association.

\n
\n
\n
\n
\n
\n

fingerprints

\n
\n

[string]

\n

A list of CI Fingerprints that associate CI Pipelines with the entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

extensions

\n
\n

object

\n

Custom extensions. This is the free-formed field to send client-side metadata. No Datadog features are affected by this field.

\n
\n \n
\n
\n
\n
\n
\n

integrations

\n
\n

object

\n

A base schema for defining third-party integrations.

\n
\n
\n
\n
\n
\n

opsgenie

\n
\n

object

\n

An Opsgenie integration schema.

\n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

The region for the Opsgenie integration.

\n
\n \n
\n
\n
\n
\n
\n

serviceURL [required]

\n
\n

string

\n

The service URL for the Opsgenie integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

pagerduty

\n
\n

object

\n

A PagerDuty integration schema.

\n
\n
\n
\n
\n
\n

serviceURL [required]

\n
\n

string

\n

The service URL for the PagerDuty integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of Entity V3 System Kind object. \nAllowed enum values: system

\n
\n \n
\n
\n
\n
\n
\n

metadata [required]

\n
\n

object

\n

The definition of Entity V3 Metadata object.

\n
\n
\n
\n
\n
\n

additionalOwners

\n
\n

[object]

\n

The additional owners of the entity, usually a team.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Team name.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Team type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

contacts

\n
\n

[object]

\n

A list of contacts for the entity.

\n
\n
\n
\n
\n
\n

contact [required]

\n
\n

string

\n

Contact value.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Contact name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Contact type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Short description of the entity. The UI can leverage the description for display.

\n
\n \n
\n
\n
\n
\n
\n

displayName

\n
\n

string

\n

User friendly name of the entity. The UI can leverage the display name for display.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored.

\n
\n \n
\n
\n
\n
\n
\n

inheritFrom

\n
\n

string

\n

The entity reference from which to inherit metadata

\n
\n \n
\n
\n
\n
\n
\n

links

\n
\n

[object]

\n

A list of links for the entity.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Link name.

\n
\n \n
\n
\n
\n
\n
\n

provider

\n
\n

string

\n

Link provider.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Link type.

default: other

\n
\n \n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

Link URL.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

managed

\n
\n

object

\n

A read-only set of Datadog managed attributes generated by Datadog. User supplied values are ignored.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Unique name given to an entity under the kind/namespace.

\n
\n \n
\n
\n
\n
\n
\n

namespace

\n
\n

string

\n

Namespace is a part of unique identifier. It has a default value of 'default'.

\n
\n \n
\n
\n
\n
\n
\n

owner

\n
\n

string

\n

The owner of the entity, usually a team.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A set of custom tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

spec

\n
\n

object

\n

The definition of Entity V3 System Spec object.

\n
\n
\n
\n
\n
\n

components

\n
\n

[string]

\n

A list of components belongs to the system.

\n
\n \n
\n
\n
\n
\n
\n

lifecycle

\n
\n

string

\n

The lifecycle state of the component.

\n
\n \n
\n
\n
\n
\n
\n

tier

\n
\n

string

\n

An entity reference to the owner of the component.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Schema for API entities.

\n
\n
\n
\n
\n
\n

apiVersion [required]

\n
\n

enum

\n

The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version. \nAllowed enum values: v3,v2.2,v2.1,v2

\n
\n \n
\n
\n
\n
\n
\n

datadog

\n
\n

object

\n

Datadog product integrations for the API entity.

\n
\n
\n
\n
\n
\n

codeLocations

\n
\n

[object]

\n

Schema for mapping source code locations to an entity.

\n
\n
\n
\n
\n
\n

paths

\n
\n

[string]

\n

The paths (glob) to the source code of the service.

\n
\n \n
\n
\n
\n
\n
\n

repositoryURL

\n
\n

string

\n

The repository path of the source code of the entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

events

\n
\n

[object]

\n

Events associations.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The query to run.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

logs

\n
\n

[object]

\n

Logs association.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The query to run.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

performanceData

\n
\n

object

\n

Performance stats association.

\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A list of APM entity tags that associates the APM Stats data with the entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

pipelines

\n
\n

object

\n

CI Pipelines association.

\n
\n
\n
\n
\n
\n

fingerprints

\n
\n

[string]

\n

A list of CI Fingerprints that associate CI Pipelines with the entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

extensions

\n
\n

object

\n

Custom extensions. This is the free-formed field to send client-side metadata. No Datadog features are affected by this field.

\n
\n \n
\n
\n
\n
\n
\n

integrations

\n
\n

object

\n

A base schema for defining third-party integrations.

\n
\n
\n
\n
\n
\n

opsgenie

\n
\n

object

\n

An Opsgenie integration schema.

\n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

The region for the Opsgenie integration.

\n
\n \n
\n
\n
\n
\n
\n

serviceURL [required]

\n
\n

string

\n

The service URL for the Opsgenie integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

pagerduty

\n
\n

object

\n

A PagerDuty integration schema.

\n
\n
\n
\n
\n
\n

serviceURL [required]

\n
\n

string

\n

The service URL for the PagerDuty integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of Entity V3 API Kind object. \nAllowed enum values: api

\n
\n \n
\n
\n
\n
\n
\n

metadata [required]

\n
\n

object

\n

The definition of Entity V3 Metadata object.

\n
\n
\n
\n
\n
\n

additionalOwners

\n
\n

[object]

\n

The additional owners of the entity, usually a team.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Team name.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Team type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

contacts

\n
\n

[object]

\n

A list of contacts for the entity.

\n
\n
\n
\n
\n
\n

contact [required]

\n
\n

string

\n

Contact value.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Contact name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Contact type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Short description of the entity. The UI can leverage the description for display.

\n
\n \n
\n
\n
\n
\n
\n

displayName

\n
\n

string

\n

User friendly name of the entity. The UI can leverage the display name for display.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored.

\n
\n \n
\n
\n
\n
\n
\n

inheritFrom

\n
\n

string

\n

The entity reference from which to inherit metadata

\n
\n \n
\n
\n
\n
\n
\n

links

\n
\n

[object]

\n

A list of links for the entity.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Link name.

\n
\n \n
\n
\n
\n
\n
\n

provider

\n
\n

string

\n

Link provider.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Link type.

default: other

\n
\n \n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

Link URL.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

managed

\n
\n

object

\n

A read-only set of Datadog managed attributes generated by Datadog. User supplied values are ignored.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Unique name given to an entity under the kind/namespace.

\n
\n \n
\n
\n
\n
\n
\n

namespace

\n
\n

string

\n

Namespace is a part of unique identifier. It has a default value of 'default'.

\n
\n \n
\n
\n
\n
\n
\n

owner

\n
\n

string

\n

The owner of the entity, usually a team.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A set of custom tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

spec

\n
\n

object

\n

The definition of Entity V3 API Spec object.

\n
\n
\n
\n
\n
\n

implementedBy

\n
\n

[string]

\n

Services which implemented the API.

\n
\n \n
\n
\n
\n
\n
\n

interface

\n
\n

 <oneOf>

\n

The API definition.

\n
\n \n
\n
\n
\n
\n
\n

lifecycle

\n
\n

string

\n

The lifecycle state of the component.

\n
\n \n
\n
\n
\n
\n
\n

tier

\n
\n

string

\n

The importance of the component.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

The type of API.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Entity ID.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Schema type. \nAllowed enum values: schema

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Entity metadata.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

Total entities count.

\n
\n \n
\n
\n
\n
\n
\n

includeCount

\n
\n

int64

\n

Total included data count.

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -379,7 +379,7 @@ "request": { "json_curl": {}, "json": {}, - "html": "
\n
\n
\n
\n

Option 1

\n
\n

 <oneOf>

\n

Entity schema v3.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Schema for service entities.

\n
\n
\n
\n
\n
\n

apiVersion [required]

\n
\n

enum

\n

The schema version of entity type. The field is known as schema-version in the previous version. \nAllowed enum values: v3

\n
\n \n
\n
\n
\n
\n
\n

datadog

\n
\n

object

\n

Datadog product integrations for the service entity.

\n
\n
\n
\n
\n
\n

codeLocations

\n
\n

[object]

\n

Schema for mapping source code locations to an entity.

\n
\n
\n
\n
\n
\n

paths

\n
\n

[string]

\n

The paths (glob) to the source code of the service.

\n
\n \n
\n
\n
\n
\n
\n

repositoryURL

\n
\n

string

\n

The repository path of the source code of the entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

events

\n
\n

[object]

\n

Events associations.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The query to run.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

logs

\n
\n

[object]

\n

Logs association.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The query to run.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

performanceData

\n
\n

object

\n

Performance stats association.

\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A list of APM entity tags that associates the APM Stats data with the entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

pipelines

\n
\n

object

\n

CI Pipelines association.

\n
\n
\n
\n
\n
\n

fingerprints

\n
\n

[string]

\n

A list of CI Fingerprints that associate CI Pipelines with the entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

extensions

\n
\n

object

\n

Custom extensions. This is the free-formed field to send client-side metadata. No Datadog features are affected by this field.

\n
\n \n
\n
\n
\n
\n
\n

integrations

\n
\n

object

\n

A base schema for defining third-party integrations.

\n
\n
\n
\n
\n
\n

opsgenie

\n
\n

object

\n

An Opsgenie integration schema.

\n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

The region for the Opsgenie integration.

\n
\n \n
\n
\n
\n
\n
\n

serviceURL [required]

\n
\n

string

\n

The service URL for the Opsgenie integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

pagerduty

\n
\n

object

\n

A PagerDuty integration schema.

\n
\n
\n
\n
\n
\n

serviceURL [required]

\n
\n

string

\n

The service URL for the PagerDuty integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of Entity V3 Service Kind object. \nAllowed enum values: service

\n
\n \n
\n
\n
\n
\n
\n

metadata [required]

\n
\n

object

\n

The definition of Entity V3 Metadata object.

\n
\n
\n
\n
\n
\n

additionalOwners

\n
\n

[object]

\n

The additional owners of the entity, usually a team.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Team name.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Team type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

contacts

\n
\n

[object]

\n

A list of contacts for the entity.

\n
\n
\n
\n
\n
\n

contact [required]

\n
\n

string

\n

Contact value.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Contact name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Contact type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Short description of the entity. The UI can leverage the description for display.

\n
\n \n
\n
\n
\n
\n
\n

displayName

\n
\n

string

\n

User friendly name of the entity. The UI can leverage the display name for display.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored.

\n
\n \n
\n
\n
\n
\n
\n

inheritFrom

\n
\n

string

\n

The entity reference from which to inherit metadata

\n
\n \n
\n
\n
\n
\n
\n

links

\n
\n

[object]

\n

A list of links for the entity.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Link name.

\n
\n \n
\n
\n
\n
\n
\n

provider

\n
\n

string

\n

Link provider.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Link type.

default: other

\n
\n \n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

Link URL.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

managed

\n
\n

object

\n

A read-only set of Datadog managed attributes generated by Datadog. User supplied values are ignored.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Unique name given to an entity under the kind/namespace.

\n
\n \n
\n
\n
\n
\n
\n

namespace

\n
\n

string

\n

Namespace is a part of unique identifier. It has a default value of 'default'.

\n
\n \n
\n
\n
\n
\n
\n

owner

\n
\n

string

\n

The owner of the entity, usually a team.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A set of custom tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

spec

\n
\n

object

\n

The definition of Entity V3 Service Spec object.

\n
\n
\n
\n
\n
\n

componentOf

\n
\n

[string]

\n

A list of components the service is a part of

\n
\n \n
\n
\n
\n
\n
\n

dependsOn

\n
\n

[string]

\n

A list of components the service depends on.

\n
\n \n
\n
\n
\n
\n
\n

languages

\n
\n

[string]

\n

The service's programming language.

\n
\n \n
\n
\n
\n
\n
\n

lifecycle

\n
\n

string

\n

The lifecycle state of the component.

\n
\n \n
\n
\n
\n
\n
\n

tier

\n
\n

string

\n

The importance of the component.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

The type of service.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Schema for datastore entities.

\n
\n
\n
\n
\n
\n

apiVersion [required]

\n
\n

enum

\n

The schema version of entity type. The field is known as schema-version in the previous version. \nAllowed enum values: v3

\n
\n \n
\n
\n
\n
\n
\n

datadog

\n
\n

object

\n

Datadog product integrations for the datastore entity.

\n
\n
\n
\n
\n
\n

events

\n
\n

[object]

\n

Events associations.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The query to run.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

logs

\n
\n

[object]

\n

Logs association.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The query to run.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

performanceData

\n
\n

object

\n

Performance stats association.

\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A list of APM entity tags that associates the APM Stats data with the entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

extensions

\n
\n

object

\n

Custom extensions. This is the free-formed field to send client side metadata. No Datadog features are affected by this field.

\n
\n \n
\n
\n
\n
\n
\n

integrations

\n
\n

object

\n

A base schema for defining third-party integrations.

\n
\n
\n
\n
\n
\n

opsgenie

\n
\n

object

\n

An Opsgenie integration schema.

\n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

The region for the Opsgenie integration.

\n
\n \n
\n
\n
\n
\n
\n

serviceURL [required]

\n
\n

string

\n

The service URL for the Opsgenie integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

pagerduty

\n
\n

object

\n

A PagerDuty integration schema.

\n
\n
\n
\n
\n
\n

serviceURL [required]

\n
\n

string

\n

The service URL for the PagerDuty integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of Entity V3 Datastore Kind object. \nAllowed enum values: datastore

\n
\n \n
\n
\n
\n
\n
\n

metadata [required]

\n
\n

object

\n

The definition of Entity V3 Metadata object.

\n
\n
\n
\n
\n
\n

additionalOwners

\n
\n

[object]

\n

The additional owners of the entity, usually a team.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Team name.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Team type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

contacts

\n
\n

[object]

\n

A list of contacts for the entity.

\n
\n
\n
\n
\n
\n

contact [required]

\n
\n

string

\n

Contact value.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Contact name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Contact type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Short description of the entity. The UI can leverage the description for display.

\n
\n \n
\n
\n
\n
\n
\n

displayName

\n
\n

string

\n

User friendly name of the entity. The UI can leverage the display name for display.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored.

\n
\n \n
\n
\n
\n
\n
\n

inheritFrom

\n
\n

string

\n

The entity reference from which to inherit metadata

\n
\n \n
\n
\n
\n
\n
\n

links

\n
\n

[object]

\n

A list of links for the entity.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Link name.

\n
\n \n
\n
\n
\n
\n
\n

provider

\n
\n

string

\n

Link provider.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Link type.

default: other

\n
\n \n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

Link URL.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

managed

\n
\n

object

\n

A read-only set of Datadog managed attributes generated by Datadog. User supplied values are ignored.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Unique name given to an entity under the kind/namespace.

\n
\n \n
\n
\n
\n
\n
\n

namespace

\n
\n

string

\n

Namespace is a part of unique identifier. It has a default value of 'default'.

\n
\n \n
\n
\n
\n
\n
\n

owner

\n
\n

string

\n

The owner of the entity, usually a team.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A set of custom tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

spec

\n
\n

object

\n

The definition of Entity V3 Datastore Spec object.

\n
\n
\n
\n
\n
\n

componentOf

\n
\n

[string]

\n

A list of components the datastore is a part of

\n
\n \n
\n
\n
\n
\n
\n

lifecycle

\n
\n

string

\n

The lifecycle state of the datastore.

\n
\n \n
\n
\n
\n
\n
\n

tier

\n
\n

string

\n

The importance of the datastore.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

The type of datastore.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Schema for queue entities.

\n
\n
\n
\n
\n
\n

apiVersion [required]

\n
\n

enum

\n

The schema version of entity type. The field is known as schema-version in the previous version. \nAllowed enum values: v3

\n
\n \n
\n
\n
\n
\n
\n

datadog

\n
\n

object

\n

Datadog product integrations for the datastore entity.

\n
\n
\n
\n
\n
\n

events

\n
\n

[object]

\n

Events associations.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The query to run.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

logs

\n
\n

[object]

\n

Logs association.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The query to run.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

performanceData

\n
\n

object

\n

Performance stats association.

\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A list of APM entity tags that associates the APM Stats data with the entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

extensions

\n
\n

object

\n

Custom extensions. This is the free-formed field to send client-side metadata. No Datadog features are affected by this field.

\n
\n \n
\n
\n
\n
\n
\n

integrations

\n
\n

object

\n

A base schema for defining third-party integrations.

\n
\n
\n
\n
\n
\n

opsgenie

\n
\n

object

\n

An Opsgenie integration schema.

\n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

The region for the Opsgenie integration.

\n
\n \n
\n
\n
\n
\n
\n

serviceURL [required]

\n
\n

string

\n

The service URL for the Opsgenie integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

pagerduty

\n
\n

object

\n

A PagerDuty integration schema.

\n
\n
\n
\n
\n
\n

serviceURL [required]

\n
\n

string

\n

The service URL for the PagerDuty integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of Entity V3 Queue Kind object. \nAllowed enum values: queue

\n
\n \n
\n
\n
\n
\n
\n

metadata [required]

\n
\n

object

\n

The definition of Entity V3 Metadata object.

\n
\n
\n
\n
\n
\n

additionalOwners

\n
\n

[object]

\n

The additional owners of the entity, usually a team.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Team name.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Team type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

contacts

\n
\n

[object]

\n

A list of contacts for the entity.

\n
\n
\n
\n
\n
\n

contact [required]

\n
\n

string

\n

Contact value.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Contact name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Contact type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Short description of the entity. The UI can leverage the description for display.

\n
\n \n
\n
\n
\n
\n
\n

displayName

\n
\n

string

\n

User friendly name of the entity. The UI can leverage the display name for display.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored.

\n
\n \n
\n
\n
\n
\n
\n

inheritFrom

\n
\n

string

\n

The entity reference from which to inherit metadata

\n
\n \n
\n
\n
\n
\n
\n

links

\n
\n

[object]

\n

A list of links for the entity.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Link name.

\n
\n \n
\n
\n
\n
\n
\n

provider

\n
\n

string

\n

Link provider.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Link type.

default: other

\n
\n \n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

Link URL.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

managed

\n
\n

object

\n

A read-only set of Datadog managed attributes generated by Datadog. User supplied values are ignored.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Unique name given to an entity under the kind/namespace.

\n
\n \n
\n
\n
\n
\n
\n

namespace

\n
\n

string

\n

Namespace is a part of unique identifier. It has a default value of 'default'.

\n
\n \n
\n
\n
\n
\n
\n

owner

\n
\n

string

\n

The owner of the entity, usually a team.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A set of custom tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

spec

\n
\n

object

\n

The definition of Entity V3 Queue Spec object.

\n
\n
\n
\n
\n
\n

componentOf

\n
\n

[string]

\n

A list of components the queue is a part of

\n
\n \n
\n
\n
\n
\n
\n

lifecycle

\n
\n

string

\n

The lifecycle state of the queue.

\n
\n \n
\n
\n
\n
\n
\n

tier

\n
\n

string

\n

The importance of the queue.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

The type of queue.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Schema for system entities.

\n
\n
\n
\n
\n
\n

apiVersion [required]

\n
\n

enum

\n

The schema version of entity type. The field is known as schema-version in the previous version. \nAllowed enum values: v3

\n
\n \n
\n
\n
\n
\n
\n

datadog

\n
\n

object

\n

Datadog product integrations for the service entity.

\n
\n
\n
\n
\n
\n

events

\n
\n

[object]

\n

Events associations.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The query to run.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

logs

\n
\n

[object]

\n

Logs association.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The query to run.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

performanceData

\n
\n

object

\n

Performance stats association.

\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A list of APM entity tags that associates the APM Stats data with the entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

pipelines

\n
\n

object

\n

CI Pipelines association.

\n
\n
\n
\n
\n
\n

fingerprints

\n
\n

[string]

\n

A list of CI Fingerprints that associate CI Pipelines with the entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

extensions

\n
\n

object

\n

Custom extensions. This is the free-formed field to send client-side metadata. No Datadog features are affected by this field.

\n
\n \n
\n
\n
\n
\n
\n

integrations

\n
\n

object

\n

A base schema for defining third-party integrations.

\n
\n
\n
\n
\n
\n

opsgenie

\n
\n

object

\n

An Opsgenie integration schema.

\n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

The region for the Opsgenie integration.

\n
\n \n
\n
\n
\n
\n
\n

serviceURL [required]

\n
\n

string

\n

The service URL for the Opsgenie integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

pagerduty

\n
\n

object

\n

A PagerDuty integration schema.

\n
\n
\n
\n
\n
\n

serviceURL [required]

\n
\n

string

\n

The service URL for the PagerDuty integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of Entity V3 System Kind object. \nAllowed enum values: system

\n
\n \n
\n
\n
\n
\n
\n

metadata [required]

\n
\n

object

\n

The definition of Entity V3 Metadata object.

\n
\n
\n
\n
\n
\n

additionalOwners

\n
\n

[object]

\n

The additional owners of the entity, usually a team.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Team name.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Team type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

contacts

\n
\n

[object]

\n

A list of contacts for the entity.

\n
\n
\n
\n
\n
\n

contact [required]

\n
\n

string

\n

Contact value.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Contact name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Contact type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Short description of the entity. The UI can leverage the description for display.

\n
\n \n
\n
\n
\n
\n
\n

displayName

\n
\n

string

\n

User friendly name of the entity. The UI can leverage the display name for display.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored.

\n
\n \n
\n
\n
\n
\n
\n

inheritFrom

\n
\n

string

\n

The entity reference from which to inherit metadata

\n
\n \n
\n
\n
\n
\n
\n

links

\n
\n

[object]

\n

A list of links for the entity.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Link name.

\n
\n \n
\n
\n
\n
\n
\n

provider

\n
\n

string

\n

Link provider.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Link type.

default: other

\n
\n \n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

Link URL.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

managed

\n
\n

object

\n

A read-only set of Datadog managed attributes generated by Datadog. User supplied values are ignored.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Unique name given to an entity under the kind/namespace.

\n
\n \n
\n
\n
\n
\n
\n

namespace

\n
\n

string

\n

Namespace is a part of unique identifier. It has a default value of 'default'.

\n
\n \n
\n
\n
\n
\n
\n

owner

\n
\n

string

\n

The owner of the entity, usually a team.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A set of custom tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

spec

\n
\n

object

\n

The definition of Entity V3 System Spec object.

\n
\n
\n
\n
\n
\n

components

\n
\n

[string]

\n

A list of components belongs to the system.

\n
\n \n
\n
\n
\n
\n
\n

lifecycle

\n
\n

string

\n

The lifecycle state of the component.

\n
\n \n
\n
\n
\n
\n
\n

tier

\n
\n

string

\n

An entity reference to the owner of the component.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Schema for API entities.

\n
\n
\n
\n
\n
\n

apiVersion [required]

\n
\n

enum

\n

The schema version of entity type. The field is known as schema-version in the previous version. \nAllowed enum values: v3

\n
\n \n
\n
\n
\n
\n
\n

datadog

\n
\n

object

\n

Datadog product integrations for the API entity.

\n
\n
\n
\n
\n
\n

codeLocations

\n
\n

[object]

\n

Schema for mapping source code locations to an entity.

\n
\n
\n
\n
\n
\n

paths

\n
\n

[string]

\n

The paths (glob) to the source code of the service.

\n
\n \n
\n
\n
\n
\n
\n

repositoryURL

\n
\n

string

\n

The repository path of the source code of the entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

events

\n
\n

[object]

\n

Events associations.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The query to run.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

logs

\n
\n

[object]

\n

Logs association.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The query to run.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

performanceData

\n
\n

object

\n

Performance stats association.

\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A list of APM entity tags that associates the APM Stats data with the entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

pipelines

\n
\n

object

\n

CI Pipelines association.

\n
\n
\n
\n
\n
\n

fingerprints

\n
\n

[string]

\n

A list of CI Fingerprints that associate CI Pipelines with the entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

extensions

\n
\n

object

\n

Custom extensions. This is the free-formed field to send client-side metadata. No Datadog features are affected by this field.

\n
\n \n
\n
\n
\n
\n
\n

integrations

\n
\n

object

\n

A base schema for defining third-party integrations.

\n
\n
\n
\n
\n
\n

opsgenie

\n
\n

object

\n

An Opsgenie integration schema.

\n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

The region for the Opsgenie integration.

\n
\n \n
\n
\n
\n
\n
\n

serviceURL [required]

\n
\n

string

\n

The service URL for the Opsgenie integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

pagerduty

\n
\n

object

\n

A PagerDuty integration schema.

\n
\n
\n
\n
\n
\n

serviceURL [required]

\n
\n

string

\n

The service URL for the PagerDuty integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of Entity V3 API Kind object. \nAllowed enum values: api

\n
\n \n
\n
\n
\n
\n
\n

metadata [required]

\n
\n

object

\n

The definition of Entity V3 Metadata object.

\n
\n
\n
\n
\n
\n

additionalOwners

\n
\n

[object]

\n

The additional owners of the entity, usually a team.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Team name.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Team type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

contacts

\n
\n

[object]

\n

A list of contacts for the entity.

\n
\n
\n
\n
\n
\n

contact [required]

\n
\n

string

\n

Contact value.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Contact name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Contact type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Short description of the entity. The UI can leverage the description for display.

\n
\n \n
\n
\n
\n
\n
\n

displayName

\n
\n

string

\n

User friendly name of the entity. The UI can leverage the display name for display.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored.

\n
\n \n
\n
\n
\n
\n
\n

inheritFrom

\n
\n

string

\n

The entity reference from which to inherit metadata

\n
\n \n
\n
\n
\n
\n
\n

links

\n
\n

[object]

\n

A list of links for the entity.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Link name.

\n
\n \n
\n
\n
\n
\n
\n

provider

\n
\n

string

\n

Link provider.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Link type.

default: other

\n
\n \n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

Link URL.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

managed

\n
\n

object

\n

A read-only set of Datadog managed attributes generated by Datadog. User supplied values are ignored.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Unique name given to an entity under the kind/namespace.

\n
\n \n
\n
\n
\n
\n
\n

namespace

\n
\n

string

\n

Namespace is a part of unique identifier. It has a default value of 'default'.

\n
\n \n
\n
\n
\n
\n
\n

owner

\n
\n

string

\n

The owner of the entity, usually a team.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A set of custom tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

spec

\n
\n

object

\n

The definition of Entity V3 API Spec object.

\n
\n
\n
\n
\n
\n

implementedBy

\n
\n

[string]

\n

Services which implemented the API.

\n
\n \n
\n
\n
\n
\n
\n

interface

\n
\n

 <oneOf>

\n

The API definition.

\n
\n \n
\n
\n
\n
\n
\n

lifecycle

\n
\n

string

\n

The lifecycle state of the component.

\n
\n \n
\n
\n
\n
\n
\n

tier

\n
\n

string

\n

The importance of the component.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

The type of API.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

string

\n

Entity definition in raw JSON or YAML representation.

\n
\n \n
\n
" + "html": "
\n
\n
\n
\n

Option 1

\n
\n

 <oneOf>

\n

Entity schema v3.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Schema for service entities.

\n
\n
\n
\n
\n
\n

apiVersion [required]

\n
\n

enum

\n

The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version. \nAllowed enum values: v3,v2.2,v2.1,v2

\n
\n \n
\n
\n
\n
\n
\n

datadog

\n
\n

object

\n

Datadog product integrations for the service entity.

\n
\n
\n
\n
\n
\n

codeLocations

\n
\n

[object]

\n

Schema for mapping source code locations to an entity.

\n
\n
\n
\n
\n
\n

paths

\n
\n

[string]

\n

The paths (glob) to the source code of the service.

\n
\n \n
\n
\n
\n
\n
\n

repositoryURL

\n
\n

string

\n

The repository path of the source code of the entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

events

\n
\n

[object]

\n

Events associations.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The query to run.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

logs

\n
\n

[object]

\n

Logs association.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The query to run.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

performanceData

\n
\n

object

\n

Performance stats association.

\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A list of APM entity tags that associates the APM Stats data with the entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

pipelines

\n
\n

object

\n

CI Pipelines association.

\n
\n
\n
\n
\n
\n

fingerprints

\n
\n

[string]

\n

A list of CI Fingerprints that associate CI Pipelines with the entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

extensions

\n
\n

object

\n

Custom extensions. This is the free-formed field to send client-side metadata. No Datadog features are affected by this field.

\n
\n \n
\n
\n
\n
\n
\n

integrations

\n
\n

object

\n

A base schema for defining third-party integrations.

\n
\n
\n
\n
\n
\n

opsgenie

\n
\n

object

\n

An Opsgenie integration schema.

\n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

The region for the Opsgenie integration.

\n
\n \n
\n
\n
\n
\n
\n

serviceURL [required]

\n
\n

string

\n

The service URL for the Opsgenie integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

pagerduty

\n
\n

object

\n

A PagerDuty integration schema.

\n
\n
\n
\n
\n
\n

serviceURL [required]

\n
\n

string

\n

The service URL for the PagerDuty integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of Entity V3 Service Kind object. \nAllowed enum values: service

\n
\n \n
\n
\n
\n
\n
\n

metadata [required]

\n
\n

object

\n

The definition of Entity V3 Metadata object.

\n
\n
\n
\n
\n
\n

additionalOwners

\n
\n

[object]

\n

The additional owners of the entity, usually a team.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Team name.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Team type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

contacts

\n
\n

[object]

\n

A list of contacts for the entity.

\n
\n
\n
\n
\n
\n

contact [required]

\n
\n

string

\n

Contact value.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Contact name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Contact type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Short description of the entity. The UI can leverage the description for display.

\n
\n \n
\n
\n
\n
\n
\n

displayName

\n
\n

string

\n

User friendly name of the entity. The UI can leverage the display name for display.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored.

\n
\n \n
\n
\n
\n
\n
\n

inheritFrom

\n
\n

string

\n

The entity reference from which to inherit metadata

\n
\n \n
\n
\n
\n
\n
\n

links

\n
\n

[object]

\n

A list of links for the entity.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Link name.

\n
\n \n
\n
\n
\n
\n
\n

provider

\n
\n

string

\n

Link provider.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Link type.

default: other

\n
\n \n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

Link URL.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

managed

\n
\n

object

\n

A read-only set of Datadog managed attributes generated by Datadog. User supplied values are ignored.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Unique name given to an entity under the kind/namespace.

\n
\n \n
\n
\n
\n
\n
\n

namespace

\n
\n

string

\n

Namespace is a part of unique identifier. It has a default value of 'default'.

\n
\n \n
\n
\n
\n
\n
\n

owner

\n
\n

string

\n

The owner of the entity, usually a team.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A set of custom tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

spec

\n
\n

object

\n

The definition of Entity V3 Service Spec object.

\n
\n
\n
\n
\n
\n

componentOf

\n
\n

[string]

\n

A list of components the service is a part of

\n
\n \n
\n
\n
\n
\n
\n

dependsOn

\n
\n

[string]

\n

A list of components the service depends on.

\n
\n \n
\n
\n
\n
\n
\n

languages

\n
\n

[string]

\n

The service's programming language.

\n
\n \n
\n
\n
\n
\n
\n

lifecycle

\n
\n

string

\n

The lifecycle state of the component.

\n
\n \n
\n
\n
\n
\n
\n

tier

\n
\n

string

\n

The importance of the component.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

The type of service.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Schema for datastore entities.

\n
\n
\n
\n
\n
\n

apiVersion [required]

\n
\n

enum

\n

The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version. \nAllowed enum values: v3,v2.2,v2.1,v2

\n
\n \n
\n
\n
\n
\n
\n

datadog

\n
\n

object

\n

Datadog product integrations for the datastore entity.

\n
\n
\n
\n
\n
\n

events

\n
\n

[object]

\n

Events associations.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The query to run.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

logs

\n
\n

[object]

\n

Logs association.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The query to run.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

performanceData

\n
\n

object

\n

Performance stats association.

\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A list of APM entity tags that associates the APM Stats data with the entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

extensions

\n
\n

object

\n

Custom extensions. This is the free-formed field to send client side metadata. No Datadog features are affected by this field.

\n
\n \n
\n
\n
\n
\n
\n

integrations

\n
\n

object

\n

A base schema for defining third-party integrations.

\n
\n
\n
\n
\n
\n

opsgenie

\n
\n

object

\n

An Opsgenie integration schema.

\n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

The region for the Opsgenie integration.

\n
\n \n
\n
\n
\n
\n
\n

serviceURL [required]

\n
\n

string

\n

The service URL for the Opsgenie integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

pagerduty

\n
\n

object

\n

A PagerDuty integration schema.

\n
\n
\n
\n
\n
\n

serviceURL [required]

\n
\n

string

\n

The service URL for the PagerDuty integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of Entity V3 Datastore Kind object. \nAllowed enum values: datastore

\n
\n \n
\n
\n
\n
\n
\n

metadata [required]

\n
\n

object

\n

The definition of Entity V3 Metadata object.

\n
\n
\n
\n
\n
\n

additionalOwners

\n
\n

[object]

\n

The additional owners of the entity, usually a team.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Team name.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Team type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

contacts

\n
\n

[object]

\n

A list of contacts for the entity.

\n
\n
\n
\n
\n
\n

contact [required]

\n
\n

string

\n

Contact value.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Contact name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Contact type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Short description of the entity. The UI can leverage the description for display.

\n
\n \n
\n
\n
\n
\n
\n

displayName

\n
\n

string

\n

User friendly name of the entity. The UI can leverage the display name for display.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored.

\n
\n \n
\n
\n
\n
\n
\n

inheritFrom

\n
\n

string

\n

The entity reference from which to inherit metadata

\n
\n \n
\n
\n
\n
\n
\n

links

\n
\n

[object]

\n

A list of links for the entity.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Link name.

\n
\n \n
\n
\n
\n
\n
\n

provider

\n
\n

string

\n

Link provider.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Link type.

default: other

\n
\n \n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

Link URL.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

managed

\n
\n

object

\n

A read-only set of Datadog managed attributes generated by Datadog. User supplied values are ignored.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Unique name given to an entity under the kind/namespace.

\n
\n \n
\n
\n
\n
\n
\n

namespace

\n
\n

string

\n

Namespace is a part of unique identifier. It has a default value of 'default'.

\n
\n \n
\n
\n
\n
\n
\n

owner

\n
\n

string

\n

The owner of the entity, usually a team.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A set of custom tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

spec

\n
\n

object

\n

The definition of Entity V3 Datastore Spec object.

\n
\n
\n
\n
\n
\n

componentOf

\n
\n

[string]

\n

A list of components the datastore is a part of

\n
\n \n
\n
\n
\n
\n
\n

lifecycle

\n
\n

string

\n

The lifecycle state of the datastore.

\n
\n \n
\n
\n
\n
\n
\n

tier

\n
\n

string

\n

The importance of the datastore.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

The type of datastore.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Schema for queue entities.

\n
\n
\n
\n
\n
\n

apiVersion [required]

\n
\n

enum

\n

The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version. \nAllowed enum values: v3,v2.2,v2.1,v2

\n
\n \n
\n
\n
\n
\n
\n

datadog

\n
\n

object

\n

Datadog product integrations for the datastore entity.

\n
\n
\n
\n
\n
\n

events

\n
\n

[object]

\n

Events associations.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The query to run.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

logs

\n
\n

[object]

\n

Logs association.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The query to run.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

performanceData

\n
\n

object

\n

Performance stats association.

\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A list of APM entity tags that associates the APM Stats data with the entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

extensions

\n
\n

object

\n

Custom extensions. This is the free-formed field to send client-side metadata. No Datadog features are affected by this field.

\n
\n \n
\n
\n
\n
\n
\n

integrations

\n
\n

object

\n

A base schema for defining third-party integrations.

\n
\n
\n
\n
\n
\n

opsgenie

\n
\n

object

\n

An Opsgenie integration schema.

\n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

The region for the Opsgenie integration.

\n
\n \n
\n
\n
\n
\n
\n

serviceURL [required]

\n
\n

string

\n

The service URL for the Opsgenie integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

pagerduty

\n
\n

object

\n

A PagerDuty integration schema.

\n
\n
\n
\n
\n
\n

serviceURL [required]

\n
\n

string

\n

The service URL for the PagerDuty integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of Entity V3 Queue Kind object. \nAllowed enum values: queue

\n
\n \n
\n
\n
\n
\n
\n

metadata [required]

\n
\n

object

\n

The definition of Entity V3 Metadata object.

\n
\n
\n
\n
\n
\n

additionalOwners

\n
\n

[object]

\n

The additional owners of the entity, usually a team.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Team name.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Team type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

contacts

\n
\n

[object]

\n

A list of contacts for the entity.

\n
\n
\n
\n
\n
\n

contact [required]

\n
\n

string

\n

Contact value.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Contact name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Contact type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Short description of the entity. The UI can leverage the description for display.

\n
\n \n
\n
\n
\n
\n
\n

displayName

\n
\n

string

\n

User friendly name of the entity. The UI can leverage the display name for display.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored.

\n
\n \n
\n
\n
\n
\n
\n

inheritFrom

\n
\n

string

\n

The entity reference from which to inherit metadata

\n
\n \n
\n
\n
\n
\n
\n

links

\n
\n

[object]

\n

A list of links for the entity.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Link name.

\n
\n \n
\n
\n
\n
\n
\n

provider

\n
\n

string

\n

Link provider.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Link type.

default: other

\n
\n \n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

Link URL.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

managed

\n
\n

object

\n

A read-only set of Datadog managed attributes generated by Datadog. User supplied values are ignored.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Unique name given to an entity under the kind/namespace.

\n
\n \n
\n
\n
\n
\n
\n

namespace

\n
\n

string

\n

Namespace is a part of unique identifier. It has a default value of 'default'.

\n
\n \n
\n
\n
\n
\n
\n

owner

\n
\n

string

\n

The owner of the entity, usually a team.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A set of custom tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

spec

\n
\n

object

\n

The definition of Entity V3 Queue Spec object.

\n
\n
\n
\n
\n
\n

componentOf

\n
\n

[string]

\n

A list of components the queue is a part of

\n
\n \n
\n
\n
\n
\n
\n

lifecycle

\n
\n

string

\n

The lifecycle state of the queue.

\n
\n \n
\n
\n
\n
\n
\n

tier

\n
\n

string

\n

The importance of the queue.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

The type of queue.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Schema for system entities.

\n
\n
\n
\n
\n
\n

apiVersion [required]

\n
\n

enum

\n

The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version. \nAllowed enum values: v3,v2.2,v2.1,v2

\n
\n \n
\n
\n
\n
\n
\n

datadog

\n
\n

object

\n

Datadog product integrations for the service entity.

\n
\n
\n
\n
\n
\n

events

\n
\n

[object]

\n

Events associations.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The query to run.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

logs

\n
\n

[object]

\n

Logs association.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The query to run.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

performanceData

\n
\n

object

\n

Performance stats association.

\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A list of APM entity tags that associates the APM Stats data with the entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

pipelines

\n
\n

object

\n

CI Pipelines association.

\n
\n
\n
\n
\n
\n

fingerprints

\n
\n

[string]

\n

A list of CI Fingerprints that associate CI Pipelines with the entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

extensions

\n
\n

object

\n

Custom extensions. This is the free-formed field to send client-side metadata. No Datadog features are affected by this field.

\n
\n \n
\n
\n
\n
\n
\n

integrations

\n
\n

object

\n

A base schema for defining third-party integrations.

\n
\n
\n
\n
\n
\n

opsgenie

\n
\n

object

\n

An Opsgenie integration schema.

\n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

The region for the Opsgenie integration.

\n
\n \n
\n
\n
\n
\n
\n

serviceURL [required]

\n
\n

string

\n

The service URL for the Opsgenie integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

pagerduty

\n
\n

object

\n

A PagerDuty integration schema.

\n
\n
\n
\n
\n
\n

serviceURL [required]

\n
\n

string

\n

The service URL for the PagerDuty integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of Entity V3 System Kind object. \nAllowed enum values: system

\n
\n \n
\n
\n
\n
\n
\n

metadata [required]

\n
\n

object

\n

The definition of Entity V3 Metadata object.

\n
\n
\n
\n
\n
\n

additionalOwners

\n
\n

[object]

\n

The additional owners of the entity, usually a team.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Team name.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Team type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

contacts

\n
\n

[object]

\n

A list of contacts for the entity.

\n
\n
\n
\n
\n
\n

contact [required]

\n
\n

string

\n

Contact value.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Contact name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Contact type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Short description of the entity. The UI can leverage the description for display.

\n
\n \n
\n
\n
\n
\n
\n

displayName

\n
\n

string

\n

User friendly name of the entity. The UI can leverage the display name for display.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored.

\n
\n \n
\n
\n
\n
\n
\n

inheritFrom

\n
\n

string

\n

The entity reference from which to inherit metadata

\n
\n \n
\n
\n
\n
\n
\n

links

\n
\n

[object]

\n

A list of links for the entity.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Link name.

\n
\n \n
\n
\n
\n
\n
\n

provider

\n
\n

string

\n

Link provider.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Link type.

default: other

\n
\n \n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

Link URL.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

managed

\n
\n

object

\n

A read-only set of Datadog managed attributes generated by Datadog. User supplied values are ignored.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Unique name given to an entity under the kind/namespace.

\n
\n \n
\n
\n
\n
\n
\n

namespace

\n
\n

string

\n

Namespace is a part of unique identifier. It has a default value of 'default'.

\n
\n \n
\n
\n
\n
\n
\n

owner

\n
\n

string

\n

The owner of the entity, usually a team.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A set of custom tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

spec

\n
\n

object

\n

The definition of Entity V3 System Spec object.

\n
\n
\n
\n
\n
\n

components

\n
\n

[string]

\n

A list of components belongs to the system.

\n
\n \n
\n
\n
\n
\n
\n

lifecycle

\n
\n

string

\n

The lifecycle state of the component.

\n
\n \n
\n
\n
\n
\n
\n

tier

\n
\n

string

\n

An entity reference to the owner of the component.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Schema for API entities.

\n
\n
\n
\n
\n
\n

apiVersion [required]

\n
\n

enum

\n

The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version. \nAllowed enum values: v3,v2.2,v2.1,v2

\n
\n \n
\n
\n
\n
\n
\n

datadog

\n
\n

object

\n

Datadog product integrations for the API entity.

\n
\n
\n
\n
\n
\n

codeLocations

\n
\n

[object]

\n

Schema for mapping source code locations to an entity.

\n
\n
\n
\n
\n
\n

paths

\n
\n

[string]

\n

The paths (glob) to the source code of the service.

\n
\n \n
\n
\n
\n
\n
\n

repositoryURL

\n
\n

string

\n

The repository path of the source code of the entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

events

\n
\n

[object]

\n

Events associations.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The query to run.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

logs

\n
\n

[object]

\n

Logs association.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the query.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The query to run.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

performanceData

\n
\n

object

\n

Performance stats association.

\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A list of APM entity tags that associates the APM Stats data with the entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

pipelines

\n
\n

object

\n

CI Pipelines association.

\n
\n
\n
\n
\n
\n

fingerprints

\n
\n

[string]

\n

A list of CI Fingerprints that associate CI Pipelines with the entity.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

extensions

\n
\n

object

\n

Custom extensions. This is the free-formed field to send client-side metadata. No Datadog features are affected by this field.

\n
\n \n
\n
\n
\n
\n
\n

integrations

\n
\n

object

\n

A base schema for defining third-party integrations.

\n
\n
\n
\n
\n
\n

opsgenie

\n
\n

object

\n

An Opsgenie integration schema.

\n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

The region for the Opsgenie integration.

\n
\n \n
\n
\n
\n
\n
\n

serviceURL [required]

\n
\n

string

\n

The service URL for the Opsgenie integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

pagerduty

\n
\n

object

\n

A PagerDuty integration schema.

\n
\n
\n
\n
\n
\n

serviceURL [required]

\n
\n

string

\n

The service URL for the PagerDuty integration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of Entity V3 API Kind object. \nAllowed enum values: api

\n
\n \n
\n
\n
\n
\n
\n

metadata [required]

\n
\n

object

\n

The definition of Entity V3 Metadata object.

\n
\n
\n
\n
\n
\n

additionalOwners

\n
\n

[object]

\n

The additional owners of the entity, usually a team.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Team name.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Team type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

contacts

\n
\n

[object]

\n

A list of contacts for the entity.

\n
\n
\n
\n
\n
\n

contact [required]

\n
\n

string

\n

Contact value.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Contact name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Contact type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Short description of the entity. The UI can leverage the description for display.

\n
\n \n
\n
\n
\n
\n
\n

displayName

\n
\n

string

\n

User friendly name of the entity. The UI can leverage the display name for display.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored.

\n
\n \n
\n
\n
\n
\n
\n

inheritFrom

\n
\n

string

\n

The entity reference from which to inherit metadata

\n
\n \n
\n
\n
\n
\n
\n

links

\n
\n

[object]

\n

A list of links for the entity.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Link name.

\n
\n \n
\n
\n
\n
\n
\n

provider

\n
\n

string

\n

Link provider.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Link type.

default: other

\n
\n \n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

Link URL.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

managed

\n
\n

object

\n

A read-only set of Datadog managed attributes generated by Datadog. User supplied values are ignored.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Unique name given to an entity under the kind/namespace.

\n
\n \n
\n
\n
\n
\n
\n

namespace

\n
\n

string

\n

Namespace is a part of unique identifier. It has a default value of 'default'.

\n
\n \n
\n
\n
\n
\n
\n

owner

\n
\n

string

\n

The owner of the entity, usually a team.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A set of custom tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

spec

\n
\n

object

\n

The definition of Entity V3 API Spec object.

\n
\n
\n
\n
\n
\n

implementedBy

\n
\n

[string]

\n

Services which implemented the API.

\n
\n \n
\n
\n
\n
\n
\n

interface

\n
\n

 <oneOf>

\n

The API definition.

\n
\n \n
\n
\n
\n
\n
\n

lifecycle

\n
\n

string

\n

The lifecycle state of the component.

\n
\n \n
\n
\n
\n
\n
\n

tier

\n
\n

string

\n

The importance of the component.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

The type of API.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

string

\n

Entity definition in raw JSON or YAML representation.

\n
\n \n
\n
" } }, "DeleteCatalogEntity": { diff --git a/data/api/v2/full_spec.yaml b/data/api/v2/full_spec.yaml index 88c3b96d79bdc..b57792356d9a3 100644 --- a/data/api/v2/full_spec.yaml +++ b/data/api/v2/full_spec.yaml @@ -13498,14 +13498,21 @@ components: type: string type: object EntityV3APIVersion: - description: The schema version of entity type. The field is known as schema-version - in the previous version. + description: The version of the schema data that was used to populate this entity's + data. This could be via the API, Terraform, or YAML file in a repository. + The field is known as schema-version in the previous version. enum: - v3 + - v2.2 + - v2.1 + - v2 example: v3 type: string x-enum-varnames: - V3 + - V2_2 + - V2_1 + - V2 EntityV3DatadogCodeLocationItem: additionalProperties: false description: Code location item. diff --git a/data/api/v2/full_spec_deref.json b/data/api/v2/full_spec_deref.json index 8a59caf9e1d1d..1a4a9b6ca2430 100644 --- a/data/api/v2/full_spec_deref.json +++ b/data/api/v2/full_spec_deref.json @@ -74026,14 +74026,20 @@ "description": "Schema for service entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -74402,14 +74408,20 @@ "description": "Schema for datastore entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -74728,14 +74740,20 @@ "description": "Schema for queue entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -75054,14 +75072,20 @@ "description": "Schema for system entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -75389,14 +75413,20 @@ "description": "Schema for API entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -75807,14 +75837,20 @@ "description": "Schema for service entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -76183,14 +76219,20 @@ "description": "Schema for datastore entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -76509,14 +76551,20 @@ "description": "Schema for queue entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -76835,14 +76883,20 @@ "description": "Schema for system entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -77170,14 +77224,20 @@ "description": "Schema for API entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -77706,14 +77766,20 @@ "description": "Schema for service entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -78082,14 +78148,20 @@ "description": "Schema for datastore entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -78408,14 +78480,20 @@ "description": "Schema for queue entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -78734,14 +78812,20 @@ "description": "Schema for system entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -79069,14 +79153,20 @@ "description": "Schema for API entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -79461,14 +79551,20 @@ "description": "Schema for API entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -80062,14 +80158,20 @@ "type": "object" }, "EntityV3APIVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "EntityV3DatadogCodeLocationItem": { @@ -80253,14 +80355,20 @@ "description": "Schema for datastore entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -80952,14 +81060,20 @@ "description": "Schema for queue entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -81379,14 +81493,20 @@ "description": "Schema for service entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -81906,14 +82026,20 @@ "description": "Schema for system entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -133937,14 +134063,20 @@ "description": "Schema for service entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -134313,14 +134445,20 @@ "description": "Schema for datastore entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -134639,14 +134777,20 @@ "description": "Schema for queue entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -134965,14 +135109,20 @@ "description": "Schema for system entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -135300,14 +135450,20 @@ "description": "Schema for API entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -135963,14 +136119,20 @@ "description": "Schema for service entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -136339,14 +136501,20 @@ "description": "Schema for datastore entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -136665,14 +136833,20 @@ "description": "Schema for queue entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -136991,14 +137165,20 @@ "description": "Schema for system entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -137326,14 +137506,20 @@ "description": "Schema for API entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -137950,14 +138136,20 @@ "description": "Schema for service entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -138326,14 +138518,20 @@ "description": "Schema for datastore entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -138652,14 +138850,20 @@ "description": "Schema for queue entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -138978,14 +139182,20 @@ "description": "Schema for system entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -139313,14 +139523,20 @@ "description": "Schema for API entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -293908,14 +294124,20 @@ "description": "Schema for service entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -294284,14 +294506,20 @@ "description": "Schema for datastore entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -294610,14 +294838,20 @@ "description": "Schema for queue entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -294936,14 +295170,20 @@ "description": "Schema for system entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -295271,14 +295511,20 @@ "description": "Schema for API entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -295886,14 +296132,20 @@ "description": "Schema for service entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -296262,14 +296514,20 @@ "description": "Schema for datastore entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -296588,14 +296846,20 @@ "description": "Schema for queue entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -296914,14 +297178,20 @@ "description": "Schema for system entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -297249,14 +297519,20 @@ "description": "Schema for API entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -297698,14 +297974,20 @@ "description": "Schema for service entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -298074,14 +298356,20 @@ "description": "Schema for datastore entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -298400,14 +298688,20 @@ "description": "Schema for queue entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -298726,14 +299020,20 @@ "description": "Schema for system entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -299061,14 +299361,20 @@ "description": "Schema for API entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -299489,14 +299795,20 @@ "description": "Schema for service entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -299865,14 +300177,20 @@ "description": "Schema for datastore entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -300191,14 +300509,20 @@ "description": "Schema for queue entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -300517,14 +300841,20 @@ "description": "Schema for system entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -300852,14 +301182,20 @@ "description": "Schema for API entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -346206,14 +346542,20 @@ "description": "Schema for service entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -346582,14 +346924,20 @@ "description": "Schema for datastore entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -346908,14 +347256,20 @@ "description": "Schema for queue entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -347234,14 +347588,20 @@ "description": "Schema for system entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -347569,14 +347929,20 @@ "description": "Schema for API entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -348316,14 +348682,20 @@ "description": "Schema for service entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -348692,14 +349064,20 @@ "description": "Schema for datastore entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -349018,14 +349396,20 @@ "description": "Schema for queue entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -349344,14 +349728,20 @@ "description": "Schema for system entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -349679,14 +350069,20 @@ "description": "Schema for API entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -350303,14 +350699,20 @@ "description": "Schema for service entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -350679,14 +351081,20 @@ "description": "Schema for datastore entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -351005,14 +351413,20 @@ "description": "Schema for queue entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -351331,14 +351745,20 @@ "description": "Schema for system entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -351666,14 +352086,20 @@ "description": "Schema for API entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { diff --git a/static/resources/json/full_spec_v2.json b/static/resources/json/full_spec_v2.json index 8a59caf9e1d1d..1a4a9b6ca2430 100644 --- a/static/resources/json/full_spec_v2.json +++ b/static/resources/json/full_spec_v2.json @@ -74026,14 +74026,20 @@ "description": "Schema for service entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -74402,14 +74408,20 @@ "description": "Schema for datastore entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -74728,14 +74740,20 @@ "description": "Schema for queue entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -75054,14 +75072,20 @@ "description": "Schema for system entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -75389,14 +75413,20 @@ "description": "Schema for API entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -75807,14 +75837,20 @@ "description": "Schema for service entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -76183,14 +76219,20 @@ "description": "Schema for datastore entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -76509,14 +76551,20 @@ "description": "Schema for queue entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -76835,14 +76883,20 @@ "description": "Schema for system entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -77170,14 +77224,20 @@ "description": "Schema for API entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -77706,14 +77766,20 @@ "description": "Schema for service entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -78082,14 +78148,20 @@ "description": "Schema for datastore entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -78408,14 +78480,20 @@ "description": "Schema for queue entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -78734,14 +78812,20 @@ "description": "Schema for system entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -79069,14 +79153,20 @@ "description": "Schema for API entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -79461,14 +79551,20 @@ "description": "Schema for API entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -80062,14 +80158,20 @@ "type": "object" }, "EntityV3APIVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "EntityV3DatadogCodeLocationItem": { @@ -80253,14 +80355,20 @@ "description": "Schema for datastore entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -80952,14 +81060,20 @@ "description": "Schema for queue entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -81379,14 +81493,20 @@ "description": "Schema for service entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -81906,14 +82026,20 @@ "description": "Schema for system entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -133937,14 +134063,20 @@ "description": "Schema for service entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -134313,14 +134445,20 @@ "description": "Schema for datastore entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -134639,14 +134777,20 @@ "description": "Schema for queue entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -134965,14 +135109,20 @@ "description": "Schema for system entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -135300,14 +135450,20 @@ "description": "Schema for API entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -135963,14 +136119,20 @@ "description": "Schema for service entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -136339,14 +136501,20 @@ "description": "Schema for datastore entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -136665,14 +136833,20 @@ "description": "Schema for queue entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -136991,14 +137165,20 @@ "description": "Schema for system entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -137326,14 +137506,20 @@ "description": "Schema for API entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -137950,14 +138136,20 @@ "description": "Schema for service entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -138326,14 +138518,20 @@ "description": "Schema for datastore entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -138652,14 +138850,20 @@ "description": "Schema for queue entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -138978,14 +139182,20 @@ "description": "Schema for system entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -139313,14 +139523,20 @@ "description": "Schema for API entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -293908,14 +294124,20 @@ "description": "Schema for service entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -294284,14 +294506,20 @@ "description": "Schema for datastore entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -294610,14 +294838,20 @@ "description": "Schema for queue entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -294936,14 +295170,20 @@ "description": "Schema for system entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -295271,14 +295511,20 @@ "description": "Schema for API entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -295886,14 +296132,20 @@ "description": "Schema for service entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -296262,14 +296514,20 @@ "description": "Schema for datastore entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -296588,14 +296846,20 @@ "description": "Schema for queue entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -296914,14 +297178,20 @@ "description": "Schema for system entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -297249,14 +297519,20 @@ "description": "Schema for API entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -297698,14 +297974,20 @@ "description": "Schema for service entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -298074,14 +298356,20 @@ "description": "Schema for datastore entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -298400,14 +298688,20 @@ "description": "Schema for queue entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -298726,14 +299020,20 @@ "description": "Schema for system entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -299061,14 +299361,20 @@ "description": "Schema for API entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -299489,14 +299795,20 @@ "description": "Schema for service entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -299865,14 +300177,20 @@ "description": "Schema for datastore entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -300191,14 +300509,20 @@ "description": "Schema for queue entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -300517,14 +300841,20 @@ "description": "Schema for system entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -300852,14 +301182,20 @@ "description": "Schema for API entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -346206,14 +346542,20 @@ "description": "Schema for service entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -346582,14 +346924,20 @@ "description": "Schema for datastore entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -346908,14 +347256,20 @@ "description": "Schema for queue entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -347234,14 +347588,20 @@ "description": "Schema for system entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -347569,14 +347929,20 @@ "description": "Schema for API entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -348316,14 +348682,20 @@ "description": "Schema for service entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -348692,14 +349064,20 @@ "description": "Schema for datastore entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -349018,14 +349396,20 @@ "description": "Schema for queue entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -349344,14 +349728,20 @@ "description": "Schema for system entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -349679,14 +350069,20 @@ "description": "Schema for API entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -350303,14 +350699,20 @@ "description": "Schema for service entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -350679,14 +351081,20 @@ "description": "Schema for datastore entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -351005,14 +351413,20 @@ "description": "Schema for queue entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -351331,14 +351745,20 @@ "description": "Schema for system entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": { @@ -351666,14 +352086,20 @@ "description": "Schema for API entities.", "properties": { "apiVersion": { - "description": "The schema version of entity type. The field is known as schema-version in the previous version.", + "description": "The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.", "enum": [ - "v3" + "v3", + "v2.2", + "v2.1", + "v2" ], "example": "v3", "type": "string", "x-enum-varnames": [ - "V3" + "V3", + "V2_2", + "V2_1", + "V2" ] }, "datadog": {