Retrieves a Catalog Entity

GET

catalog_entities

{id}

curl --request GET \
  --url https://api.rootly.com/v1/catalog_entities/{id} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "id": "<string>",
    "type": "catalog_entities",
    "attributes": {
      "name": "<string>",
      "position": 123,
      "created_at": "<string>",
      "updated_at": "<string>",
      "description": "<string>",
      "backstage_id": "<string>",
      "external_id": "<string>",
      "properties": [
        {
          "catalog_property_id": "<string>",
          "value": "<string>"
        }
      ]
    }
  },
  "included": [
    {
      "id": "<string>",
      "type": "<string>",
      "attributes": {},
      "relationships": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

required

Resource UUID

Query Parameters

include

enum<string>

comma separated if needed. eg: catalog,properties

Available options:

catalog,

properties

Response

catalog_entity found by slug

data

object

required

Show child attributes

included

object[]

Show child attributes

Update a Catalog EntityUpdate a specific Catalog Entity by id

⌘I

Retrieves a Catalog Entity

curl --request GET \
  --url https://api.rootly.com/v1/catalog_entities/{id} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "id": "<string>",
    "type": "catalog_entities",
    "attributes": {
      "name": "<string>",
      "position": 123,
      "created_at": "<string>",
      "updated_at": "<string>",
      "description": "<string>",
      "backstage_id": "<string>",
      "external_id": "<string>",
      "properties": [
        {
          "catalog_property_id": "<string>",
          "value": "<string>"
        }
      ]
    }
  },
  "included": [
    {
      "id": "<string>",
      "type": "<string>",
      "attributes": {},
      "relationships": {}
    }
  ]
}