Overview
Reference
- AlertEvents
- AlertGroups
- AlertUrgencies
- AlertSources
- Alerts
- Audits
- Authorizations
- CatalogEntities
- CatalogEntityProperties
- CatalogFields
- Catalogs
- Causes
- [DEPRECATED] CustomFieldOptions
- [DEPRECATED] CustomFields
- CustomForms
- DashboardPanels
- Dashboards
- Environments
- EscalationPolicies
- EscalationLevelsPolicies
- EscalationLevelsPath
- EscalationLevels
- EscalationPaths
- FormFieldOptions
- FormFieldPlacementConditions
- FormFieldPlacements
- FormFieldPositions
- FormFields
- FormSetConditions
- FormSets
- Functionalities
- WorkflowTasks
- [DEPRECATED] WorkflowCustomFieldSelections
- WorkflowFormFieldConditions
- WorkflowGroups
- WorkflowRuns
- Workflows
- Heartbeats
- IncidentActionItems
- [DEPRECATED] IncidentCustomFieldSelections
- IncidentEventFunctionalities
- IncidentEventServices
- IncidentEvents
- IncidentFeedbacks
- IncidentFormFieldSelections
- IncidentPermissionSetBooleans
- IncidentPermissionSetResources
- IncidentPermissionSets
- IncidentRetrospectives
- IncidentRetrospectiveSteps
- IncidentRoleTasks
- IncidentRoles
- IncidentStatusPageEvents
- IncidentSubStatuses
- IncidentTypes
- Incidents
- IpRanges
- LiveCallRouters
- OnCallRoles
- OnCallShadows
- OverrideShifts
- PlaybookTasks
- Playbooks
- RetrospectiveTemplates
- Pulses
- RetrospectiveConfigurations
- RetrospectiveProcessGroupSteps
- RetrospectiveProcessGroups
- RetrospectiveProcesses
- RetrospectiveSteps
- Roles
- ScheduleRotationActiveDays
- ScheduleRotationUsers
- ScheduleRotations
- Schedules
- Shifts
- Secrets
- Services
- Severities
- StatusPageTemplates
- StatusPages
- SubStatuses
- Teams
- UserNotificationRules
- Users
- WebhooksDeliveries
- WebhooksEndpoints
CatalogEntities
Retrieves a catalog_entity
CatalogEntities
Retrieves a catalog_entity
Retrieves a specific catalog_entity by id
GET
/
v1
/
catalog_entities
/
{id}
curl --request GET \
--url 'https://api.rootly.com/v1/catalog_entities/%7Bid%7D?include=SOME_STRING_VALUE' \
--header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
{
"data": {
"id": "0ff5f77c-8254-421f-9de6-8d916fd98858",
"type": "catalog_entities",
"attributes": {
"catalog_id": "b2c10923-e17f-4722-8915-651b638d128b",
"name": "Test",
"slug": "test",
"position": 1,
"deleted_at": null,
"updated_at": "2025-03-13T11:59:15.669-07:00",
"created_at": "2025-03-13T11:59:15.669-07:00"
},
"relationships": {
"catalog": {
"data": {
"id": "b2c10923-e17f-4722-8915-651b638d128b",
"type": "catalogs"
}
},
"properties": {
"data": []
}
}
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Query Parameters
comma separated if needed. eg: catalog,properties
Available options:
catalog
, properties
Response
200
application/vnd.api+json
catalog_entity found
Unique ID of the catalog_entity
Available options:
catalog_entities
Was this page helpful?
curl --request GET \
--url 'https://api.rootly.com/v1/catalog_entities/%7Bid%7D?include=SOME_STRING_VALUE' \
--header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
{
"data": {
"id": "0ff5f77c-8254-421f-9de6-8d916fd98858",
"type": "catalog_entities",
"attributes": {
"catalog_id": "b2c10923-e17f-4722-8915-651b638d128b",
"name": "Test",
"slug": "test",
"position": 1,
"deleted_at": null,
"updated_at": "2025-03-13T11:59:15.669-07:00",
"created_at": "2025-03-13T11:59:15.669-07:00"
},
"relationships": {
"catalog": {
"data": {
"id": "b2c10923-e17f-4722-8915-651b638d128b",
"type": "catalogs"
}
},
"properties": {
"data": []
}
}
}
}