---
title: Import Entities
description: Datadog, the leading service for cloud-scale monitoring.
breadcrumbs: >-
  Docs > Internal Developer Portal > Software Catalog > Set Up Software Catalog
  > Import Entities
---

# Import Entities

{% callout %}
# Important note for users on the following Datadog sites: app.ddog-gov.com

{% alert level="danger" %}
This product is not supported for your selected [Datadog site](https://docs.datadoghq.com/getting_started/site). ().
{% /alert %}

{% /callout %}

## Overview{% #overview %}

If you already have data or services registered in Backstage or ServiceNow, you can import these services into Datadog directly.

## Entities from Backstage{% #entities-from-backstage %}

### Sync Backstage entities into Datadog Software Catalog{% #sync-backstage-entities-into-datadog-software-catalog %}

Use the [Datadog Backstage plugin](https://www.npmjs.com/package/@datadog/backstage-plugin-datadog-entity-sync-backend) to automatically sync your Backstage catalog entities to the Datadog Software Catalog [entity model](https://docs.datadoghq.com/internal_developer_portal/software_catalog/entity_model/) on a configurable schedule. The plugin runs as a Backstage backend service and supports entity filtering (for example, you can sync only entities with a specific Backstage component type, such as services or repositories).

You need a Datadog [API key](https://docs.datadoghq.com/account_management/api-app-keys/#api-keys), [application key](https://docs.datadoghq.com/account_management/api-app-keys/#application-keys), and [Datadog site](https://docs.datadoghq.com/getting_started/site/) parameter (for example, `datadoghq.com`) to configure the plugin. For installation and configuration instructions, see the [plugin README](https://github.com/DataDog/datadog-backstage-plugins/blob/main/plugins/datadog-entity-sync-backend/README.md).

### Import entity descriptor files from Backstage{% #import-entity-descriptor-files-from-backstage %}

{% image
   source="https://datadog-docs.imgix.net/images/tracing/software_catalog/software-catalog-backstage-import.45a32549b9689023db802b61af97b74d.png?auto=format"
   alt="Service panel highlighting backstage metadata, links and definition" /%}

To import Backstage definitions:

- **API or Terraform**: Replace the YAMLs in your requests with Backstage YAMLs.
- **GitHub integration**: Save your Backstage YAMLs in a repository with Datadog read permissions. Datadog scans for files named `catalog-info.yaml` in your repositories.

During import, Datadog maps Backstage data to Datadog data:

| Backstage Field                                                    | Datadog Mapping                                                                   |
| ------------------------------------------------------------------ | --------------------------------------------------------------------------------- |
| `kind:component` and `kind:system`                                 | Datadog recognizes these; `kind:component` is recognized as a service             |
| `metadata.name`                                                    | `dd-service`                                                                      |
| `metadata.namespace`                                               | Custom tag with format `namespace:${metadata.namespace}`                          |
| `spec.lifecycle`                                                   | `lifecycle`                                                                       |
| `spec.owner`                                                       | `team`                                                                            |
| `metadata.links`                                                   | `links`                                                                           |
| Annotation `github.com/project-slug`                               | Link with `type=repo` and `url=https://www.github.com/${github.com/project-slug}` |
| Annotations `pagerduty.com/service-id` and `pagerduty.com/account` | Combined and mapped to `integration.pagerduty`                                    |
| `metadata.description`                                             | `description`                                                                     |
| `spec.system`                                                      | `application`                                                                     |
| `spec.dependsOn`                                                   | `dependsOn`                                                                       |
| Other `spec` values                                                | Mapped to custom tags                                                             |

{% alert level="danger" %}
The Software Catalog processes the entire YAML file as a whole. If any section of the YAML file does not have `kind:component` or `kind:system`, the entire `catalog-info.yaml` file is rejected. Schema version v3.0 is required to use kind:system and the `dependsOn` field.
{% /alert %}

#### Example YAML for catalog-info.yaml{% #example-yaml-for-catalog-infoyaml %}

In the `catalog-info.yaml` file:

```yaml
apiVersion: backstage.io/v1alpha1
kind: Component
metadata:
  name: artist-web
  description: The place to be, for great artists
spec:
  type: service
  lifecycle: production
  owner: artist-relations-team
  system: artist-engagement-portal
  dependsOn:
    - service:email-service
```

## Import from ServiceNow{% #import-from-servicenow %}

To populate your Datadog Software Catalog with services from your ServiceNow Configuration Management Database (CMDB), use the Service Ingestion feature in the [Datadog-ServiceNow integration](https://docs.datadoghq.com/integrations/servicenow/#service-ingestion).

{% image
   source="https://datadog-docs.imgix.net/images/integrations/servicenow/service-metadata.dbb565d22f09664703f33820ea7f09cf.jpg?auto=format"
   alt="Screenshot of the Service Configuration panel showing metadata populated from ServiceNow" /%}

## Further reading{% #further-reading %}

- [Import Backstage YAML files into Datadog](https://www.datadoghq.com/blog/service-catalog-backstage-yaml/)
- [Manage your infrastructure with ServiceNow CMDB and Datadog](https://www.datadoghq.com/blog/servicenow-cmdb-it-management-datadog/#get-cmdb-metadata-in-the-datadog-service-catalog)