Retrieves a Catalog Entity

Retrieves a specific Catalog Entity by id

GET /v1/catalog_entities/{id}

Retrieves a Catalog Entity

cURL

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

200

{
  "data": {
    "id": "<string>",
    "type": "catalog_entities",
    "attributes": {
      "name": "<string>",
      "position": 123,
      "created_at": "<string>",
      "updated_at": "<string>",
      "description": "<string>",
      "fields": [
        {
          "catalog_field_id": "<string>",
          "value": "<string>"
        }
      ]
    }
  }
}

Authorizations

Authorization · string · header · required

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

Path Parameters

id · string<uuid> string · required

Resource UUID

Query Parameters

include · enum<string>

comma separated if needed. eg: catalog,properties

Available options: catalog, properties

Response

200

application/vnd.api+json

catalog_entity found by slug

data · object · required

Show child attributes