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

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

Possible Alias Types

Properties