--- title: "Create or update entities" method: POST path: "/api/v2/catalog/entity" tags: ["Software Catalog"] --- # Create or update entities `POST /api/v2/catalog/entity` Create or update entities in Software Catalog. ## Request body - union — Create or update entity request. - union — Entity schema v3. - EntityV3Service — Schema for service entities. - `apiVersion` 'v3' | 'v2.2' | 'v2.1' | 'v2', required — 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. - `datadog` EntityV3ServiceDatadog — Datadog product integrations for the service entity. - `codeLocations` EntityV3DatadogCodeLocationItem[] — Schema for mapping source code locations to an entity. - `paths` string[] — The paths (glob) to the source code of the service. - `repositoryURL` string — The repository path of the source code of the entity. - `events` EntityV3DatadogEventItem[] — Events associations. - `name` string — The name of the query. - `query` string — The query to run. - `logs` EntityV3DatadogLogItem[] — Logs association. - `name` string — The name of the query. - `query` string — The query to run. - `performanceData` EntityV3DatadogPerformance — Performance stats association. - `tags` string[] — A list of APM entity tags that associates the APM Stats data with the entity. - `pipelines` EntityV3DatadogPipelines — CI Pipelines association. - `fingerprints` string[] — A list of CI Fingerprints that associate CI Pipelines with the entity. - `extensions` object — Custom extensions. This is the free-formed field to send client-side metadata. No Datadog features are affected by this field. - `integrations` EntityV3Integrations — A base schema for defining third-party integrations. - `opsgenie` EntityV3DatadogIntegrationOpsgenie — An Opsgenie integration schema. - `region` string — The region for the Opsgenie integration. - `serviceURL` string, required — The service URL for the Opsgenie integration. - `pagerduty` EntityV3DatadogIntegrationPagerduty — A PagerDuty integration schema. - `serviceURL` string, required — The service URL for the PagerDuty integration. - `kind` 'service', required — The definition of Entity V3 Service Kind object. - `metadata` EntityV3Metadata, required — The definition of Entity V3 Metadata object. - `additionalOwners` EntityV3MetadataAdditionalOwnersItems[] — The additional owners of the entity, usually a team. - `name` string, required — Team name. - `type` string — Team type. - `contacts` EntityV3MetadataContactsItems[] — A list of contacts for the entity. - `contact` string, required — Contact value. - `name` string — Contact name. - `type` string, required — Contact type. - `description` string — Short description of the entity. The UI can leverage the description for display. - `displayName` string — User friendly name of the entity. The UI can leverage the display name for display. - `id` string — A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored. - `inheritFrom` string — The entity reference from which to inherit metadata - `links` EntityV3MetadataLinksItems[] — A list of links for the entity. - `name` string, required — Link name. - `provider` string — Link provider. - `type` string, required — Link type. - `url` string, required — Link URL. - `managed` object — A read-only set of Datadog managed attributes generated by Datadog. User supplied values are ignored. - `name` string, required — Unique name given to an entity under the kind/namespace. - `namespace` string — Namespace is a part of unique identifier. It has a default value of 'default'. - `owner` string — The owner of the entity, usually a team. - `tags` string[] — A set of custom tags. - `spec` EntityV3ServiceSpec — The definition of Entity V3 Service Spec object. - `componentOf` string[] — A list of components the service is a part of - `dependsOn` string[] — A list of components the service depends on. - `languages` string[] — The service's programming language. - `lifecycle` string — The lifecycle state of the component. - `tier` string — The importance of the component. - `type` string — The type of service. - EntityV3Datastore — Schema for datastore entities. - `apiVersion` 'v3' | 'v2.2' | 'v2.1' | 'v2', required — 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. - `datadog` EntityV3DatastoreDatadog — Datadog product integrations for the datastore entity. - `events` EntityV3DatadogEventItem[] — Events associations. - `name` string — The name of the query. - `query` string — The query to run. - `logs` EntityV3DatadogLogItem[] — Logs association. - `name` string — The name of the query. - `query` string — The query to run. - `performanceData` EntityV3DatadogPerformance — Performance stats association. - `tags` string[] — A list of APM entity tags that associates the APM Stats data with the entity. - `extensions` object — Custom extensions. This is the free-formed field to send client side metadata. No Datadog features are affected by this field. - `integrations` EntityV3Integrations — A base schema for defining third-party integrations. - `opsgenie` EntityV3DatadogIntegrationOpsgenie — An Opsgenie integration schema. - `region` string — The region for the Opsgenie integration. - `serviceURL` string, required — The service URL for the Opsgenie integration. - `pagerduty` EntityV3DatadogIntegrationPagerduty — A PagerDuty integration schema. - `serviceURL` string, required — The service URL for the PagerDuty integration. - `kind` 'datastore', required — The definition of Entity V3 Datastore Kind object. - `metadata` EntityV3Metadata, required — The definition of Entity V3 Metadata object. - `additionalOwners` EntityV3MetadataAdditionalOwnersItems[] — The additional owners of the entity, usually a team. - `name` string, required — Team name. - `type` string — Team type. - `contacts` EntityV3MetadataContactsItems[] — A list of contacts for the entity. - `contact` string, required — Contact value. - `name` string — Contact name. - `type` string, required — Contact type. - `description` string — Short description of the entity. The UI can leverage the description for display. - `displayName` string — User friendly name of the entity. The UI can leverage the display name for display. - `id` string — A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored. - `inheritFrom` string — The entity reference from which to inherit metadata - `links` EntityV3MetadataLinksItems[] — A list of links for the entity. - `name` string, required — Link name. - `provider` string — Link provider. - `type` string, required — Link type. - `url` string, required — Link URL. - `managed` object — A read-only set of Datadog managed attributes generated by Datadog. User supplied values are ignored. - `name` string, required — Unique name given to an entity under the kind/namespace. - `namespace` string — Namespace is a part of unique identifier. It has a default value of 'default'. - `owner` string — The owner of the entity, usually a team. - `tags` string[] — A set of custom tags. - `spec` EntityV3DatastoreSpec — The definition of Entity V3 Datastore Spec object. - `componentOf` string[] — A list of components the datastore is a part of - `lifecycle` string — The lifecycle state of the datastore. - `tier` string — The importance of the datastore. - `type` string — The type of datastore. - EntityV3Queue — Schema for queue entities. - `apiVersion` 'v3' | 'v2.2' | 'v2.1' | 'v2', required — 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. - `datadog` EntityV3QueueDatadog — Datadog product integrations for the datastore entity. - `events` EntityV3DatadogEventItem[] — Events associations. - `name` string — The name of the query. - `query` string — The query to run. - `logs` EntityV3DatadogLogItem[] — Logs association. - `name` string — The name of the query. - `query` string — The query to run. - `performanceData` EntityV3DatadogPerformance — Performance stats association. - `tags` string[] — A list of APM entity tags that associates the APM Stats data with the entity. - `extensions` object — Custom extensions. This is the free-formed field to send client-side metadata. No Datadog features are affected by this field. - `integrations` EntityV3Integrations — A base schema for defining third-party integrations. - `opsgenie` EntityV3DatadogIntegrationOpsgenie — An Opsgenie integration schema. - `region` string — The region for the Opsgenie integration. - `serviceURL` string, required — The service URL for the Opsgenie integration. - `pagerduty` EntityV3DatadogIntegrationPagerduty — A PagerDuty integration schema. - `serviceURL` string, required — The service URL for the PagerDuty integration. - `kind` 'queue', required — The definition of Entity V3 Queue Kind object. - `metadata` EntityV3Metadata, required — The definition of Entity V3 Metadata object. - `additionalOwners` EntityV3MetadataAdditionalOwnersItems[] — The additional owners of the entity, usually a team. - `name` string, required — Team name. - `type` string — Team type. - `contacts` EntityV3MetadataContactsItems[] — A list of contacts for the entity. - `contact` string, required — Contact value. - `name` string — Contact name. - `type` string, required — Contact type. - `description` string — Short description of the entity. The UI can leverage the description for display. - `displayName` string — User friendly name of the entity. The UI can leverage the display name for display. - `id` string — A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored. - `inheritFrom` string — The entity reference from which to inherit metadata - `links` EntityV3MetadataLinksItems[] — A list of links for the entity. - `name` string, required — Link name. - `provider` string — Link provider. - `type` string, required — Link type. - `url` string, required — Link URL. - `managed` object — A read-only set of Datadog managed attributes generated by Datadog. User supplied values are ignored. - `name` string, required — Unique name given to an entity under the kind/namespace. - `namespace` string — Namespace is a part of unique identifier. It has a default value of 'default'. - `owner` string — The owner of the entity, usually a team. - `tags` string[] — A set of custom tags. - `spec` EntityV3QueueSpec — The definition of Entity V3 Queue Spec object. - `componentOf` string[] — A list of components the queue is a part of - `lifecycle` string — The lifecycle state of the queue. - `tier` string — The importance of the queue. - `type` string — The type of queue. - EntityV3System — Schema for system entities. - `apiVersion` 'v3' | 'v2.2' | 'v2.1' | 'v2', required — 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. - `datadog` EntityV3SystemDatadog — Datadog product integrations for the service entity. - `events` EntityV3DatadogEventItem[] — Events associations. - `name` string — The name of the query. - `query` string — The query to run. - `logs` EntityV3DatadogLogItem[] — Logs association. - `name` string — The name of the query. - `query` string — The query to run. - `performanceData` EntityV3DatadogPerformance — Performance stats association. - `tags` string[] — A list of APM entity tags that associates the APM Stats data with the entity. - `pipelines` EntityV3DatadogPipelines — CI Pipelines association. - `fingerprints` string[] — A list of CI Fingerprints that associate CI Pipelines with the entity. - `extensions` object — Custom extensions. This is the free-formed field to send client-side metadata. No Datadog features are affected by this field. - `integrations` EntityV3Integrations — A base schema for defining third-party integrations. - `opsgenie` EntityV3DatadogIntegrationOpsgenie — An Opsgenie integration schema. - `region` string — The region for the Opsgenie integration. - `serviceURL` string, required — The service URL for the Opsgenie integration. - `pagerduty` EntityV3DatadogIntegrationPagerduty — A PagerDuty integration schema. - `serviceURL` string, required — The service URL for the PagerDuty integration. - `kind` 'system', required — The definition of Entity V3 System Kind object. - `metadata` EntityV3Metadata, required — The definition of Entity V3 Metadata object. - `additionalOwners` EntityV3MetadataAdditionalOwnersItems[] — The additional owners of the entity, usually a team. - `name` string, required — Team name. - `type` string — Team type. - `contacts` EntityV3MetadataContactsItems[] — A list of contacts for the entity. - `contact` string, required — Contact value. - `name` string — Contact name. - `type` string, required — Contact type. - `description` string — Short description of the entity. The UI can leverage the description for display. - `displayName` string — User friendly name of the entity. The UI can leverage the display name for display. - `id` string — A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored. - `inheritFrom` string — The entity reference from which to inherit metadata - `links` EntityV3MetadataLinksItems[] — A list of links for the entity. - `name` string, required — Link name. - `provider` string — Link provider. - `type` string, required — Link type. - `url` string, required — Link URL. - `managed` object — A read-only set of Datadog managed attributes generated by Datadog. User supplied values are ignored. - `name` string, required — Unique name given to an entity under the kind/namespace. - `namespace` string — Namespace is a part of unique identifier. It has a default value of 'default'. - `owner` string — The owner of the entity, usually a team. - `tags` string[] — A set of custom tags. - `spec` EntityV3SystemSpec — The definition of Entity V3 System Spec object. - `components` string[] — A list of components belongs to the system. - `lifecycle` string — The lifecycle state of the component. - `tier` string — An entity reference to the owner of the component. - EntityV3API — Schema for API entities. - `apiVersion` 'v3' | 'v2.2' | 'v2.1' | 'v2', required — 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. - `datadog` EntityV3APIDatadog — Datadog product integrations for the API entity. - `codeLocations` EntityV3DatadogCodeLocationItem[] — Schema for mapping source code locations to an entity. - `paths` string[] — The paths (glob) to the source code of the service. - `repositoryURL` string — The repository path of the source code of the entity. - `events` EntityV3DatadogEventItem[] — Events associations. - `name` string — The name of the query. - `query` string — The query to run. - `logs` EntityV3DatadogLogItem[] — Logs association. - `name` string — The name of the query. - `query` string — The query to run. - `performanceData` EntityV3DatadogPerformance — Performance stats association. - `tags` string[] — A list of APM entity tags that associates the APM Stats data with the entity. - `pipelines` EntityV3DatadogPipelines — CI Pipelines association. - `fingerprints` string[] — A list of CI Fingerprints that associate CI Pipelines with the entity. - `extensions` object — Custom extensions. This is the free-formed field to send client-side metadata. No Datadog features are affected by this field. - `integrations` EntityV3Integrations — A base schema for defining third-party integrations. - `opsgenie` EntityV3DatadogIntegrationOpsgenie — An Opsgenie integration schema. - `region` string — The region for the Opsgenie integration. - `serviceURL` string, required — The service URL for the Opsgenie integration. - `pagerduty` EntityV3DatadogIntegrationPagerduty — A PagerDuty integration schema. - `serviceURL` string, required — The service URL for the PagerDuty integration. - `kind` 'api', required — The definition of Entity V3 API Kind object. - `metadata` EntityV3Metadata, required — The definition of Entity V3 Metadata object. - `additionalOwners` EntityV3MetadataAdditionalOwnersItems[] — The additional owners of the entity, usually a team. - `name` string, required — Team name. - `type` string — Team type. - `contacts` EntityV3MetadataContactsItems[] — A list of contacts for the entity. - `contact` string, required — Contact value. - `name` string — Contact name. - `type` string, required — Contact type. - `description` string — Short description of the entity. The UI can leverage the description for display. - `displayName` string — User friendly name of the entity. The UI can leverage the display name for display. - `id` string — A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored. - `inheritFrom` string — The entity reference from which to inherit metadata - `links` EntityV3MetadataLinksItems[] — A list of links for the entity. - `name` string, required — Link name. - `provider` string — Link provider. - `type` string, required — Link type. - `url` string, required — Link URL. - `managed` object — A read-only set of Datadog managed attributes generated by Datadog. User supplied values are ignored. - `name` string, required — Unique name given to an entity under the kind/namespace. - `namespace` string — Namespace is a part of unique identifier. It has a default value of 'default'. - `owner` string — The owner of the entity, usually a team. - `tags` string[] — A set of custom tags. - `spec` EntityV3APISpec — The definition of Entity V3 API Spec object. - `implementedBy` string[] — Services which implemented the API. - `interface` union — The API definition. - object — The definition of `EntityV3APISpecInterfaceFileRef` object. - `fileRef` string — The reference to the API definition file. - object — The definition of `EntityV3APISpecInterfaceDefinition` object. - `definition` object — The API definition. - `lifecycle` string — The lifecycle state of the component. - `tier` string — The importance of the component. - `type` string — The type of API. - string — Entity definition in raw JSON or YAML representation. ## Response `202` ACCEPTED - UpsertCatalogEntityResponse — Upsert entity response. - `data` EntityData[] — List of entity data. - `attributes` EntityAttributes — Entity attributes. - `apiVersion` string — The API version. - `description` string — The description. - `displayName` string — The display name. - `kind` string — The kind. - `name` string — The name. - `namespace` string — The namespace. - `owner` string — The owner. - `tags` string[] — The tags. - `id` string — Entity ID. - `meta` EntityMeta — Entity metadata. - `createdAt` string — The creation time. - `ingestionSource` string — The ingestion source. - `modifiedAt` string — The modification time. - `origin` string — The origin. - `relationships` EntityRelationships — Entity relationships. - `incidents` EntityToIncidents — Entity to incidents relationship. - `data` RelationshipItem[] — Relationships. - `id` string — Associated data ID. - `type` string — Relationship type. - `oncall` EntityToOncalls — Entity to oncalls relationship. - `data` RelationshipItem[] — Relationships. - `id` string — Associated data ID. - `type` string — Relationship type. - `rawSchema` EntityToRawSchema — Entity to raw schema relationship. - `data` RelationshipItem — Relationship entry. - `id` string — Associated data ID. - `type` string — Relationship type. - `relatedEntities` EntityToRelatedEntities — Entity to related entities relationship. - `data` RelationshipItem[] — Relationships. - `id` string — Associated data ID. - `type` string — Relationship type. - `schema` EntityToSchema — Entity to detail schema relationship. - `data` RelationshipItem — Relationship entry. - `id` string — Associated data ID. - `type` string — Relationship type. - `type` string — Entity. - `included` UpsertCatalogEntityResponseIncludedItem[] — Upsert entity response included. - `attributes` EntityResponseIncludedSchemaAttributes — Included schema. - `schema` union — Entity schema v3. - EntityV3Service — Schema for service entities. - `apiVersion` 'v3' | 'v2.2' | 'v2.1' | 'v2', required — 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. - `datadog` EntityV3ServiceDatadog — Datadog product integrations for the service entity. - `codeLocations` EntityV3DatadogCodeLocationItem[] — Schema for mapping source code locations to an entity. - … - `events` EntityV3DatadogEventItem[] — Events associations. - … - `logs` EntityV3DatadogLogItem[] — Logs association. - … - `performanceData` EntityV3DatadogPerformance — Performance stats association. - … - `pipelines` EntityV3DatadogPipelines — CI Pipelines association. - … - `extensions` object — Custom extensions. This is the free-formed field to send client-side metadata. No Datadog features are affected by this field. - `integrations` EntityV3Integrations — A base schema for defining third-party integrations. - `opsgenie` EntityV3DatadogIntegrationOpsgenie — An Opsgenie integration schema. - … - `pagerduty` EntityV3DatadogIntegrationPagerduty — A PagerDuty integration schema. - … - `kind` 'service', required — The definition of Entity V3 Service Kind object. - `metadata` EntityV3Metadata, required — The definition of Entity V3 Metadata object. - `additionalOwners` EntityV3MetadataAdditionalOwnersItems[] — The additional owners of the entity, usually a team. - … - `contacts` EntityV3MetadataContactsItems[] — A list of contacts for the entity. - … - `description` string — Short description of the entity. The UI can leverage the description for display. - `displayName` string — User friendly name of the entity. The UI can leverage the display name for display. - `id` string — A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored. - `inheritFrom` string — The entity reference from which to inherit metadata - `links` EntityV3MetadataLinksItems[] — A list of links for the entity. - … - `managed` object — A read-only set of Datadog managed attributes generated by Datadog. User supplied values are ignored. - `name` string, required — Unique name given to an entity under the kind/namespace. - `namespace` string — Namespace is a part of unique identifier. It has a default value of 'default'. - `owner` string — The owner of the entity, usually a team. - `tags` string[] — A set of custom tags. - `spec` EntityV3ServiceSpec — The definition of Entity V3 Service Spec object. - `componentOf` string[] — A list of components the service is a part of - `dependsOn` string[] — A list of components the service depends on. - `languages` string[] — The service's programming language. - `lifecycle` string — The lifecycle state of the component. - `tier` string — The importance of the component. - `type` string — The type of service. - EntityV3Datastore — Schema for datastore entities. - `apiVersion` 'v3' | 'v2.2' | 'v2.1' | 'v2', required — 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. - `datadog` EntityV3DatastoreDatadog — Datadog product integrations for the datastore entity. - `events` EntityV3DatadogEventItem[] — Events associations. - … - `logs` EntityV3DatadogLogItem[] — Logs association. - … - `performanceData` EntityV3DatadogPerformance — Performance stats association. - … - `extensions` object — Custom extensions. This is the free-formed field to send client side metadata. No Datadog features are affected by this field. - `integrations` EntityV3Integrations — A base schema for defining third-party integrations. - `opsgenie` EntityV3DatadogIntegrationOpsgenie — An Opsgenie integration schema. - … - `pagerduty` EntityV3DatadogIntegrationPagerduty — A PagerDuty integration schema. - … - `kind` 'datastore', required — The definition of Entity V3 Datastore Kind object. - `metadata` EntityV3Metadata, required — The definition of Entity V3 Metadata object. - `additionalOwners` EntityV3MetadataAdditionalOwnersItems[] — The additional owners of the entity, usually a team. - … - `contacts` EntityV3MetadataContactsItems[] — A list of contacts for the entity. - … - `description` string — Short description of the entity. The UI can leverage the description for display. - `displayName` string — User friendly name of the entity. The UI can leverage the display name for display. - `id` string — A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored. - `inheritFrom` string — The entity reference from which to inherit metadata - `links` EntityV3MetadataLinksItems[] — A list of links for the entity. - … - `managed` object — A read-only set of Datadog managed attributes generated by Datadog. User supplied values are ignored. - `name` string, required — Unique name given to an entity under the kind/namespace. - `namespace` string — Namespace is a part of unique identifier. It has a default value of 'default'. - `owner` string — The owner of the entity, usually a team. - `tags` string[] — A set of custom tags. - `spec` EntityV3DatastoreSpec — The definition of Entity V3 Datastore Spec object. - `componentOf` string[] — A list of components the datastore is a part of - `lifecycle` string — The lifecycle state of the datastore. - `tier` string — The importance of the datastore. - `type` string — The type of datastore. - EntityV3Queue — Schema for queue entities. - `apiVersion` 'v3' | 'v2.2' | 'v2.1' | 'v2', required — 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. - `datadog` EntityV3QueueDatadog — Datadog product integrations for the datastore entity. - `events` EntityV3DatadogEventItem[] — Events associations. - … - `logs` EntityV3DatadogLogItem[] — Logs association. - … - `performanceData` EntityV3DatadogPerformance — Performance stats association. - … - `extensions` object — Custom extensions. This is the free-formed field to send client-side metadata. No Datadog features are affected by this field. - `integrations` EntityV3Integrations — A base schema for defining third-party integrations. - `opsgenie` EntityV3DatadogIntegrationOpsgenie — An Opsgenie integration schema. - … - `pagerduty` EntityV3DatadogIntegrationPagerduty — A PagerDuty integration schema. - … - `kind` 'queue', required — The definition of Entity V3 Queue Kind object. - `metadata` EntityV3Metadata, required — The definition of Entity V3 Metadata object. - `additionalOwners` EntityV3MetadataAdditionalOwnersItems[] — The additional owners of the entity, usually a team. - … - `contacts` EntityV3MetadataContactsItems[] — A list of contacts for the entity. - … - `description` string — Short description of the entity. The UI can leverage the description for display. - `displayName` string — User friendly name of the entity. The UI can leverage the display name for display. - `id` string — A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored. - `inheritFrom` string — The entity reference from which to inherit metadata - `links` EntityV3MetadataLinksItems[] — A list of links for the entity. - … - `managed` object — A read-only set of Datadog managed attributes generated by Datadog. User supplied values are ignored. - `name` string, required — Unique name given to an entity under the kind/namespace. - `namespace` string — Namespace is a part of unique identifier. It has a default value of 'default'. - `owner` string — The owner of the entity, usually a team. - `tags` string[] — A set of custom tags. - `spec` EntityV3QueueSpec — The definition of Entity V3 Queue Spec object. - `componentOf` string[] — A list of components the queue is a part of - `lifecycle` string — The lifecycle state of the queue. - `tier` string — The importance of the queue. - `type` string — The type of queue. - EntityV3System — Schema for system entities. - `apiVersion` 'v3' | 'v2.2' | 'v2.1' | 'v2', required — 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. - `datadog` EntityV3SystemDatadog — Datadog product integrations for the service entity. - `events` EntityV3DatadogEventItem[] — Events associations. - … - `logs` EntityV3DatadogLogItem[] — Logs association. - … - `performanceData` EntityV3DatadogPerformance — Performance stats association. - … - `pipelines` EntityV3DatadogPipelines — CI Pipelines association. - … - `extensions` object — Custom extensions. This is the free-formed field to send client-side metadata. No Datadog features are affected by this field. - `integrations` EntityV3Integrations — A base schema for defining third-party integrations. - `opsgenie` EntityV3DatadogIntegrationOpsgenie — An Opsgenie integration schema. - … - `pagerduty` EntityV3DatadogIntegrationPagerduty — A PagerDuty integration schema. - … - `kind` 'system', required — The definition of Entity V3 System Kind object. - `metadata` EntityV3Metadata, required — The definition of Entity V3 Metadata object. - `additionalOwners` EntityV3MetadataAdditionalOwnersItems[] — The additional owners of the entity, usually a team. - … - `contacts` EntityV3MetadataContactsItems[] — A list of contacts for the entity. - … - `description` string — Short description of the entity. The UI can leverage the description for display. - `displayName` string — User friendly name of the entity. The UI can leverage the display name for display. - `id` string — A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored. - `inheritFrom` string — The entity reference from which to inherit metadata - `links` EntityV3MetadataLinksItems[] — A list of links for the entity. - … - `managed` object — A read-only set of Datadog managed attributes generated by Datadog. User supplied values are ignored. - `name` string, required — Unique name given to an entity under the kind/namespace. - `namespace` string — Namespace is a part of unique identifier. It has a default value of 'default'. - `owner` string — The owner of the entity, usually a team. - `tags` string[] — A set of custom tags. - `spec` EntityV3SystemSpec — The definition of Entity V3 System Spec object. - `components` string[] — A list of components belongs to the system. - `lifecycle` string — The lifecycle state of the component. - `tier` string — An entity reference to the owner of the component. - EntityV3API — Schema for API entities. - `apiVersion` 'v3' | 'v2.2' | 'v2.1' | 'v2', required — 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. - `datadog` EntityV3APIDatadog — Datadog product integrations for the API entity. - `codeLocations` EntityV3DatadogCodeLocationItem[] — Schema for mapping source code locations to an entity. - … - `events` EntityV3DatadogEventItem[] — Events associations. - … - `logs` EntityV3DatadogLogItem[] — Logs association. - … - `performanceData` EntityV3DatadogPerformance — Performance stats association. - … - `pipelines` EntityV3DatadogPipelines — CI Pipelines association. - … - `extensions` object — Custom extensions. This is the free-formed field to send client-side metadata. No Datadog features are affected by this field. - `integrations` EntityV3Integrations — A base schema for defining third-party integrations. - `opsgenie` EntityV3DatadogIntegrationOpsgenie — An Opsgenie integration schema. - … - `pagerduty` EntityV3DatadogIntegrationPagerduty — A PagerDuty integration schema. - … - `kind` 'api', required — The definition of Entity V3 API Kind object. - `metadata` EntityV3Metadata, required — The definition of Entity V3 Metadata object. - `additionalOwners` EntityV3MetadataAdditionalOwnersItems[] — The additional owners of the entity, usually a team. - … - `contacts` EntityV3MetadataContactsItems[] — A list of contacts for the entity. - … - `description` string — Short description of the entity. The UI can leverage the description for display. - `displayName` string — User friendly name of the entity. The UI can leverage the display name for display. - `id` string — A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored. - `inheritFrom` string — The entity reference from which to inherit metadata - `links` EntityV3MetadataLinksItems[] — A list of links for the entity. - … - `managed` object — A read-only set of Datadog managed attributes generated by Datadog. User supplied values are ignored. - `name` string, required — Unique name given to an entity under the kind/namespace. - `namespace` string — Namespace is a part of unique identifier. It has a default value of 'default'. - `owner` string — The owner of the entity, usually a team. - `tags` string[] — A set of custom tags. - `spec` EntityV3APISpec — The definition of Entity V3 API Spec object. - `implementedBy` string[] — Services which implemented the API. - `interface` union — The API definition. - … - `lifecycle` string — The lifecycle state of the component. - `tier` string — The importance of the component. - `type` string — The type of API. - `id` string — Entity ID. - `type` 'schema' — Schema type. - `meta` EntityResponseMeta — Entity metadata. - `count` integer — Total entities count. - `includeCount` integer — Total included data count. ## Other responses - `400` — Bad Request - `403` — Forbidden - `429` — Too many requests --- [API](https://skmtc.net/datadog/apis/api-v2.md) · [All operations](https://skmtc.net/datadog/apis/api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/datadog/api-v2/revisions/da68bf029e4c/schema)