Setting Up API Catalog

API Catalog is not supported for your selected Datadog site ().


API Catalog uses APM instrumentation for distributed tracing to automatically discover endpoints in all environments in your Datadog organization. Endpoints for instrumented services and supported libraries are automatically populated into API Explorer.

Setting up

You can enable the API Catalog in a Datadog organization that is already consuming APM data without any additional setup. APM-instrumented services and supported libraries are automatically discovered.

If you can’t find one of your APIs or endpoints in the API Catalog, make sure it’s instrumented. If necessary, follow the instructions on the Setup page to make a service discoverable.

API Catalog Setup page showing instructions for instrumenting a Java service

Alternatively, you can add an API to the API Catalog by importing its OpenAPI definition. This approach is necessary if you don’t want to instrument the API or if it’s written in a framework that doesn’t support instrumentation and auto-detection. To import the OpenAPI definition YAML or JSON file, click Add an API on the Catalog page.

API Catalog Setup page for importing an OpenAPI definition file.

After you’ve set up the API Catalog with your APIs and endpoints, start exploring and adding catalog metadata on the API Catalog Explorer page.

Key terminology

A set of protocols and tools that allow two applications to communicate.
API endpoint
The address of a resource (URL) of a server or a service that implements the set of rules defined in the API, often through an HTTP, RESTful API interface. The API endpoint is responsible for making the API call response.

The API Catalog displays API endpoints as the HTTP method (for example, GET), the URL path (for example, /payment/{shop_id}/purchase), and the name of the service this resource serves (for example, Payments).

The API Catalog in beta supports only HTTP endpoints.
Public APIs
Customer-facing API endpoints that are accessible from the internet.
Private APIs
Also called internal APIs. These are only for internal use in an organization and are used mainly for backend service communication. These are the most common type of APIs.
Partner APIs
Also called third-party APIs. These are another organization’s public endpoints that your organization uses to provide your services (for example, Stripe, Google, and Facebook).

Further reading