Overview
AlertEvents
AlertGroups
AlertRoutingRules
AlertUrgencies
AlertSources
Alerts
Audits
Authorizations
CatalogEntities
CatalogEntityProperties
CatalogFields
Catalogs
[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
- GETList incidents
- POSTCreates an incident
- GETRetrieves an incident
- PUTUpdate an incident
- DELDelete an incident
- PUTMitigate an incident
- PUTResolve an incident
- PUTCancel an incident
- PUTTriage an incident
- PUTRestart an incident
- PUTMark an incident as a duplicate
- POSTAdd subscribers to incident
- DELRemove subscribers from incident
- POSTAssign user to incident
- DELRemove assigned user from incident
IpRanges
LiveCallRouters
OnCallRoles
OnCallShadows
OverrideShifts
PlaybookTasks
Playbooks
RetrospectiveTemplates
RetrospectiveConfigurations
RetrospectiveProcessGroupSteps
RetrospectiveProcessGroups
RetrospectiveProcesses
RetrospectiveSteps
ScheduleRotationActiveDays
ScheduleRotationUsers
ScheduleRotations
Schedules
Services
Severities
StatusPageTemplates
StatusPages
SubStatuses
Teams
UserNotificationRules
WebhooksDeliveries
CatalogFields
Creates a Catalog Field
CatalogFields
Creates a Catalog Field
Creates a new Catalog Field from provided data
POST
/
v1
/
catalogs
/
{catalog_id}
/
fields
curl --request POST \
--url https://api.rootly.com/v1/catalogs/{catalog_id}/fields \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/vnd.api+json' \
--data '{
"data": {
"type": "catalog_fields",
"attributes": {
"name": "<string>",
"kind": "text",
"kind_catalog_id": "<string>",
"multiple": true,
"position": 123
}
}
}'
{
"data": {
"id": "9628479d-f05d-4942-a058-7d4a380f2253",
"type": "catalog_fields",
"attributes": {
"catalog_id": "157575f2-93f5-49cb-a267-c6841d864758",
"name": "Test Attribute",
"slug": "test-attribute",
"kind": "reference",
"kind_catalog_id": null,
"multiple": false,
"position": 2,
"deleted_at": null,
"updated_at": "2025-03-28T22:58:32.643-07:00",
"created_at": "2025-03-28T22:58:32.643-07:00"
},
"relationships": {
"catalog": {
"data": {
"id": "157575f2-93f5-49cb-a267-c6841d864758",
"type": "catalogs"
}
}
}
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Body
application/vnd.api+json
Available options:
catalog_fields
Available options:
text
, reference
Restricts values to items of specified catalog.
Whether the attribute accepts multiple values.
Default position of the item when displayed in a list.
Response
201
application/vnd.api+json
catalog_field created
Unique ID of the catalog_field
Available options:
catalog_fields
Available options:
text
, reference
Whether the attribute accepts multiple values.
Default position of the item when displayed in a list.
Restricts values to items of specified catalog.
Was this page helpful?
curl --request POST \
--url https://api.rootly.com/v1/catalogs/{catalog_id}/fields \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/vnd.api+json' \
--data '{
"data": {
"type": "catalog_fields",
"attributes": {
"name": "<string>",
"kind": "text",
"kind_catalog_id": "<string>",
"multiple": true,
"position": 123
}
}
}'
{
"data": {
"id": "9628479d-f05d-4942-a058-7d4a380f2253",
"type": "catalog_fields",
"attributes": {
"catalog_id": "157575f2-93f5-49cb-a267-c6841d864758",
"name": "Test Attribute",
"slug": "test-attribute",
"kind": "reference",
"kind_catalog_id": null,
"multiple": false,
"position": 2,
"deleted_at": null,
"updated_at": "2025-03-28T22:58:32.643-07:00",
"created_at": "2025-03-28T22:58:32.643-07:00"
},
"relationships": {
"catalog": {
"data": {
"id": "157575f2-93f5-49cb-a267-c6841d864758",
"type": "catalogs"
}
}
}
}
}