POST
/
v1
/
catalogs
/
{catalog_id}
/
entities
curl --request POST \
  --url https://api.rootly.com/v1/catalogs/{catalog_id}/entities \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '{
  "data": {
    "type": "catalog_entities",
    "attributes": {
      "name": "<string>",
      "description": "<string>",
      "position": 123
    }
  }
}'
{
  "data": {
    "id": "f816c07a-26da-4768-a630-79acd01d5fea",
    "type": "catalog_entities",
    "attributes": {
      "catalog_id": "920ecea9-9e9b-4441-931e-6141c8e7dd45",
      "name": "Test Item",
      "slug": "test-item",
      "position": 2,
      "deleted_at": null,
      "updated_at": "2025-03-26T23:18:01.413-07:00",
      "created_at": "2025-03-26T23:18:01.413-07:00"
    },
    "relationships": {
      "catalog": {
        "data": {
          "id": "920ecea9-9e9b-4441-931e-6141c8e7dd45",
          "type": "catalogs"
        }
      },
      "properties": {
        "data": []
      }
    }
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
catalog_id
string
required

Body

application/vnd.api+json
​
data
object
required

Response

201
application/vnd.api+json
catalog_entity created
​
data
object
required

Was this page helpful?