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
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/%7Bcatalog_id%7D/fields \
--header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
--header 'content-type: application/vnd.api+json'
{
"data": {
"id": "f2965079-9c84-470b-8529-e4aa0cdadc7a",
"type": "catalog_fields",
"attributes": {
"catalog_id": "e42c30a9-dc23-4db2-b624-9823bad6add8",
"name": "Test Attribute",
"slug": "test-attribute",
"kind": "reference",
"kind_catalog_id": null,
"multiple": false,
"position": 2,
"deleted_at": null,
"updated_at": "2025-03-13T11:59:22.911-07:00",
"created_at": "2025-03-13T11:59:22.911-07:00"
},
"relationships": {
"catalog": {
"data": {
"id": "e42c30a9-dc23-4db2-b624-9823bad6add8",
"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/%7Bcatalog_id%7D/fields \
--header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
--header 'content-type: application/vnd.api+json'
{
"data": {
"id": "f2965079-9c84-470b-8529-e4aa0cdadc7a",
"type": "catalog_fields",
"attributes": {
"catalog_id": "e42c30a9-dc23-4db2-b624-9823bad6add8",
"name": "Test Attribute",
"slug": "test-attribute",
"kind": "reference",
"kind_catalog_id": null,
"multiple": false,
"position": 2,
"deleted_at": null,
"updated_at": "2025-03-13T11:59:22.911-07:00",
"created_at": "2025-03-13T11:59:22.911-07:00"
},
"relationships": {
"catalog": {
"data": {
"id": "e42c30a9-dc23-4db2-b624-9823bad6add8",
"type": "catalogs"
}
}
}
}
}