APIs

This table contains APIs, which are interfaces exposed by services for internal or external communication. Populated by APM or the Software Catalog.

dd.apis

Fields

TitleIDTypeData TypeDescription
NamenamecorestringThe unique name assigned to the API, used for identification and categorization. It's meant to be both human-recognizable and machines to use it as a reference.
Display Namedisplay_namecorestringThe preferred display name of entity, often used if the name field is overly technical or not descriptive.
DescriptiondescriptioncorestringProvides detailed information about the function or purpose of the API.
TagstagscorehstoreThis field contains an array of tags, each represented as a key-value pair, used to categorize and provide metadata about the associated entity.
OwnerownercorestringRepresents the handle for the team that owns the API.
LifecyclelifecyclecorestringIndicates the current stage of the API or product as defined by the owner, such as 'production', 'development', or 'stable'.
TiertiercorestringIndicates the classification or level of API as defined by the owner, which may affect priority or access. Common values include different tier levels such as Tier1, Tier2, etc.
Languageslanguagescorearray<string>The list of programming languages that the API is written in. Each element in the array represents a language used or supported.
TypetypecorestringIndicates the type of API specification, such as OpenAPI or AsyncAPI, used to define the service interface.
Definition API Versiondefinition_api_versioncorestringThe version of the definition used to register the entity, often in the form of a YAML file in a repository.
Interface File Refinterface_file_refcorestringStores the URL link to the interface file, which provides the specification details for the API catalog.
Interface Definitioninterface_definitioncorestringThe definition of the API. This is OpenAPI for type:openapi. Other formats are not supported yet.