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, 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. Each alias entry must include either identifier or lookup, but not both.

Example Request

When creating or updating aliases, use identifier when you know the external system’s unique identifier for the alias entry. Use lookup when you want the API to find a single matching alias entry by name or identifier from the Data Cloud database.

A lookup value uses case-insensitive partial matching. If the lookup matches more than one alias entry, the request returns alias_lookup_ambiguous.

{
  "github_repo": [
    {
      "lookup": "get-dx/payment-processing"
    }
  ],
  "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