Aliases

Aliases are references to entities in external systems. They are organized by alias type, with each type containing a list of alias entry definitions.

To remove an alias, simply update or upsert a catalog entity with the alias type and an empty array [] as the value instead of any entry identifiers. Omitted alias types will not be affected.

The key in the object is the distinct alias type.

Example Request

When creating or updating aliases, only the identifier field is required. The API will fetch the name and optional url from the Data Cloud database, based on the identifier.

{
  "github_repo": [
    {
      "identifier": "671150935"
    }
  ],
  "pagerduty_service": [
    {
      "identifier": "P123ABC"
    }
  ]
}

Example Response

The API response will include the name and optional url fields that were fetched from the Data Cloud database:

{
  "github_repo": [
    {
      "identifier": "671150935",
      "name": "get-dx/payment-processing",
      "url": "https://github.com/get-dx/payment-processing"
    }
  ],
  "pagerduty_service": [
    {
      "identifier": "P123ABC",
      "name": "Payment Service"
    }
  ]
}

Supported alias types

See the catalog docs for a list of supported aliases.

Properties