---
title: "Preview catalog entities"
method: POST
path: "/api/v2/catalog/entity/preview"
tags: ["Software Catalog"]
---

# Preview catalog entities

`POST /api/v2/catalog/entity/preview`

## Request

- Base URL: `https://api.datadoghq.com`
- URL: `https://api.datadoghq.com/api/v2/catalog/entity/preview`
- Auth: one of:
  - API key in header `DD-API-KEY` and API key in header `DD-APPLICATION-KEY`
  - OAuth 2
    - Authorization code: `/oauth2/v1/authorize`
    - Token URL: `/oauth2/v1/token` scopes: `apm_service_catalog_read`

## Response `202`

Accepted

- EntityResponseArray: Response object containing an array of entity data items.
  - `data` PreviewEntityResponseData[], required: Array of entity response data items.
    - `attributes` EntityResponseDataAttributes: Entity response attributes containing core entity metadata fields.
      - `apiVersion` string: The API version of the entity schema.
      - `description` string: A short description of the entity.
      - `displayName` string: The user-friendly display name of the entity.
      - `kind` string: The kind of the entity (e.g. service, datastore, queue).
      - `name` string: The unique name of the entity within its kind and namespace.
      - `namespace` string: The namespace the entity belongs to.
      - `owner` string: The owner of the entity, usually a team.
      - `properties` object: Additional custom properties for the entity.
      - `tags` string[]: A set of custom tags assigned to the entity.
    - `id` string: Entity unique identifier.
    - `relationships` EntityResponseDataRelationships: Entity relationships including incidents, oncalls, schemas, and related entities.
      - `incidents` EntityResponseDataRelationshipsIncidents: Incidents relationship containing a list of incident resources associated with this entity.
        - `data` EntityResponseDataRelationshipsIncidentsDataItems[]: List of incident relationship data items.
          - `id` string, required: Incident resource unique identifier.
          - `type` 'incident', required: Incident resource type.
      - `oncalls` EntityResponseDataRelationshipsOncalls: Oncalls relationship containing a list of oncall resources associated with this entity.
        - `data` EntityResponseDataRelationshipsOncallsDataItems[]: List of oncall relationship data items.
          - `id` string, required: Oncall resource unique identifier.
          - `type` 'oncall', required: Oncall resource type.
      - `rawSchema` EntityResponseDataRelationshipsRawSchema: Raw schema relationship linking an entity to its raw schema resource.
        - `data` EntityResponseDataRelationshipsRawSchemaData, required: Raw schema relationship data containing the raw schema resource identifier and type.
          - `id` string, required: Raw schema unique identifier.
          - `type` 'rawSchema', required: Raw schema resource type.
      - `relatedEntities` EntityResponseDataRelationshipsRelatedEntities: Related entities relationship containing a list of entity references related to this entity.
        - `data` EntityResponseDataRelationshipsRelatedEntitiesDataItems[]: List of related entity relationship data items.
          - `id` string, required: Related entity unique identifier.
          - `type` 'relatedEntity', required: Related entity resource type.
      - `schema` EntityResponseDataRelationshipsSchema: Schema relationship linking an entity to its associated schema resource.
        - `data` EntityResponseDataRelationshipsSchemaData, required: Schema relationship data containing the schema resource identifier and type.
          - `id` string, required: Entity schema unique identifier.
          - `type` 'schema', required: Schema resource type.
    - `type` 'entity', required: Entity resource type.

## Other responses

- `429`: Too many requests

---

[API](https://skmtc.dev/datadog/apis/datadog-api-v2-collection.md) - [All operations](https://skmtc.dev/datadog/apis/datadog-api-v2-collection/llms.txt) - [OpenAPI document](https://skmtc.dev/datadog/apis/datadog-api-v2-collection/revisions/da68bf029e4c?raw)