{
"openapi": "3.0.1",
"info": {
"title": "Rootly API v1",
"version": "v1",
"description": "# How to generate an API Key?\n- **Organization dropdown** > **Organization Settings** > **API Keys**\n\n# JSON:API Specification\nRootly is using **JSON:API** (https://jsonapi.org) specification:\n- JSON:API is a specification for how a client should request that resources be fetched or modified, and how a server should respond to those requests.\n- JSON:API is designed to minimize both the number of requests and the amount of data transmitted between clients and servers. This efficiency is achieved without compromising readability, flexibility, or discoverability.\n- JSON:API requires use of the JSON:API media type (**application/vnd.api+json**) for exchanging data.\n\n# Authentication and Requests\nWe use standard HTTP Authentication over HTTPS to authorize your requests.\n```\n curl --request GET \\\n--header 'Content-Type: application/vnd.api+json' \\\n--header 'Authorization: Bearer YOUR-TOKEN' \\\n--url https://api.rootly.com/v1/incidents\n```\n\n
\n\n# Rate limiting\n- There is a default limit of **5** **GET**, **HEAD**, and **OPTIONS** calls **per API key** every **60 seconds** (0 hours). The limit is calculated over a **0-hour sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments.\n- There is a default limit of **3** **POST**, **PUT**, **PATCH** or **DELETE** calls **per API key** every **60 seconds** (0 hours). The limit is calculated over a **0-hour sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments.\n- When rate limits are exceeded, the API will return a **429 Too Many Requests** HTTP status code with the response: `{\"error\": \"Rate limit exceeded. Try again later.\"}`\n- **X-RateLimit headers** are included in every API response, providing real-time rate limit information:\n - **X-RateLimit-Limit** - The maximum number of requests permitted and the time window (e.g., \"1000, 1000;window=3600\" for 1000 requests per hour)\n - **X-RateLimit-Remaining** - The number of requests remaining in the current rate limit window\n - **X-RateLimit-Used** - The number of requests already made in the current window\n - **X-RateLimit-Reset** - The time at which the current rate limit window resets, in UTC epoch seconds\n\n# Pagination\n- Pagination is supported for all endpoints that return a collection of items.\n- Pagination is controlled by the **page** query parameter\n\n## Example\n```\n curl --request GET \\\n--header 'Content-Type: application/vnd.api+json' \\\n--header 'Authorization: Bearer YOUR-TOKEN' \\\n--url https://api.rootly.com/v1/incidents?page[number]=1&page[size]=10\n```\n\n",
"x-logo": {
"url": "https://rootly-heroku.s3.us-east-1.amazonaws.com/swagger/v1/logo.png"
}
},
"paths": {
"/v1/ai/chat": {
"post": {
"summary": "Send AI chat message",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AI Chat"
],
"description": "Send a message to the AI assistant and receive a synchronous reply. Optionally bind the conversation to an incident or alert for context-aware responses. Requires `ai.chat:write` OAuth scope or an API key.",
"operationId": "createAiChat",
"parameters": [
{
"name": "message",
"in": "query",
"schema": {
"type": "string"
},
"description": "Message to send to the AI assistant",
"required": true
},
{
"name": "session_id",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Resume an existing session",
"required": false
},
{
"name": "incident_id",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Bind session to an incident for context (mutually exclusive with alert_id)",
"required": false
},
{
"name": "alert_id",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Bind session to an alert for context (mutually exclusive with incident_id)",
"required": false
}
],
"responses": {
"200": {
"description": "AI chat response",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ai_chat_response"
}
}
}
},
"403": {
"description": "AI chat not enabled or insufficient scope"
},
"422": {
"description": "invalid request"
}
}
}
},
"/v1/ai/chat/stream": {
"post": {
"summary": "Stream AI chat response (SSE)",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AI Chat"
],
"description": "Send a message and receive the AI response as a Server-Sent Events stream. Optionally bind to an incident or alert for context. Events: `session_id` (initial), `text` (content chunks), `task_update` (tool progress), `error`, `done` (terminal with status). Requires `ai.chat:write` OAuth scope or an API key.",
"operationId": "streamAiChat",
"parameters": [
{
"name": "message",
"in": "query",
"schema": {
"type": "string"
},
"description": "Message to send",
"required": true
},
{
"name": "session_id",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Resume an existing session",
"required": false
},
{
"name": "incident_id",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Bind session to an incident (mutually exclusive with alert_id)",
"required": false
},
{
"name": "alert_id",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Bind session to an alert (mutually exclusive with incident_id)",
"required": false
}
],
"responses": {
"200": {
"description": "SSE event stream"
},
"403": {
"description": "AI chat not enabled"
}
}
}
},
"/v1/ai/chat/sessions/{session_id}/messages": {
"get": {
"summary": "List AI chat session messages",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AI Chat"
],
"description": "Returns the user and assistant message history for a session, paginated and chronologically ordered. Internal tool messages are filtered out. Requires `ai.chat:read` OAuth scope or an API key.",
"operationId": "listAiChatSessionMessages",
"parameters": [
{
"name": "session_id",
"in": "path",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Session UUID",
"required": true
},
{
"name": "page[number]",
"in": "query",
"schema": {
"type": "integer"
},
"description": "Page number (default 1)",
"required": false
},
{
"name": "page[size]",
"in": "query",
"schema": {
"type": "integer"
},
"description": "Messages per page (max 100, default 50)",
"required": false
}
],
"responses": {
"200": {
"description": "session messages",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ai_chat_session_message_list"
}
}
}
},
"404": {
"description": "session not found"
}
}
}
},
"/v1/ai/chat/sessions/{id}": {
"delete": {
"summary": "Delete AI chat session",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AI Chat"
],
"description": "Permanently deletes an AI chat session and all its messages. Requires `ai.chat:write` OAuth scope or an API key.",
"operationId": "deleteAiChatSession",
"parameters": [
{
"name": "id",
"in": "path",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Session UUID",
"required": true
}
],
"responses": {
"204": {
"description": "session deleted"
},
"404": {
"description": "session not found"
}
}
}
},
"/v1/alerts/{alert_id}/events": {
"parameters": [
{
"name": "alert_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "List alert events",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertEvents"
],
"description": "List alert_events",
"operationId": "listAlertEvents",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[kind]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[action]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/alert_event_list"
}
}
}
}
}
},
"post": {
"summary": "Create alert event",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertEvents"
],
"description": "Creates a new alert event",
"operationId": "createAlertEvent",
"parameters": [],
"responses": {
"201": {
"description": "alert event created with Rootly bot user",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/alert_event_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_alert_event"
}
}
}
}
}
},
"/v1/alert_events": {
"get": {
"summary": "List alert events across alerts",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertEvents"
],
"description": "Returns a flat list of alert events across all alerts the requester can access. Designed for periodic polling: use `page[after]` with the `next_cursor` returned in the previous response to stream forward.",
"operationId": "listAlertEventsFeed",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"description": "Page size (max 50).",
"schema": {
"type": "integer"
}
},
{
"name": "page[after]",
"in": "query",
"required": false,
"description": "Cursor token from the previous response's `meta.next_cursor`. Pass the same `sort` value used to obtain the cursor.",
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"description": "Sort by `created_at`. Defaults to `created_at` (oldest-first). Use `-created_at` for newest-first.",
"schema": {
"type": "string",
"enum": [
"created_at",
"-created_at"
]
},
"required": false
},
{
"name": "filter[kind]",
"in": "query",
"schema": {
"type": "string",
"enum": [
"informational",
"notification",
"action",
"status_update",
"recording",
"alert_grouping",
"alert_urgency",
"alert_routing",
"note",
"noise",
"maintenance",
"deferral"
]
},
"required": false
},
{
"name": "filter[action]",
"in": "query",
"schema": {
"type": "string",
"enum": [
"created",
"escalation_policy_paged",
"ignored_alert_request",
"emailed",
"slacked",
"ms_teams_messaged",
"google_chat_messaged",
"called",
"texted",
"notified",
"skipped",
"opened",
"retriggered",
"answered",
"acknowledged",
"escalated",
"paged",
"resolved",
"attached",
"snoozed",
"triggered",
"open",
"updated",
"added",
"removed",
"marked",
"not_marked",
"muted",
"deferred"
]
},
"required": false
},
{
"name": "filter[alert_id]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/alert_event_feed_list"
}
}
}
}
}
}
},
"/v1/alert_events/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieve alert event",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertEvents"
],
"description": "Retrieves a specific alert_event by id",
"operationId": "getAlertEvent",
"responses": {
"200": {
"description": "alert_event found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/alert_event_response"
}
}
}
},
"404": {
"description": "alert_event not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"patch": {
"summary": "Update alert event",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertEvents"
],
"description": "Updates a specific alert event. Only alert events with kind 'note' (user-created notes) can be updated. System-generated events are immutable to maintain audit trail integrity.",
"operationId": "updateAlertEvent",
"parameters": [],
"responses": {
"200": {
"description": "alert event updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/alert_event_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_alert_event"
}
}
}
}
},
"delete": {
"summary": "Delete alert event",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertEvents"
],
"description": "Deletes a specific alert event. Only alert events with kind 'note' (user-created notes) can be deleted. System-generated events are immutable to maintain audit trail integrity.",
"operationId": "deleteAlertEvent",
"responses": {
"200": {
"description": "alert event deleted"
},
"404": {
"description": "alert event not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/alert_fields": {
"post": {
"summary": "Creates an alert field",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertFields"
],
"description": "Creates a new alert field from provided data",
"operationId": "createAlertField",
"parameters": [],
"responses": {
"201": {
"description": "alert field created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/alert_field_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_alert_field"
}
}
},
"required": true
}
},
"get": {
"summary": "List alert fields",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertFields"
],
"description": "List alert fields",
"operationId": "listAlertFields",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[kind]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[kind][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[kind][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[kind][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[kind][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/alert_field_list"
}
}
}
}
}
}
},
"/v1/alert_fields/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "Resource UUID"
},
{
"type": "string",
"pattern": "^[a-z0-9_-]+$",
"description": "Resource slug"
}
]
},
"required": true
}
],
"get": {
"summary": "Retrieves an alert field",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertFields"
],
"description": "Retrieves a specific alert field by id",
"operationId": "getAlertField",
"responses": {
"200": {
"description": "alert_field found by slug",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/alert_field_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update an alert field",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertFields"
],
"description": "Update a specific alert field by id",
"operationId": "updateAlertField",
"parameters": [],
"responses": {
"200": {
"description": "alert field updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/alert_field_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_alert_field"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete an alert field",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertFields"
],
"description": "Delete a specific alert field by id",
"operationId": "deleteAlertField",
"responses": {
"200": {
"description": "custom alert field deleted successfully",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/alert_field_response"
}
}
}
},
"422": {
"description": "cannot delete alert field referenced by escalation path field rules",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/alert_groups": {
"post": {
"summary": "Creates an alert group",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertGroups"
],
"description": "Creates a new alert group. **Note**: For enhanced functionality and future compatibility, consider using the advanced alert grouping with `conditions` field instead of the legacy `group_by_alert_title`, `group_by_alert_urgency`, and `attributes` fields.",
"operationId": "createAlertGroup",
"parameters": [],
"responses": {
"201": {
"description": "alert group created with conditions",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/alert_group_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_alert_group"
}
}
},
"required": true
}
},
"get": {
"summary": "List alert groups",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertGroups"
],
"description": "List alert groups",
"operationId": "listAlertGroups",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/alert_group_list"
}
}
}
}
}
}
},
"/v1/alert_groups/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "Resource UUID"
},
{
"type": "string",
"pattern": "^[a-z0-9_-]+$",
"description": "Resource slug"
}
]
},
"required": true
}
],
"get": {
"summary": "Retrieves an alert group",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertGroups"
],
"description": "Retrieves a specific alert group by id",
"operationId": "getAlertGroup",
"responses": {
"200": {
"description": "alert_group found by slug",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/alert_group_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"patch": {
"summary": "Update an alert group",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertGroups"
],
"description": "Update a specific alert group by id. **Note**: For enhanced functionality and future compatibility, consider using the advanced alert grouping with `conditions` field instead of the legacy `group_by_alert_title`, `group_by_alert_urgency`, and `attributes` fields.",
"operationId": "updateAlertGroup",
"parameters": [],
"responses": {
"200": {
"description": "alert group updated with conditions",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/alert_group_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_alert_group"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete an alert group",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertGroups"
],
"description": "Delete a specific alert group by id",
"operationId": "deleteAlertGroup",
"responses": {
"200": {
"description": "alert group deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/alert_group_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/alert_routes": {
"get": {
"summary": "List alert routes",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertRoutes"
],
"description": "List all alert routes for the current team with filtering and pagination. **Note: This endpoint requires access to Advanced Alert Routing. If you're unsure whether you have access to this feature, please contact Rootly customer support.**",
"operationId": "listAlertRoutes",
"parameters": [
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "alert routes filtered by search",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/alert_route_list"
}
}
}
},
"401": {
"description": "unauthorized",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"post": {
"summary": "Creates an alert route",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertRoutes"
],
"description": "Creates a new alert route from provided data. **Note: This endpoint requires access to Advanced Alert Routing. If you're unsure whether you have access to this feature, please contact Rootly customer support.**\n\n## Asynchronous Rule Creation\n\nFor organizations with large numbers of routing rules, Rootly supports asynchronous rule processing to improve performance. When enabled, rule creation happens in the background.\n\n**Important**: When async processing is enabled, the rules list in the API response will not be up-to-date immediately after creation. You should refetch the alert route after a few minutes to get the updated rules.\n\nIf you experience slow operations when managing alert routes with many rules, contact Rootly customer support to enable asynchronous rule processing for your organization.",
"operationId": "createAlertRoute",
"parameters": [],
"responses": {
"201": {
"description": "unknown attribute filtered out gracefully",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/alert_route_response"
}
}
}
},
"422": {
"description": "create: raises error when multiple fallback rules are present",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "unauthorized",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_alert_route"
}
}
},
"required": true
}
}
},
"/v1/alert_routes/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Get an alert route",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertRoutes"
],
"description": "Get a specific alert route by id. **Note: This endpoint requires access to Advanced Alert Routing. If you're unsure whether you have access to this feature, please contact Rootly customer support.**\n\n## Optional Parameters\n\n- **show_nested_ids** (query parameter): When set to `true`, the response will include IDs for all nested resources (destinations, condition_groups, conditions). This is useful when you need to reference these nested resources for updates or deletions via PATCH requests.\n\nExample: `GET /v1/alert_routes/{id}?show_nested_ids=true`",
"operationId": "getAlertRoute",
"responses": {
"200": {
"description": "alert route found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/alert_route_response"
}
}
}
},
"404": {
"description": "cross-team access denied",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "unauthorized",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update an alert route",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertRoutes"
],
"description": "Update a specific alert route by id. **Note: This endpoint requires access to Advanced Alert Routing. If you're unsure whether you have access to this feature, please contact Rootly customer support.**\n\n### Asynchronous Rule Creation\n\nFor organizations with large numbers of routing rules, Rootly supports asynchronous rule processing to improve performance. When enabled, rule updates happen in the background.\n\n**Important**: When async processing is enabled, the rules list in the API response will not be up-to-date immediately after update. You should refetch the alert route after a few minutes to get the updated rules.\n\nIf you experience slow operations when managing alert routes with many rules, contact Rootly customer support to enable asynchronous rule processing for your organization.",
"operationId": "updateAlertRoute",
"parameters": [],
"responses": {
"200": {
"description": "update: handles mixed position types correctly",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/alert_route_response"
}
}
}
},
"422": {
"description": "update: raises error when multiple fallback rules are present",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"404": {
"description": "cross-team access denied",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_alert_route"
}
}
},
"required": true
}
},
"patch": {
"summary": "Update an alert route",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertRoutes"
],
"description": "Updates an alert route. **Note: This endpoint requires access to Advanced Alert Routing. If you're unsure whether you have access to this feature, please contact Rootly customer support.**",
"operationId": "patchAlertRoute",
"parameters": [],
"responses": {
"200": {
"description": "delete existing rule by id with _destroy",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/alert_route_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "unauthorized",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"404": {
"description": "cross-team access denied",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/patch_alert_route"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete an alert route",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertRoutes"
],
"description": "Delete a specific alert route by id. **Note: This endpoint requires access to Advanced Alert Routing. If you're unsure whether you have access to this feature, please contact Rootly customer support.**",
"operationId": "deleteAlertRoute",
"responses": {
"200": {
"description": "alert route deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"deleted": {
"type": "boolean"
}
}
}
}
}
}
}
}
}
},
"404": {
"description": "cross-team access denied",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"422": {
"description": "destroy failed",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "unauthorized",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/alert_routing_rules": {
"post": {
"summary": "Creates an alert routing rule",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertRoutingRules"
],
"description": "Creates a new alert routing rule from provided data. **Note: If you are an advanced alert routing user, you should use the Alert Routes endpoint instead of this endpoint. If you don't know whether you are an advanced user, please contact Rootly customer support.**",
"operationId": "createAlertRoutingRule",
"parameters": [],
"responses": {
"201": {
"description": "alert routing rule created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/alert_routing_rule_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_alert_routing_rule"
}
}
},
"required": true
}
},
"get": {
"summary": "List alert routing rules",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertRoutingRules"
],
"description": "List alert routing rules. **Note: If you are an advanced alert routing user, you should use the Alert Routes endpoint instead of this endpoint. If you don't know whether you are an advanced user, please contact Rootly customer support.**",
"operationId": "listAlertRoutingRules",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/alert_routing_rule_list"
}
}
}
}
}
}
},
"/v1/alert_routing_rules/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "Resource UUID"
},
{
"type": "string",
"pattern": "^[a-z0-9_-]+$",
"description": "Resource slug"
}
]
},
"required": true
}
],
"get": {
"summary": "Retrieves an alert routing rule",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertRoutingRules"
],
"description": "Retrieves a specific alert routing rule by id. **Note: If you are an advanced alert routing user, you should use the Alert Routes endpoint instead of this endpoint. If you don't know whether you are an advanced user, please contact Rootly customer support.**",
"operationId": "getAlertRoutingRule",
"responses": {
"200": {
"description": "alert_routing_rule found by slug",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/alert_routing_rule_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update an alert routing rule",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertRoutingRules"
],
"description": "Update a specific alert routing rule by id. **Note: If you are an advanced alert routing user, you should use the Alert Routes endpoint instead of this endpoint. If you don't know whether you are an advanced user, please contact Rootly customer support.**",
"operationId": "updateAlertRoutingRule",
"parameters": [],
"responses": {
"200": {
"description": "alert routing rule updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/alert_routing_rule_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_alert_routing_rule"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete an alert routing rule",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertRoutingRules"
],
"description": "Delete a specific alert routing rule by id. **Note: If you are an advanced alert routing user, you should use the Alert Routes endpoint instead of this endpoint. If you don't know whether you are an advanced user, please contact Rootly customer support.**",
"operationId": "deleteAlertRoutingRule",
"responses": {
"200": {
"description": "alert routing rule deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/alert_routing_rule_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/alert_urgencies": {
"post": {
"summary": "Creates an alert urgency",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertUrgencies"
],
"description": "Creates a new alert urgency from provided data",
"operationId": "createAlertUrgency",
"parameters": [],
"responses": {
"201": {
"description": "alert urgency created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/alert_urgency_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_alert_urgency"
}
}
},
"required": true
}
},
"get": {
"summary": "List alert urgencies",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertUrgencies"
],
"description": "List alert urgencies",
"operationId": "listAlertUrgencies",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/alert_urgency_list"
}
}
}
}
}
}
},
"/v1/alert_urgencies/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves an alert urgency",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertUrgencies"
],
"description": "Retrieves a specific alert urgency by id",
"operationId": "getAlertUrgency",
"responses": {
"200": {
"description": "alert urgency found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/alert_urgency_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update an alert urgency",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertUrgencies"
],
"description": "Update a specific alert urgency by id",
"operationId": "updateAlertUrgency",
"parameters": [],
"responses": {
"200": {
"description": "alert urgency updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/alert_urgency_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_alert_urgency"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete an alert urgency",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertUrgencies"
],
"description": "Delete a specific alert urgency by id",
"operationId": "deleteAlertUrgency",
"responses": {
"200": {
"description": "alert urgency deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/alert_urgency_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/alert_sources": {
"post": {
"summary": "Creates an alert source",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertSources"
],
"description": "Creates a new alert source from provided data",
"operationId": "createAlertsSource",
"parameters": [],
"responses": {
"201": {
"description": "alert source created with resolution rule",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/alerts_source_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_alerts_source"
}
}
},
"required": true
}
},
"get": {
"summary": "List alert sources",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertSources"
],
"description": "List alert sources",
"operationId": "listAlertsSources",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[statuses]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[source_types]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[enabled]",
"in": "query",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/alerts_source_list"
}
}
}
}
}
}
},
"/v1/alert_sources/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves an alert source",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertSources"
],
"description": "Retrieves a specific alert source by id",
"operationId": "getAlertsSource",
"responses": {
"200": {
"description": "alert source found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/alerts_source_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update an alert source",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertSources"
],
"description": "Update a specific alert source by id",
"operationId": "updateAlertsSource",
"parameters": [],
"responses": {
"200": {
"description": "preserves existing alert source field ids",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/alerts_source_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_alerts_source"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete an alert source",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertSources"
],
"description": "Delete a specific alert source by id",
"operationId": "deleteAlertsSource",
"responses": {
"200": {
"description": "alert source deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/alerts_source_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/incidents/{incident_id}/alerts": {
"parameters": [
{
"name": "incident_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Attach alerts to an incident",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Alerts"
],
"description": "Attach alerts to an incident from provided data",
"operationId": "attachAlert",
"parameters": [],
"responses": {
"200": {
"description": "alert created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/alert_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/attach_alert"
}
}
},
"required": true
}
},
"get": {
"summary": "List Incident alerts",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Alerts"
],
"description": "List incident alerts",
"operationId": "listIncidentAlerts",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: environments,services,groups",
"schema": {
"type": "string",
"enum": [
"environments",
"services",
"groups",
"functionalities",
"responders",
"incidents",
"notified_users",
"events",
"alert_urgency",
"heartbeat",
"live_call_router",
"alert_group",
"group_leader_alert",
"group_member_alerts",
"alert_field_values",
"alerting_targets",
"escalation_policies",
"alert_call_recording"
]
},
"required": false
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/alert_list"
}
}
}
}
}
}
},
"/v1/alerts": {
"post": {
"summary": "Creates an alert",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Alerts"
],
"description": "Creates a new alert from provided data",
"operationId": "createAlert",
"parameters": [],
"responses": {
"201": {
"description": "alert created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/alert_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_alert"
}
}
},
"required": true
}
},
"get": {
"summary": "List alerts",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Alerts"
],
"description": "List alerts",
"operationId": "listAlerts",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: environments,services,groups",
"schema": {
"type": "string",
"enum": [
"environments",
"services",
"groups",
"functionalities",
"responders",
"incidents",
"notified_users",
"events",
"alert_urgency",
"heartbeat",
"live_call_router",
"alert_group",
"group_leader_alert",
"group_member_alerts",
"alert_field_values",
"alerting_targets",
"escalation_policies",
"alert_call_recording"
]
},
"required": false
},
{
"name": "filter[status]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[source]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[services]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[environments]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[groups]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[labels]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[started_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[started_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[started_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[started_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[ended_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[ended_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[ended_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[ended_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[updated_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[updated_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[updated_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[updated_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[status][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[status][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[status][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[status][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[source][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[source][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[source][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[source][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[services][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[services][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[services][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[services][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[groups][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[groups][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[groups][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[groups][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[environments][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[environments][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[environments][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[environments][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[labels][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[labels][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[labels][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[labels][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[after]",
"in": "query",
"required": false,
"description": "The cursor to fetch results using cursor pagination. A cursor is provided in meta.next_cursor in the response.",
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "returns grouping attributes",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/alert_list"
}
}
}
}
}
}
},
"/v1/alerts/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves an alert",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Alerts"
],
"description": "Retrieves a specific alert by id",
"operationId": "getAlert",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: environments,services,groups",
"schema": {
"type": "string",
"enum": [
"environments",
"services",
"groups",
"functionalities",
"responders",
"incidents",
"notified_users",
"events",
"alert_urgency",
"heartbeat",
"live_call_router",
"alert_group",
"group_leader_alert",
"group_member_alerts",
"alert_field_values",
"alerting_targets",
"escalation_policies",
"alert_call_recording"
]
},
"required": false
}
],
"responses": {
"200": {
"description": "alert found with group_member_alerts included",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/alert_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"patch": {
"summary": "Update alert",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Alerts"
],
"description": "Updates an alert",
"operationId": "updateAlert",
"parameters": [],
"responses": {
"200": {
"description": "updates one field value and preserves others",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/alert_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_alert"
}
}
}
}
}
},
"/v1/alerts/{id}/acknowledge": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Acknowledges an alert",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Alerts"
],
"description": "Acknowledges a specific alert by id",
"operationId": "acknowledgeAlert",
"responses": {
"200": {
"description": "alert acknowledged",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/alert_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"400": {
"description": "cannot acknowledge open alert",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/alerts/{id}/resolve": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Resolves an alert",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Alerts"
],
"description": "Resolves a specific alert by id",
"operationId": "resolveAlert",
"parameters": [],
"responses": {
"200": {
"description": "resolves open alert",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/alert_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/resolve_alert"
}
}
}
}
}
},
"/v1/alerts/{id}/snooze": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Snoozes an alert",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Alerts"
],
"description": "Snoozes a specific alert by id, extending the acknowledgment timeout",
"operationId": "snoozeAlert",
"parameters": [],
"responses": {
"200": {
"description": "alert snoozed",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/alert_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"400": {
"description": "invalid delay_minutes",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"422": {
"description": "snooze service failure",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/snooze_alert"
}
}
},
"required": true
}
}
},
"/v1/alerts/{id}/escalate": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Escalates an alert",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Alerts"
],
"description": "Escalates a specific alert to the next or specified level in its escalation policy",
"operationId": "escalateAlert",
"parameters": [],
"responses": {
"200": {
"description": "escalates to different EP defaults to level 1",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/alert_response"
}
}
}
},
"422": {
"description": "escalation_policy_level exceeds max",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"404": {
"description": "cannot escalate grouped member alert",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"400": {
"description": "malformed escalation_policy_id",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/escalate_alert"
}
}
}
}
}
},
"/v1/api_keys": {
"get": {
"summary": "List API keys",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"API Keys"
],
"description": "List API keys for the current organization. Returns key metadata including name, kind, expiration, and last usage — the secret token value is never included in the response.\n\n**API key kinds:**\n- `personal` — tied to a specific user, inherits that user's permissions.\n- `team` — scoped to one or more teams (groups), creates a service account with permissions derived from group membership.\n- `organization` — organization-wide, creates a service account with a configurable role and on-call role.\n\n**Automated rotation workflow:** Use `filter[expires_at][lt]` to find keys approaching expiration, then call the rotate endpoint to issue a new token before the old one expires. Combine with `filter[active]=true` to exclude already-expired keys.\n\n**Sorting:** Use the `sort` parameter with a field name (e.g., `sort=expires_at`). Prefix with `-` for descending order (e.g., `sort=-created_at`). Allowed fields: `name`, `kind`, `created_at`, `updated_at`, `expires_at`, `last_used_at`.\n",
"operationId": "listApiKeys",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"description": "Comma-separated list of relationships to include (role, on_call_role, created_by, groups)",
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[kind]",
"in": "query",
"required": false,
"description": "Filter by API key kind: personal, team, organization",
"schema": {
"type": "string"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"description": "Search by name (case-insensitive partial match)",
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"description": "Filter by exact name",
"schema": {
"type": "string"
}
},
{
"name": "filter[user_id]",
"in": "query",
"required": false,
"description": "Filter by the user ID that owns the key",
"schema": {
"type": "string"
}
},
{
"name": "filter[group_ids]",
"in": "query",
"required": false,
"description": "Filter team keys by group IDs (comma-separated)",
"schema": {
"type": "string"
}
},
{
"name": "filter[role_id]",
"in": "query",
"required": false,
"description": "Filter by role ID",
"schema": {
"type": "string"
}
},
{
"name": "filter[active]",
"in": "query",
"required": false,
"description": "When true, return only non-expired keys",
"schema": {
"type": "boolean"
}
},
{
"name": "filter[expired]",
"in": "query",
"required": false,
"description": "When true, return only expired keys",
"schema": {
"type": "boolean"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"description": "Created after (ISO 8601)",
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"description": "Created at or after (ISO 8601)",
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"description": "Created before (ISO 8601)",
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"description": "Created at or before (ISO 8601)",
"schema": {
"type": "string"
}
},
{
"name": "filter[expires_at][gt]",
"in": "query",
"required": false,
"description": "Expires after (ISO 8601)",
"schema": {
"type": "string"
}
},
{
"name": "filter[expires_at][gte]",
"in": "query",
"required": false,
"description": "Expires at or after (ISO 8601)",
"schema": {
"type": "string"
}
},
{
"name": "filter[expires_at][lt]",
"in": "query",
"required": false,
"description": "Expires before (ISO 8601). Useful for finding keys approaching expiration.",
"schema": {
"type": "string"
}
},
{
"name": "filter[expires_at][lte]",
"in": "query",
"required": false,
"description": "Expires at or before (ISO 8601)",
"schema": {
"type": "string"
}
},
{
"name": "filter[last_used_at][gt]",
"in": "query",
"required": false,
"description": "Last used after (ISO 8601)",
"schema": {
"type": "string"
}
},
{
"name": "filter[last_used_at][gte]",
"in": "query",
"required": false,
"description": "Last used at or after (ISO 8601)",
"schema": {
"type": "string"
}
},
{
"name": "filter[last_used_at][lt]",
"in": "query",
"required": false,
"description": "Last used before (ISO 8601)",
"schema": {
"type": "string"
}
},
{
"name": "filter[last_used_at][lte]",
"in": "query",
"required": false,
"description": "Last used at or before (ISO 8601)",
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"description": "Sort by field. Prefix with - for descending (e.g., -created_at, expires_at)",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/api_key_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"post": {
"summary": "Creates an API key",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"API Keys"
],
"description": "Creates a new API key and returns it with the plaintext token. **The token is only returned once** — store it securely, as it cannot be retrieved again.\n\n**Kinds and required fields:**\n- `personal` — created for the authenticated user. No additional fields required.\n- `team` — scoped to a team (group). Requires `group_id`. A service account is automatically created with permissions derived from group membership.\n- `organization` — organization-wide access. Requires owner or admin role. Optionally set `role_id` and `on_call_role_id` to control the service account's permissions.\n\n**Expiration:** All keys require an `expires_at` date set in the future (maximum 5 years). Names must be unique within their kind and scope.\n",
"operationId": "createApiKey",
"parameters": [],
"responses": {
"201": {
"description": "API key created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/api_key_with_token_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_api_key"
}
}
},
"required": true
}
}
},
"/v1/api_keys/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "Resource UUID"
}
]
},
"required": true
}
],
"get": {
"summary": "Retrieves an API key",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"API Keys"
],
"description": "Retrieves a specific API key by its UUID. Returns key metadata including name, kind, expiration, last usage timestamp, and the grace period status — the secret token is never included.",
"operationId": "getApiKey",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"description": "Comma-separated list of relationships to include (role, on_call_role, created_by, groups)",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "API key found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/api_key_response"
}
}
}
},
"404": {
"description": "API key not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update an API key",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"API Keys"
],
"description": "Update an API key's mutable attributes: `name`, `description`, and `expires_at`.\n\nThe key's `kind`, `role_id`, `on_call_role_id`, and token cannot be changed after creation. To issue a new token, use the rotate endpoint. To change the role or kind, revoke the key and create a new one.\n\nThe new `expires_at` must be in the future and within 5 years.\n",
"operationId": "updateApiKey",
"parameters": [],
"responses": {
"200": {
"description": "API key updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/api_key_response"
}
}
}
},
"404": {
"description": "API key not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_api_key"
}
}
},
"required": true
}
},
"delete": {
"summary": "Revoke an API key",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"API Keys"
],
"description": "Revoke an API key. The key is immediately invalidated and can no longer be used for authentication. This action cannot be undone.\n\nFor `team` and `organization` keys, the associated service account is also deleted. Any active sessions using this key will fail on the next request.\n",
"operationId": "deleteApiKey",
"responses": {
"200": {
"description": "API key revoked",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/api_key_response"
}
}
}
},
"404": {
"description": "API key not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/api_keys/{id}/rotate": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Rotate an API key",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"API Keys"
],
"description": "Rotate an API key's token. Issues a new secret token and returns it — **the new token is only shown once**, so store it securely.\n\n**Self-only:** You can only rotate the API key that was used to authenticate this request. Attempting to rotate a different key returns `403 Forbidden`.\n\n**Grace period:** When enabled for your organization, the previous token remains valid after rotation, giving you time to deploy the new token without downtime. Pass `grace_period_minutes` (integer, 0–1440, default 30) to control how long the old token stays valid. Set to 0 to immediately invalidate the old token. The `grace_period_ends_at` field in the response confirms the exact time the old token will stop working.\n\n**Expiration:** Optionally provide a new `expires_at` date (ISO 8601, up to 5 years). Defaults to 90 days from now if omitted. Dates in the past are rejected.\n\n**Typical rotation workflow:**\n1. Call this endpoint to get a new token (optionally with a custom `grace_period_minutes`).\n2. Deploy the new token to your systems.\n3. The old token continues working for `grace_period_minutes` (if grace period is enabled).\n4. After the grace period, the old token is automatically invalidated.\n",
"operationId": "rotateApiKey",
"parameters": [],
"responses": {
"200": {
"description": "API key rotated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/api_key_with_token_response"
}
}
}
},
"404": {
"description": "API key not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/rotate_api_key"
}
}
}
}
}
},
"/v1/audits": {
"get": {
"summary": "List audits",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Audits"
],
"description": "List audits",
"operationId": "listAudits",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[user_id]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[api_key_id]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[source]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[item_type]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[user_id][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[user_id][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[user_id][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[user_id][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[api_key_id][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[api_key_id][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[api_key_id][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[api_key_id][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[source][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[source][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[source][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[source][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[item_type][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[item_type][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[item_type][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[item_type][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/audits_list"
}
}
}
}
}
}
},
"/v1/authorizations": {
"post": {
"summary": "Creates an authorization",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Authorizations"
],
"description": "Creates a new authorization from provided data",
"operationId": "createAuthorization",
"parameters": [],
"responses": {
"201": {
"description": "authorization created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/authorization_response"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_authorization"
}
}
},
"required": true
}
},
"get": {
"summary": "List authorizations",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Authorizations"
],
"description": "List authorizations",
"operationId": "listAuthorizations",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[authorizable_id]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[authorizable_type]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[grantee_id]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[grantee_type]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/authorization_list"
}
}
}
}
}
}
},
"/v1/authorizations/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves an authorization",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Authorizations"
],
"description": "Retrieves a specific authorization by id",
"operationId": "getAuthorization",
"responses": {
"200": {
"description": "authorization found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/authorization_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update an authorization",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Authorizations"
],
"description": "Update a specific authorization by id",
"operationId": "updateAuthorization",
"parameters": [],
"responses": {
"200": {
"description": "authorization updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/authorization_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_authorization"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete an authorization",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Authorizations"
],
"description": "Delete a specific authorization by id",
"operationId": "deleteAuthorization",
"responses": {
"200": {
"description": "authorization deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/authorization_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/catalog_checklist_templates": {
"post": {
"summary": "Creates a catalog checklist template",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Catalog Checklist Templates"
],
"description": "Creates a new catalog checklist template",
"operationId": "createCatalogChecklistTemplate",
"parameters": [],
"responses": {
"201": {
"description": "ignores user-provided field_key for custom fields",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/catalog_checklist_template_response"
}
}
}
},
"422": {
"description": "returns 422 when scope_type is missing for Catalog scope_id",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_catalog_checklist_template"
}
}
},
"required": true
}
},
"get": {
"summary": "List catalog checklist templates",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Catalog Checklist Templates"
],
"description": "List catalog checklist templates",
"operationId": "listCatalogChecklistTemplates",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: template_fields,template_owners",
"schema": {
"type": "string",
"enum": [
"template_fields",
"template_owners"
]
},
"required": false
},
{
"name": "sort",
"in": "query",
"description": "comma separated if needed. eg: created_at,updated_at",
"schema": {
"type": "string",
"enum": [
"created_at",
"-created_at",
"updated_at",
"-updated_at",
"name",
"-name"
]
},
"required": false
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[catalog_type]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[scope_type]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "returns empty list for another team",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/catalog_checklist_template_list"
}
}
}
}
}
}
},
"/v1/catalog_checklist_templates/{id}/trigger": {
"parameters": [
{
"name": "id",
"in": "path",
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "Resource UUID"
},
{
"type": "string",
"pattern": "^[a-z0-9_-]+$",
"description": "Resource slug"
}
]
},
"required": true
}
],
"post": {
"summary": "Trigger an audit for a catalog checklist template",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Catalog Checklist Templates"
],
"description": "Triggers an audit for all applicable entities of the checklist template",
"operationId": "triggerCatalogChecklistTemplate",
"responses": {
"202": {
"description": "audit triggered"
},
"404": {
"description": "resource not found for another team",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/catalog_checklist_templates/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "Resource UUID"
},
{
"type": "string",
"pattern": "^[a-z0-9_-]+$",
"description": "Resource slug"
}
]
},
"required": true
}
],
"get": {
"summary": "Retrieves a catalog checklist template",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Catalog Checklist Templates"
],
"description": "Retrieves a specific catalog checklist template by id",
"operationId": "getCatalogChecklistTemplate",
"responses": {
"200": {
"description": "catalog checklist template found by slug",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/catalog_checklist_template_response"
}
}
}
},
"404": {
"description": "resource not found for another team",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a catalog checklist template",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Catalog Checklist Templates"
],
"description": "Update a specific catalog checklist template by id",
"operationId": "updateCatalogChecklistTemplate",
"parameters": [],
"responses": {
"200": {
"description": "ignores user-provided field_key for custom fields on update",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/catalog_checklist_template_response"
}
}
}
},
"422": {
"description": "rejects duplicate custom fields on update",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_catalog_checklist_template"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a catalog checklist template",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Catalog Checklist Templates"
],
"description": "Delete a specific catalog checklist template by id",
"operationId": "deleteCatalogChecklistTemplate",
"responses": {
"200": {
"description": "catalog checklist template deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/catalog_checklist_template_response"
}
}
}
},
"404": {
"description": "catalog checklist template not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/catalogs/{catalog_id}/entities": {
"parameters": [
{
"name": "catalog_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates a Catalog Entity",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"CatalogEntities"
],
"description": "Creates a new Catalog Entity from provided data",
"operationId": "createCatalogEntity",
"parameters": [],
"responses": {
"201": {
"description": "catalog_entity created with fields attribute",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/catalog_entity_response"
}
}
}
},
"422": {
"description": "rejects entity with invalid catalog_field_id",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_catalog_entity"
}
}
},
"required": true
}
},
"get": {
"summary": "List Catalog Entities",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"CatalogEntities"
],
"description": "List Catalog Entities",
"operationId": "listCatalogEntities",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: catalog,properties",
"schema": {
"type": "string",
"enum": [
"catalog",
"properties"
]
},
"required": false
},
{
"name": "sort",
"in": "query",
"description": "comma separated if needed. eg: created_at,updated_at",
"schema": {
"type": "string",
"enum": [
"created_at",
"-created_at",
"updated_at",
"-updated_at",
"position",
"-position"
]
},
"required": false
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[backstage_id]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[external_id]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[managed_by]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[managed_by][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[managed_by][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[managed_by][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[managed_by][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/catalog_entity_list"
}
}
}
}
}
}
},
"/v1/catalog_entities/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "Resource UUID"
},
{
"type": "string",
"pattern": "^[a-z0-9_-]+$",
"description": "Resource slug"
}
]
},
"required": true
}
],
"get": {
"summary": "Retrieves a Catalog Entity",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"CatalogEntities"
],
"description": "Retrieves a specific Catalog Entity by id",
"operationId": "getCatalogEntity",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: catalog,properties",
"schema": {
"type": "string",
"enum": [
"catalog",
"properties"
]
},
"required": false
}
],
"responses": {
"200": {
"description": "catalog_entity found by slug",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/catalog_entity_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a Catalog Entity",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"CatalogEntities"
],
"description": "Update a specific Catalog Entity by id",
"operationId": "updateCatalogEntity",
"parameters": [],
"responses": {
"200": {
"description": "catalog_entity update replaces existing properties",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/catalog_entity_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_catalog_entity"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a Catalog Entity",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"CatalogEntities"
],
"description": "Delete a specific Catalog Entity by id",
"operationId": "deleteCatalogEntity",
"responses": {
"200": {
"description": "catalog_entity deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/catalog_entity_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/catalogs/{catalog_id}/entities/bulk_upsert": {
"parameters": [
{
"name": "catalog_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Bulk upsert Catalog Entities",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"CatalogEntities"
],
"description": "Create or update multiple catalog entities by external_id. Only attributes present in the payload are written (managed-fields semantics). Transactional: all succeed or all fail.",
"operationId": "bulkUpsertCatalogEntities",
"parameters": [],
"responses": {
"200": {
"description": "entities upserted successfully",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/bulk_upsert_catalog_entities_response"
}
}
}
},
"422": {
"description": "validation or entity-level error",
"content": {
"application/vnd.api+json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/errors_list"
},
{
"$ref": "#/components/schemas/bulk_upsert_catalog_entities_error"
}
]
}
}
}
},
"401": {
"description": "unauthorized",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/bulk_upsert_catalog_entities"
}
}
},
"required": true
}
}
},
"/v1/catalogs/{catalog_id}/entities/bulk_delete": {
"parameters": [
{
"name": "catalog_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Bulk delete Catalog Entities",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"CatalogEntities"
],
"description": "Delete catalog entities by external_id list, or prune by managed_by source. Two mutually exclusive modes.",
"operationId": "bulkDeleteCatalogEntities",
"parameters": [],
"responses": {
"200": {
"description": "entities deleted successfully",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/bulk_destroy_catalog_entities_response"
}
}
}
},
"422": {
"description": "validation or partial-failure error",
"content": {
"application/vnd.api+json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/errors_list"
},
{
"$ref": "#/components/schemas/bulk_destroy_catalog_entities_response"
}
]
}
}
}
},
"401": {
"description": "unauthorized",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/bulk_destroy_catalog_entities"
}
}
},
"required": true
}
}
},
"/v1/catalog_entity_checklists": {
"get": {
"summary": "List catalog entity checklists",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Catalog Entity Checklists"
],
"description": "List catalog entity checklists",
"operationId": "listCatalogEntityChecklists",
"parameters": [
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[status]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[catalog_checklist_template_id]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[auditable_type]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[auditable_id]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "returns empty list for another team",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/catalog_entity_checklist_list"
}
}
}
}
}
}
},
"/v1/catalog_entity_checklists/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"schema": {
"type": "string",
"format": "uuid",
"description": "Resource UUID"
},
"required": true
}
],
"get": {
"summary": "Retrieves a catalog entity checklist",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Catalog Entity Checklists"
],
"description": "Retrieves a specific catalog entity checklist by id",
"operationId": "getCatalogEntityChecklist",
"responses": {
"200": {
"description": "catalog entity checklist found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/catalog_entity_checklist_response"
}
}
}
},
"404": {
"description": "resource not found for another team",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/catalog_entities/{catalog_entity_id}/properties": {
"parameters": [
{
"name": "catalog_entity_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates a Catalog Entity Property",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"CatalogEntityProperties"
],
"description": "**Deprecated:** This endpoint is deprecated, please use the `fields` attribute on catalog entities or native catalog endpoints (teams, services, functionalities, incident_types, causes, environments) to set field values instead.\n\nCreates a new Catalog Entity Property from provided data.",
"operationId": "createCatalogEntityProperty",
"deprecated": true,
"parameters": [],
"responses": {
"201": {
"description": "catalog_entity_property created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/catalog_entity_property_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_catalog_entity_property"
}
}
},
"required": true
}
},
"get": {
"summary": "List catalog properties",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"CatalogEntityProperties"
],
"description": "**Deprecated:** This endpoint is deprecated, please use `include=fields` on catalog entities or native catalog endpoints (teams, services, functionalities, incident_types, causes, environments) to retrieve field values instead.\n\nList Catalog Entity Properties.",
"operationId": "listCatalogEntityProperties",
"deprecated": true,
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: catalog_entity,catalog_field",
"schema": {
"type": "string",
"enum": [
"catalog_entity",
"catalog_field"
]
},
"required": false
},
{
"name": "sort",
"in": "query",
"description": "comma separated if needed. eg: created_at,updated_at",
"schema": {
"type": "string",
"enum": [
"created_at",
"-created_at",
"updated_at",
"-updated_at"
]
},
"required": false
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[catalog_field_id]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[key]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/catalog_entity_property_list"
}
}
}
}
}
}
},
"/v1/catalog_entity_properties/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a Catalog Entity Property",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"CatalogEntityProperties"
],
"description": "**Deprecated:** This endpoint is deprecated, please use `include=fields` on catalog entities or native catalog endpoints (teams, services, functionalities, incident_types, causes, environments) to retrieve field values instead.\n\nRetrieves a specific Catalog Entity Property by id.",
"operationId": "getCatalogEntityProperty",
"deprecated": true,
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: catalog_entity,catalog_field",
"schema": {
"type": "string",
"enum": [
"catalog_entity",
"catalog_field"
]
},
"required": false
}
],
"responses": {
"200": {
"description": "catalog_entity_property found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/catalog_entity_property_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a Catalog Entity Property",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"CatalogEntityProperties"
],
"description": "**Deprecated:** This endpoint is deprecated, please use the `fields` attribute on catalog entities or native catalog endpoints (teams, services, functionalities, incident_types, causes, environments) to set field values instead.\n\nUpdate a specific Catalog Entity Property by id.",
"operationId": "updateCatalogEntityProperty",
"deprecated": true,
"parameters": [],
"responses": {
"200": {
"description": "catalog_entity_property updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/catalog_entity_property_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_catalog_entity_property"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a Catalog Entity Property",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"CatalogEntityProperties"
],
"description": "**Deprecated:** This endpoint is deprecated, please use the `fields` attribute on catalog entities or native catalog endpoints (teams, services, functionalities, incident_types, causes, environments) to set field values instead.\n\nDelete a specific Catalog Entity Property by id.",
"operationId": "deleteCatalogEntityProperty",
"deprecated": true,
"responses": {
"200": {
"description": "catalog_entity_property deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/catalog_entity_property_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/catalogs/{catalog_id}/properties": {
"parameters": [
{
"name": "catalog_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "List Catalog Properties (alias for fields)",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"CatalogProperties"
],
"description": "List Catalog Properties - returns catalog_properties type",
"operationId": "listCatalogProperties",
"responses": {
"200": {
"description": "success with catalog_properties type"
}
}
},
"post": {
"summary": "Creates a Catalog Property (alias for field)",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"CatalogProperties"
],
"description": "Creates a new Catalog Property - returns catalog_properties type",
"operationId": "createCatalogProperty",
"parameters": [],
"responses": {
"201": {
"description": "catalog_property created"
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_catalog_field"
}
}
},
"required": true
}
}
},
"/v1/catalog_properties/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a Catalog Property (alias for field)",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"CatalogProperties"
],
"description": "Retrieves a specific Catalog Property by id - returns catalog_properties type",
"operationId": "getCatalogProperty",
"responses": {
"200": {
"description": "catalog_property found"
}
}
},
"put": {
"summary": "Update a catalog_property (alias for field)",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"CatalogProperties"
],
"description": "Update a specific catalog_property by id - returns catalog_properties type",
"operationId": "updateCatalogProperty",
"parameters": [],
"responses": {
"200": {
"description": "catalog_property updated"
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_catalog_field"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a catalog_property",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"CatalogProperties"
],
"description": "Delete a specific catalog_property by id - returns catalog_properties type",
"operationId": "deleteCatalogProperty",
"responses": {
"200": {
"description": "catalog_property deleted"
}
}
}
},
"/v1/catalogs": {
"post": {
"summary": "Creates a catalog",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Catalogs"
],
"description": "Creates a new catalog from provided data",
"operationId": "createCatalog",
"parameters": [],
"responses": {
"201": {
"description": "catalog created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/catalog_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_catalog"
}
}
},
"required": true
}
},
"get": {
"summary": "List catalogs",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Catalogs"
],
"description": "List catalogs",
"operationId": "listCatalogs",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: fields,entities",
"schema": {
"type": "string",
"enum": [
"fields",
"entities"
]
},
"required": false
},
{
"name": "sort",
"in": "query",
"description": "comma separated if needed. eg: created_at,updated_at",
"schema": {
"type": "string",
"enum": [
"created_at",
"-created_at",
"updated_at",
"-updated_at",
"position",
"-position"
]
},
"required": false
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[external_id]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[managed_by]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[managed_by][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[managed_by][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[managed_by][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[managed_by][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/catalog_list"
}
}
}
}
}
}
},
"/v1/catalogs/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "Resource UUID"
},
{
"type": "string",
"pattern": "^[a-z0-9_-]+$",
"description": "Resource slug"
}
]
},
"required": true
}
],
"get": {
"summary": "Retrieves a catalog",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Catalogs"
],
"description": "Retrieves a specific catalog by id",
"operationId": "getCatalog",
"responses": {
"200": {
"description": "catalog found by slug",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/catalog_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a catalog",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Catalogs"
],
"description": "Update a specific catalog by id",
"operationId": "updateCatalog",
"parameters": [],
"responses": {
"200": {
"description": "catalog updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/catalog_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_catalog"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a catalog",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Catalogs"
],
"description": "Delete a specific catalog by id",
"operationId": "deleteCatalog",
"responses": {
"200": {
"description": "catalog deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/catalog_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/causes": {
"post": {
"summary": "Creates a cause",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Causes"
],
"description": "Creates a new cause from provided data",
"operationId": "createCause",
"parameters": [],
"responses": {
"201": {
"description": "cause created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/cause_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_cause"
}
}
},
"required": true
}
},
"get": {
"summary": "List causes",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Causes"
],
"description": "List causes",
"operationId": "listCauses",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/cause_list"
}
}
}
}
}
}
},
"/v1/causes/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "Resource UUID"
},
{
"type": "string",
"pattern": "^[a-z0-9_-]+$",
"description": "Resource slug"
}
]
},
"required": true
}
],
"get": {
"summary": "Retrieves a cause",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Causes"
],
"description": "Retrieves a specific cause by id",
"operationId": "getCause",
"responses": {
"200": {
"description": "cause found by slug",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/cause_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a cause",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Causes"
],
"description": "Update a specific cause by id",
"operationId": "updateCause",
"parameters": [],
"responses": {
"200": {
"description": "cause updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/cause_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_cause"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a cause",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Causes"
],
"description": "Delete a specific cause by id",
"operationId": "deleteCause",
"responses": {
"200": {
"description": "cause deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/cause_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/causes/properties": {
"get": {
"summary": "List Catalog Properties",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Causes"
],
"description": "List Cause Catalog Properties",
"operationId": "listCauseCatalogProperties",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: catalog",
"schema": {
"type": "string",
"enum": [
"catalog"
]
},
"required": false
},
{
"name": "sort",
"in": "query",
"description": "comma separated if needed. eg: created_at,updated_at",
"schema": {
"type": "string",
"enum": [
"created_at",
"-created_at",
"updated_at",
"-updated_at",
"position",
"-position"
]
},
"required": false
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[kind]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/catalog_property_list"
}
}
}
}
}
},
"post": {
"summary": "Creates a Catalog Property",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Causes"
],
"description": "Creates a new Catalog Property from provided data",
"operationId": "createCauseCatalogProperty",
"parameters": [],
"responses": {
"201": {
"description": "catalog_property created ignores wrong catalog_type attribute",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/catalog_property_response"
}
}
}
},
"422": {
"description": "exceeds max fields per catalog",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_catalog_property"
}
}
},
"required": true
}
}
},
"/v1/communications/groups": {
"post": {
"summary": "Creates a communications group",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Communications Groups"
],
"description": "Creates a new communications group from provided data",
"operationId": "createCommunicationsGroup",
"parameters": [],
"responses": {
"201": {
"description": "communications group created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/communications_group_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_communications_group"
}
}
},
"required": true
}
},
"get": {
"summary": "Lists communications groups",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Communications Groups"
],
"description": "Lists communications groups",
"operationId": "listCommunicationsGroups",
"parameters": [
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[is_private]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[communication_type_id]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[condition_type]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "communications groups found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/communications_groups_response"
}
}
}
}
}
}
},
"/v1/communications/groups/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"description": "Communications Group ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Shows a communications group",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Communications Groups"
],
"description": "Shows details of a communications group",
"operationId": "getCommunicationsGroup",
"responses": {
"200": {
"description": "communications group found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/communications_group_response"
}
}
}
},
"404": {
"description": "communications group not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"patch": {
"summary": "Updates a communications group",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Communications Groups"
],
"description": "Updates a communications group",
"operationId": "updateCommunicationsGroup",
"parameters": [],
"responses": {
"200": {
"description": "communications group updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/communications_group_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_communications_group"
}
}
},
"required": true
}
},
"delete": {
"summary": "Deletes a communications group",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Communications Groups"
],
"description": "Deletes a communications group",
"operationId": "deleteCommunicationsGroup",
"responses": {
"200": {
"description": "communications group deleted"
},
"404": {
"description": "communications group not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/communications/stages": {
"post": {
"summary": "Creates a communications stage",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Communications Stages"
],
"description": "Creates a new communications stage from provided data",
"operationId": "createCommunicationsStage",
"parameters": [],
"responses": {
"201": {
"description": "communications stage created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/communications_stage_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "unauthorized",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_communications_stage"
}
}
},
"required": true
}
},
"get": {
"summary": "Lists communications stages",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Communications Stages"
],
"description": "Lists communications stages",
"operationId": "listCommunicationsStages",
"parameters": [
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "communications stages found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/communications_stages_response"
}
}
}
}
}
}
},
"/v1/communications/stages/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"description": "Communications Stage ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Shows a communications stage",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Communications Stages"
],
"description": "Shows details of a communications stage",
"operationId": "getCommunicationsStage",
"responses": {
"200": {
"description": "communications stage found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/communications_stage_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"patch": {
"summary": "Updates a communications stage",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Communications Stages"
],
"description": "Updates a communications stage",
"operationId": "updateCommunicationsStage",
"parameters": [],
"responses": {
"200": {
"description": "communications stage updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/communications_stage_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_communications_stage"
}
}
},
"required": true
}
},
"delete": {
"summary": "Deletes a communications stage",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Communications Stages"
],
"description": "Deletes a communications stage",
"operationId": "deleteCommunicationsStage",
"responses": {
"200": {
"description": "communications stage deleted"
},
"404": {
"description": "communications stage not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/communications/templates": {
"post": {
"summary": "Creates a communications template",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Communications Templates"
],
"description": "Creates a new communications template from provided data",
"operationId": "createCommunicationsTemplate",
"parameters": [],
"responses": {
"201": {
"description": "communications template created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/communications_template_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_communications_template"
}
}
},
"required": true
}
},
"get": {
"summary": "Lists communications templates",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Communications Templates"
],
"description": "Lists communications templates",
"operationId": "listCommunicationsTemplates",
"parameters": [
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[communication_type_id]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "communications templates found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/communications_templates_response"
}
}
}
}
}
}
},
"/v1/communications/templates/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"description": "Communications Template ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Shows a communications template",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Communications Templates"
],
"description": "Shows details of a communications template",
"operationId": "getCommunicationsTemplate",
"responses": {
"200": {
"description": "communications template found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/communications_template_response"
}
}
}
},
"404": {
"description": "communications template not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"patch": {
"summary": "Updates a communications template",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Communications Templates"
],
"description": "Updates a communications template",
"operationId": "updateCommunicationsTemplate",
"parameters": [],
"responses": {
"200": {
"description": "communications template updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/communications_template_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_communications_template"
}
}
},
"required": true
}
},
"delete": {
"summary": "Deletes a communications template",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Communications Templates"
],
"description": "Deletes a communications template",
"operationId": "deleteCommunicationsTemplate",
"responses": {
"200": {
"description": "communications template deleted"
},
"404": {
"description": "communications template not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/communications/types": {
"post": {
"summary": "Creates a communications type",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Communications Types"
],
"description": "Creates a new communications type from provided data",
"operationId": "createCommunicationsType",
"parameters": [],
"responses": {
"201": {
"description": "communications type created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/communications_type_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_communications_type"
}
}
},
"required": true
}
},
"get": {
"summary": "Lists communications types",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Communications Types"
],
"description": "Lists communications types",
"operationId": "listCommunicationsTypes",
"parameters": [
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "communications types found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/communications_types_response"
}
}
}
}
}
}
},
"/v1/communications/types/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"description": "Communications Type ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Shows a communications type",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Communications Types"
],
"description": "Shows details of a communications type",
"operationId": "getCommunicationsType",
"responses": {
"200": {
"description": "communications type found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/communications_type_response"
}
}
}
},
"404": {
"description": "communications type not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"patch": {
"summary": "Updates a communications type",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Communications Types"
],
"description": "Updates a communications type",
"operationId": "updateCommunicationsType",
"parameters": [],
"responses": {
"200": {
"description": "communications type updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/communications_type_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_communications_type"
}
}
},
"required": true
}
},
"delete": {
"summary": "Deletes a communications type",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Communications Types"
],
"description": "Deletes a communications type",
"operationId": "deleteCommunicationsType",
"responses": {
"200": {
"description": "communications type deleted"
},
"404": {
"description": "communications type not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/custom_fields/{custom_field_id}/options": {
"parameters": [
{
"name": "custom_field_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "[DEPRECATED] Creates a custom field option",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"[DEPRECATED] CustomFieldOptions"
],
"description": "[DEPRECATED] Use form field endpoints instead. Creates a new custom field option from provided data",
"deprecated": true,
"operationId": "createCustomFieldOption",
"parameters": [],
"responses": {
"201": {
"description": "custom_field_option created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/custom_field_option_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_custom_field_option"
}
}
},
"required": true
}
},
"get": {
"summary": "[DEPRECATED] List custom field options",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"[DEPRECATED] CustomFieldOptions"
],
"description": "[DEPRECATED] Use form field endpoints instead. List custom field options",
"deprecated": true,
"operationId": "listCustomFieldOptions",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[value]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[color]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/custom_field_option_list"
}
}
}
}
}
}
},
"/v1/custom_field_options/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "[DEPRECATED] Retrieves a custom field option",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"[DEPRECATED] CustomFieldOptions"
],
"description": "[DEPRECATED] Use form field endpoints instead. Retrieves a specific custom field option by id",
"deprecated": true,
"operationId": "getCustomFieldOption",
"responses": {
"200": {
"description": "custom_field_option found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/custom_field_option_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "[DEPRECATED] Update a custom field option",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"[DEPRECATED] CustomFieldOptions"
],
"description": "[DEPRECATED] Use form field endpoints instead. Update a specific custom field option by id",
"deprecated": true,
"operationId": "updateCustomFieldOption",
"parameters": [],
"responses": {
"200": {
"description": "custom_field_option updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/custom_field_option_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_custom_field_option"
}
}
},
"required": true
}
},
"delete": {
"summary": "[DEPRECATED] Delete a custom field option",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"[DEPRECATED] CustomFieldOptions"
],
"description": "[DEPRECATED] Use form field endpoints instead. Delete a specific Custom Field Option by id",
"deprecated": true,
"operationId": "deleteCustomFieldOption",
"responses": {
"200": {
"description": "custom_field_option deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/custom_field_option_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/custom_fields": {
"post": {
"summary": "[DEPRECATED] Creates a Custom Field",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"[DEPRECATED] CustomFields"
],
"description": "[DEPRECATED] Use form field endpoints instead. Creates a new custom field from provided data",
"deprecated": true,
"operationId": "createCustomField",
"parameters": [],
"responses": {
"201": {
"description": "custom_field created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/custom_field_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_custom_field"
}
}
},
"required": true
}
},
"get": {
"summary": "[DEPRECATED] List Custom Fields",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"[DEPRECATED] CustomFields"
],
"description": "[DEPRECATED] Use form field endpoints instead. List Custom fields",
"deprecated": true,
"operationId": "listCustomFields",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: options",
"schema": {
"type": "string",
"enum": [
"options"
]
},
"required": false
},
{
"name": "sort",
"in": "query",
"description": "comma separated if needed. eg: created_at,updated_at",
"schema": {
"type": "string",
"enum": [
"created_at",
"-created_at",
"updated_at",
"-updated_at",
"position",
"-position"
]
},
"required": false
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[label]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[kind]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[enabled]",
"in": "query",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[label][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[label][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[label][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[label][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[kind][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[kind][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[kind][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[kind][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[enabled][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[enabled][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[enabled][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[enabled][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/custom_field_list"
}
}
}
}
}
}
},
"/v1/custom_fields/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "[DEPRECATED] Retrieves a Custom Field",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"[DEPRECATED] CustomFields"
],
"description": "Retrieves a specific custom_field by id",
"deprecated": true,
"operationId": "getCustomField",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: options",
"schema": {
"type": "string",
"enum": [
"options"
]
},
"required": false
}
],
"responses": {
"200": {
"description": "custom_field found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/custom_field_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "[DEPRECATED] Update a Custom Field",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"[DEPRECATED] CustomFields"
],
"description": "[DEPRECATED] Use form field endpoints instead. Update a specific custom field by id",
"deprecated": true,
"operationId": "updateCustomField",
"parameters": [],
"responses": {
"200": {
"description": "custom_field updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/custom_field_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_custom_field"
}
}
},
"required": true
}
},
"delete": {
"summary": "[DEPRECATED] Delete a Custom Field",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"[DEPRECATED] CustomFields"
],
"description": "[DEPRECATED] Use form field endpoints instead. Delete a specific custom field by id",
"deprecated": true,
"operationId": "deleteCustomField",
"responses": {
"200": {
"description": "custom_field deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/custom_field_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/custom_forms": {
"post": {
"summary": "Creates a custom form",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"CustomForms"
],
"description": "Creates a new custom form from provided data",
"operationId": "createCustomForm",
"parameters": [],
"responses": {
"201": {
"description": "custom_form created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/custom_form_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_custom_form"
}
}
},
"required": true
}
},
"get": {
"summary": "List custom forms",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"CustomForms"
],
"description": "List custom forms",
"operationId": "listCustomForms",
"parameters": [
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[command]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "custom_form found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/custom_form_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/custom_forms/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "Resource UUID"
},
{
"type": "string",
"pattern": "^[a-z0-9_-]+$",
"description": "Resource slug"
}
]
},
"required": true
}
],
"get": {
"summary": "Retrieves a custom form",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"CustomForms"
],
"description": "Retrieves a specific custom form by id",
"operationId": "getCustomForm",
"responses": {
"200": {
"description": "custom_form found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/custom_form_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a custom form",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"CustomForms"
],
"description": "Update a specific custom form by id",
"operationId": "updateCustomForm",
"parameters": [],
"responses": {
"200": {
"description": "custom_form updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/custom_form_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_custom_form"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a custom form",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"CustomForms"
],
"description": "Delete a specific custom form by id",
"operationId": "deleteCustomForm",
"responses": {
"200": {
"description": "custom_form found by slug",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/custom_form_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/dashboards/{dashboard_id}/panels": {
"parameters": [
{
"name": "dashboard_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates a dashboard panel",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"DashboardPanels"
],
"description": "Creates a new dashboard panel from provided data",
"operationId": "createDashboardPanel",
"parameters": [],
"responses": {
"201": {
"description": "dashboard panel created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/dashboard_panel_response"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_dashboard_panel"
}
}
},
"required": true
}
},
"get": {
"summary": "List dashboard panels",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"DashboardPanels"
],
"description": "List dashboard panels",
"operationId": "listDashboardPanels",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/dashboard_panel_list"
}
}
}
}
}
}
},
"/v1/dashboard_panels/{id}/duplicate": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Duplicates a dashboard panel",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"DashboardPanels"
],
"description": "Duplicates a dashboard panel",
"operationId": "duplicateDashboardPanel",
"responses": {
"201": {
"description": "dashboard panel created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/dashboard_panel_response"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/dashboard_panels/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a dashboard panel",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"DashboardPanels"
],
"description": "Retrieves a specific dashboard panel by id",
"operationId": "getDashboardPanel",
"parameters": [
{
"name": "range",
"in": "query",
"required": false,
"description": "Date range for panel data, ISO8601 timestamps separated by the word 'to'. Ex: '2022-06-19T11:28:46.029Z to 2022-07-18T21:58:46.029Z'.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "query",
"required": false,
"description": "The time period to group data by. Accepts 'day', 'week', and 'month'",
"schema": {
"type": "string"
}
},
{
"name": "time_zone",
"in": "query",
"required": false,
"description": "The time zone to use for period",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "dashboard panel found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/dashboard_panel_response"
}
}
}
}
}
},
"put": {
"summary": "Update a dashboard panel",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"DashboardPanels"
],
"description": "Update a specific dashboard panel by id",
"operationId": "updateDashboardPanel",
"parameters": [],
"responses": {
"200": {
"description": "dashboard panel updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/dashboard_panel_response"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_dashboard_panel"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a dashboard panel",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"DashboardPanels"
],
"description": "Delete a specific dashboard panel by id",
"operationId": "deleteDashboardPanel",
"responses": {
"200": {
"description": "dashboard panel deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/dashboard_panel_response"
}
}
}
}
}
}
},
"/v1/dashboards": {
"post": {
"summary": "Creates a dashboard",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Dashboards"
],
"description": "Creates a new dashboard from provided data",
"operationId": "createDashboard",
"parameters": [],
"responses": {
"201": {
"description": "dashboard created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/dashboard_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_dashboard"
}
}
},
"required": true
}
},
"get": {
"summary": "List dashboards",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Dashboards"
],
"description": "List dashboards",
"operationId": "listDashboards",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: panels",
"schema": {
"type": "string",
"enum": [
"panels"
]
},
"required": false
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/dashboard_list"
}
}
}
}
}
}
},
"/v1/dashboards/{id}/duplicate": {
"parameters": [
{
"name": "id",
"in": "path",
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "Resource UUID"
},
{
"type": "string",
"pattern": "^[a-z0-9_-]+$",
"description": "Resource slug"
}
]
},
"required": true
}
],
"post": {
"summary": "Duplicates a dashboard",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Dashboards"
],
"description": "Duplicates a dashboard",
"operationId": "duplicateDashboard",
"responses": {
"201": {
"description": "dashboard created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/dashboard_response"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/dashboards/{id}/set_default": {
"parameters": [
{
"name": "id",
"in": "path",
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "Resource UUID"
},
{
"type": "string",
"pattern": "^[a-z0-9_-]+$",
"description": "Resource slug"
}
]
},
"required": true
}
],
"post": {
"summary": "Sets dashboard to user default",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Dashboards"
],
"description": "Sets dashboard to user default",
"operationId": "setDefaultDashboard",
"responses": {
"200": {
"description": "dashboard found by slug",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/dashboard_response"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/dashboards/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "Resource UUID"
},
{
"type": "string",
"pattern": "^[a-z0-9_-]+$",
"description": "Resource slug"
}
]
},
"required": true
}
],
"get": {
"summary": "Retrieves a dashboard",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Dashboards"
],
"description": "Retrieves a specific dashboard by id",
"operationId": "getDashboard",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: panels",
"schema": {
"type": "string",
"enum": [
"panels"
]
},
"required": false
}
],
"responses": {
"200": {
"description": "dashboard found by slug",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/dashboard_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a dashboard",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Dashboards"
],
"description": "Update a specific dashboard by id",
"operationId": "updateDashboard",
"parameters": [],
"responses": {
"200": {
"description": "dashboard updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/dashboard_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_dashboard"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a dashboard",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Dashboards"
],
"description": "Delete a specific dashboard by id",
"operationId": "deleteDashboard",
"responses": {
"200": {
"description": "dashboard deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/dashboard_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/edge_connectors/{edge_connector_id}/actions": {
"get": {
"summary": "List edge connector actions",
"operationId": "listEdgeConnectorActions",
"tags": [
"Edge Connector Actions"
],
"security": [
{
"bearer_auth": []
}
],
"parameters": [
{
"name": "edge_connector_id",
"in": "path",
"description": "Edge connector ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns list of actions"
},
"404": {
"description": "Edge connector not found"
}
}
},
"post": {
"summary": "Create edge connector action",
"operationId": "createEdgeConnectorAction",
"tags": [
"Edge Connector Actions"
],
"security": [
{
"bearer_auth": []
}
],
"parameters": [
{
"name": "edge_connector_id",
"in": "path",
"description": "Edge connector ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"201": {
"description": "Action created"
},
"422": {
"description": "Invalid parameters"
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"type": "object",
"properties": {
"action": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Action name"
},
"action_type": {
"type": "string",
"enum": [
"script",
"http"
],
"description": "Action type"
},
"metadata": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"timeout": {
"type": "integer"
},
"parameters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"boolean"
]
},
"required": {
"type": "boolean"
},
"description": {
"type": "string"
},
"options": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
}
},
"required": [
"name",
"action_type"
]
}
}
}
}
}
}
}
},
"/v1/edge_connectors/{edge_connector_id}/actions/{id}": {
"get": {
"summary": "Show edge connector action",
"operationId": "getEdgeConnectorAction",
"tags": [
"Edge Connector Actions"
],
"security": [
{
"bearer_auth": []
}
],
"parameters": [
{
"name": "edge_connector_id",
"in": "path",
"description": "Edge connector ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"in": "path",
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "Resource UUID"
},
{
"type": "string",
"pattern": "^[a-z0-9_-]+$",
"description": "Resource slug"
}
]
},
"required": true
}
],
"responses": {
"200": {
"description": "Returns action details"
},
"404": {
"description": "Action not found"
}
}
},
"patch": {
"summary": "Update edge connector action",
"operationId": "updateEdgeConnectorAction",
"tags": [
"Edge Connector Actions"
],
"security": [
{
"bearer_auth": []
}
],
"parameters": [
{
"name": "edge_connector_id",
"in": "path",
"description": "Edge connector ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"in": "path",
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "Resource UUID"
},
{
"type": "string",
"pattern": "^[a-z0-9_-]+$",
"description": "Resource slug"
}
]
},
"required": true
}
],
"responses": {
"200": {
"description": "Action updated"
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"type": "object",
"properties": {
"action": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"action_type": {
"type": "string",
"enum": [
"script",
"http"
]
},
"metadata": {
"type": "object"
}
}
}
}
}
}
}
}
},
"delete": {
"summary": "Delete edge connector action",
"operationId": "deleteEdgeConnectorAction",
"tags": [
"Edge Connector Actions"
],
"security": [
{
"bearer_auth": []
}
],
"parameters": [
{
"name": "edge_connector_id",
"in": "path",
"description": "Edge connector ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"in": "path",
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "Resource UUID"
},
{
"type": "string",
"pattern": "^[a-z0-9_-]+$",
"description": "Resource slug"
}
]
},
"required": true
}
],
"responses": {
"200": {
"description": "Action deleted"
}
}
}
},
"/v1/edge_connectors": {
"get": {
"summary": "List edge connectors",
"operationId": "listEdgeConnectors",
"tags": [
"Edge Connectors"
],
"security": [
{
"bearer_auth": []
}
],
"parameters": [
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "per_page",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "status",
"in": "query",
"required": false,
"description": "Filter by status (active/paused)",
"schema": {
"type": "string"
}
},
{
"name": "name",
"in": "query",
"required": false,
"description": "Filter by name (partial match)",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Filters by status"
}
}
},
"post": {
"summary": "Create edge connector",
"operationId": "createEdgeConnector",
"tags": [
"Edge Connectors"
],
"security": [
{
"bearer_auth": []
}
],
"parameters": [],
"responses": {
"201": {
"description": "Edge connector created"
},
"422": {
"description": "Invalid parameters"
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"edge_connectors"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Connector name"
},
"description": {
"type": "string",
"description": "Connector description"
},
"status": {
"type": "string",
"enum": [
"active",
"paused"
],
"description": "Connector status"
},
"subscriptions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of event types to subscribe to"
},
"filters": {
"type": "object",
"description": "Event filters. OR within dimension, AND across dimensions.",
"properties": {
"group_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Filter by group UUIDs"
},
"service_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Filter by service UUIDs"
},
"environment_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Filter by environment UUIDs"
},
"functionality_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Filter by functionality UUIDs"
}
},
"additionalProperties": false
}
},
"required": [
"name"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
}
}
}
}
}
},
"/v1/edge_connectors/{id}": {
"get": {
"summary": "Show edge connector",
"operationId": "getEdgeConnector",
"tags": [
"Edge Connectors"
],
"security": [
{
"bearer_auth": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "Edge connector ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns edge connector details"
},
"404": {
"description": "Edge connector not found"
}
}
},
"patch": {
"summary": "Update edge connector",
"operationId": "updateEdgeConnector",
"tags": [
"Edge Connectors"
],
"security": [
{
"bearer_auth": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "Edge connector ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Edge connector updated"
},
"422": {
"description": "Invalid parameters"
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"edge_connectors"
]
},
"id": {
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"active",
"paused"
]
},
"subscriptions": {
"type": "array",
"items": {
"type": "string"
}
},
"filters": {
"type": "object",
"description": "Event filters"
}
}
}
}
}
}
}
}
}
}
},
"delete": {
"summary": "Delete edge connector",
"operationId": "deleteEdgeConnector",
"tags": [
"Edge Connectors"
],
"security": [
{
"bearer_auth": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "Edge connector ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Edge connector deleted"
}
}
}
},
"/v1/environments": {
"post": {
"summary": "Creates an environment",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Environments"
],
"description": "Creates a new environment from provided data",
"operationId": "createEnvironment",
"parameters": [],
"responses": {
"201": {
"description": "environment created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/environment_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_environment"
}
}
},
"required": true
}
},
"get": {
"summary": "List environments",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Environments"
],
"description": "List environments",
"operationId": "listEnvironments",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[color]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[color][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[color][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[color][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[color][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/environment_list"
}
}
}
}
}
}
},
"/v1/environments/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "Resource UUID"
},
{
"type": "string",
"pattern": "^[a-z0-9_-]+$",
"description": "Resource slug"
}
]
},
"required": true
}
],
"get": {
"summary": "Retrieves an environment",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Environments"
],
"description": "Retrieves a specific environment by id",
"operationId": "getEnvironment",
"responses": {
"200": {
"description": "environment found by slug",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/environment_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update an environment",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Environments"
],
"description": "Update a specific environment by id",
"operationId": "updateEnvironment",
"parameters": [],
"responses": {
"200": {
"description": "environment updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/environment_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_environment"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete an environment",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Environments"
],
"description": "Delete a specific environment by id",
"operationId": "deleteEnvironment",
"responses": {
"200": {
"description": "environment deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/environment_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/environments/properties": {
"get": {
"summary": "List Catalog Properties",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Environments"
],
"description": "List Environment Catalog Properties",
"operationId": "listEnvironmentCatalogProperties",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: catalog",
"schema": {
"type": "string",
"enum": [
"catalog"
]
},
"required": false
},
{
"name": "sort",
"in": "query",
"description": "comma separated if needed. eg: created_at,updated_at",
"schema": {
"type": "string",
"enum": [
"created_at",
"-created_at",
"updated_at",
"-updated_at",
"position",
"-position"
]
},
"required": false
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[kind]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/catalog_property_list"
}
}
}
}
}
},
"post": {
"summary": "Creates a Catalog Property",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Environments"
],
"description": "Creates a new Catalog Property from provided data",
"operationId": "createEnvironmentCatalogProperty",
"parameters": [],
"responses": {
"201": {
"description": "catalog_property created ignores wrong catalog_type attribute",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/catalog_property_response"
}
}
}
},
"422": {
"description": "exceeds max fields per catalog",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_catalog_property"
}
}
},
"required": true
}
}
},
"/v1/escalation_policies": {
"post": {
"summary": "Creates an escalation policy",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"EscalationPolicies"
],
"description": "Creates a new escalation policy from provided data",
"operationId": "createEscalationPolicy",
"parameters": [],
"responses": {
"201": {
"description": "escalation policy created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/escalation_policy_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_escalation_policy"
}
}
},
"required": true
}
},
"get": {
"summary": "List escalation policies",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"EscalationPolicies"
],
"description": "List escalation policies",
"operationId": "listEscalationPolicies",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: escalation_policy_levels,escalation_policy_paths",
"schema": {
"type": "string",
"enum": [
"escalation_policy_levels",
"escalation_policy_paths",
"groups",
"services"
]
},
"required": false
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[team_ids]",
"in": "query",
"required": false,
"description": "Filter escalation policies by associated team IDs. Comma-separate multiple values.",
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[team_ids][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[team_ids][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[team_ids][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[team_ids][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/escalation_policy_list"
}
}
}
}
}
}
},
"/v1/escalation_policies/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves an escalation policy",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"EscalationPolicies"
],
"description": "Retrieves a specific escalation policy by id",
"operationId": "getEscalationPolicy",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: escalation_policy_levels,escalation_policy_paths",
"schema": {
"type": "string",
"enum": [
"escalation_policy_levels",
"escalation_policy_paths",
"groups",
"services"
]
},
"required": false
}
],
"responses": {
"200": {
"description": "escalation policy found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/escalation_policy_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update an escalation policy",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"EscalationPolicies"
],
"description": "Update a specific escalation policy by id",
"operationId": "updateEscalationPolicy",
"parameters": [],
"responses": {
"200": {
"description": "escalation policy updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/escalation_policy_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_escalation_policy"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete an escalation policy",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"EscalationPolicies"
],
"description": "Delete a specific escalation policy by id",
"operationId": "deleteEscalationPolicy",
"responses": {
"200": {
"description": "escalation policy deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/escalation_policy_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/escalation_policies/{escalation_policy_id}/escalation_levels": {
"parameters": [
{
"name": "escalation_policy_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates an escalation level for an Escalation Policy",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"EscalationLevelsPolicies"
],
"description": "Creates a new escalation level from provided data",
"operationId": "createEscalationLevel",
"parameters": [],
"responses": {
"201": {
"description": "escalation level created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/escalation_policy_level_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_escalation_policy_level"
}
}
},
"required": true
}
},
"get": {
"summary": "List escalation levels for an Escalation Policy",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"EscalationLevelsPolicies"
],
"description": "List escalation levels",
"operationId": "listEscalationLevels",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/escalation_policy_level_list"
}
}
}
}
}
}
},
"/v1/escalation_paths/{escalation_policy_path_id}/escalation_levels": {
"parameters": [
{
"name": "escalation_policy_path_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates an escalation level for an Escalation Path",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"EscalationLevelsPath"
],
"description": "Creates a new escalation level from provided data",
"operationId": "createEscalationLevelPaths",
"parameters": [],
"responses": {
"201": {
"description": "escalation level created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/escalation_policy_level_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_escalation_policy_level"
}
}
},
"required": true
}
},
"get": {
"summary": "List escalation levels for an Escalation Path",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"EscalationLevelsPath"
],
"description": "List escalation levels",
"operationId": "listEscalationLevelsPaths",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/escalation_policy_level_list"
}
}
}
}
}
}
},
"/v1/escalation_levels/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves an escalation level",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"EscalationLevels"
],
"description": "Retrieves a specific escalation level by id",
"operationId": "getEscalationLevel",
"responses": {
"200": {
"description": "escalation level found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/escalation_policy_level_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update an escalation level",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"EscalationLevels"
],
"description": "Update a specific escalation level by id",
"operationId": "updateEscalationLevel",
"parameters": [],
"responses": {
"200": {
"description": "escalation policy updated with notification_target set with slack_channel_id instead of slack_channel uuid",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/escalation_policy_level_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_escalation_policy_level"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete an escalation level",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"EscalationLevels"
],
"description": "Delete a specific escalation level by id",
"operationId": "deleteEscalationLevel",
"responses": {
"200": {
"description": "escalation level deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/escalation_policy_level_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/escalation_policies/{escalation_policy_id}/escalation_paths": {
"parameters": [
{
"name": "escalation_policy_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates an escalation path",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"EscalationPaths"
],
"description": "Creates a new escalation path from provided data",
"operationId": "createEscalationPath",
"parameters": [],
"responses": {
"201": {
"description": "escalation path created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/escalation_policy_path_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_escalation_policy_path"
}
}
},
"required": true
}
},
"get": {
"summary": "List escalation paths",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"EscalationPaths"
],
"description": "List escalation paths",
"operationId": "listEscalationPaths",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: escalation_policy_levels",
"schema": {
"type": "string",
"enum": [
"escalation_policy_levels"
]
},
"required": false
},
{
"name": "filter[path_type]",
"in": "query",
"description": "Filter by path_type. Returns all path types when omitted.",
"schema": {
"type": "string",
"enum": [
"escalation",
"deferral"
]
},
"required": false
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/escalation_policy_path_list"
}
}
}
}
}
}
},
"/v1/escalation_paths/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves an escalation path",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"EscalationPaths"
],
"description": "Retrieves a specific escalation path by id",
"operationId": "getEscalationPath",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: escalation_policy_levels",
"schema": {
"type": "string",
"enum": [
"escalation_policy_levels"
]
},
"required": false
}
],
"responses": {
"200": {
"description": "escalation path found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/escalation_policy_path_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update an escalation path",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"EscalationPaths"
],
"description": "Update a specific escalation path by id",
"operationId": "updateEscalationPath",
"parameters": [],
"responses": {
"200": {
"description": "escalation policy updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/escalation_policy_path_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_escalation_policy_path"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete an escalation path",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"EscalationPaths"
],
"description": "Delete a specific escalation path by id",
"operationId": "deleteEscalationPath",
"responses": {
"200": {
"description": "escalation path deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/escalation_policy_path_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/form_fields/{form_field_id}/options": {
"parameters": [
{
"name": "form_field_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates FormField Options",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormFieldOptions"
],
"description": "Creates a new form_field_option from provided data",
"operationId": "createFormFieldOption",
"parameters": [],
"responses": {
"201": {
"description": "form_field_option created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/form_field_option_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_form_field_option"
}
}
},
"required": true
}
},
"get": {
"summary": "List FormField Options",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormFieldOptions"
],
"description": "List form_field_options",
"operationId": "listFormFieldOptions",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[value]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[color]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/form_field_option_list"
}
}
}
}
}
}
},
"/v1/form_field_options/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves FormField Options",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormFieldOptions"
],
"description": "Retrieves a specific form_field_option by id",
"operationId": "getFormFieldOption",
"responses": {
"200": {
"description": "form_field_option found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/form_field_option_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update FormField Options",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormFieldOptions"
],
"description": "Update a specific form_field_option by id",
"operationId": "updateFormFieldOption",
"parameters": [],
"responses": {
"200": {
"description": "form_field_option updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/form_field_option_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_form_field_option"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete FormField Options",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormFieldOptions"
],
"description": "Delete a specific form_field_option by id",
"operationId": "deleteFormFieldOption",
"responses": {
"200": {
"description": "form_field_option deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/form_field_option_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/form_field_placements/{form_field_placement_id}/conditions": {
"parameters": [
{
"name": "form_field_placement_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates a Form Set Condition",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormFieldPlacementConditions"
],
"description": "Creates a new form_field_placement_condition from provided data",
"operationId": "createFormFieldPlacementCondition",
"parameters": [],
"responses": {
"201": {
"description": "form_field_placement_condition created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/form_field_placement_condition_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_form_field_placement_condition"
}
}
},
"required": true
}
},
"get": {
"summary": "List Form Set Conditions",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormFieldPlacementConditions"
],
"description": "List form_field_placement_conditions",
"operationId": "listFormFieldPlacementConditions",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[form_field_id]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/form_field_placement_condition_list"
}
}
}
}
}
}
},
"/v1/form_field_placement_conditions/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a Form Set Condition",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormFieldPlacementConditions"
],
"description": "Retrieves a specific form_field_placement_condition by id",
"operationId": "getFormFieldPlacementCondition",
"responses": {
"200": {
"description": "form_field_placement_condition found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/form_field_placement_condition_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a Form Set Condition",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormFieldPlacementConditions"
],
"description": "Update a specific form_field_placement_condition by id",
"operationId": "updateFormFieldPlacementCondition",
"parameters": [],
"responses": {
"200": {
"description": "form_field_placement_condition updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/form_field_placement_condition_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_form_field_placement_condition"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a Form Set Condition",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormFieldPlacementConditions"
],
"description": "Delete a specific form_field_placement_condition by id",
"operationId": "deleteFormFieldPlacementCondition",
"responses": {
"200": {
"description": "form_field_placement_condition deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/form_field_placement_condition_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/form_fields/{form_field_id}/placements": {
"parameters": [
{
"name": "form_field_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates a Form Field Placement",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormFieldPlacements"
],
"description": "Creates a new form_field_placement from provided data",
"operationId": "createFormFieldPlacement",
"parameters": [],
"responses": {
"201": {
"description": "form_field_placement created with non_editable true",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/form_field_placement_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_form_field_placement"
}
}
},
"required": true
}
},
"get": {
"summary": "List Form Field Placements",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormFieldPlacements"
],
"description": "List form_field_placements",
"operationId": "listFormFieldPlacements",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[form_field_id]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/form_field_placement_list"
}
}
}
}
}
}
},
"/v1/form_field_placements/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a Form Field Placement",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormFieldPlacements"
],
"description": "Retrieves a specific form_field_placement by id",
"operationId": "getFormFieldPlacement",
"responses": {
"200": {
"description": "form_field_placement found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/form_field_placement_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a Form Field Placement",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormFieldPlacements"
],
"description": "Update a specific form_field_placement by id",
"operationId": "updateFormFieldPlacement",
"parameters": [],
"responses": {
"200": {
"description": "form_field_placement updated with non_editable",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/form_field_placement_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_form_field_placement"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a Form Field Placement",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormFieldPlacements"
],
"description": "Delete a specific form_field_placement by id",
"operationId": "deleteFormFieldPlacement",
"responses": {
"200": {
"description": "form_field_placement deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/form_field_placement_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/form_fields/{form_field_id}/positions": {
"parameters": [
{
"name": "form_field_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "List FormField Position",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormFieldPositions"
],
"description": "List form field positions",
"operationId": "listFormFieldPositions",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[form]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/form_field_position_list"
}
}
}
}
}
},
"post": {
"summary": "Creates FormField Positions",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormFieldPositions"
],
"description": "Creates a new form field_position from provided data",
"operationId": "createFormFieldPosition",
"parameters": [],
"responses": {
"201": {
"description": "form_field_position created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/form_field_position_response"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_form_field_position"
}
}
},
"required": true
}
}
},
"/v1/form_field_positions/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a FormFieldPosition",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormFieldPositions"
],
"description": "Retrieves a specific form field_position by id",
"operationId": "getFormFieldPosition",
"responses": {
"200": {
"description": "form_field_position found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/form_field_position_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a FormFieldPosition",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormFieldPositions"
],
"description": "Update a specific form_field position by id",
"operationId": "updateFormFieldPosition",
"parameters": [],
"responses": {
"200": {
"description": "form_field_position updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/form_field_position_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_form_field_position"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a FormFieldPosition",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormFieldPositions"
],
"description": "Delete a specific form_field position by id",
"operationId": "deleteFormFieldPosition",
"responses": {
"200": {
"description": "form_field_position deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/form_field_position_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/form_fields": {
"post": {
"summary": "Creates a Form Field",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormFields"
],
"description": "Creates a new form_field from provided data",
"operationId": "createFormField",
"parameters": [],
"responses": {
"201": {
"description": "form_field created with auto_set_by_catalog_property_id",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/form_field_response"
}
}
}
},
"422": {
"description": "form_field creation fails with auto_set_by_catalog_property_id for catalog fields of different type",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_form_field"
}
}
},
"required": true
}
},
"get": {
"summary": "List Form Fields",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormFields"
],
"description": "List form_fields",
"operationId": "listFormFields",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: options,positions",
"schema": {
"type": "string",
"enum": [
"options",
"positions"
]
},
"required": false
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[kind]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[enabled]",
"in": "query",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[kind][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[kind][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[kind][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[kind][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[enabled][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[enabled][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[enabled][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[enabled][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/form_field_list"
}
}
}
}
}
}
},
"/v1/form_fields/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "Resource UUID"
},
{
"type": "string",
"pattern": "^[a-z0-9_-]+$",
"description": "Resource slug"
}
]
},
"required": true
}
],
"get": {
"summary": "Retrieves a Form Field",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormFields"
],
"description": "Retrieves a specific form_field by id",
"operationId": "getFormField",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: options,positions",
"schema": {
"type": "string",
"enum": [
"options",
"positions"
]
},
"required": false
}
],
"responses": {
"200": {
"description": "form_field found by slug",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/form_field_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a Form Field",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormFields"
],
"description": "Update a specific form_field by id",
"operationId": "updateFormField",
"parameters": [],
"responses": {
"200": {
"description": "form_field updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/form_field_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_form_field"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a Form Field",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormFields"
],
"description": "Delete a specific form_field by id",
"operationId": "deleteFormField",
"responses": {
"200": {
"description": "form_field deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/form_field_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/form_sets/{form_set_id}/conditions": {
"parameters": [
{
"name": "form_set_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates a Form Set Condition",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormSetConditions"
],
"description": "Creates a new form_set_condition from provided data",
"operationId": "createFormSetCondition",
"parameters": [],
"responses": {
"201": {
"description": "form_set_condition created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/form_set_condition_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_form_set_condition"
}
}
},
"required": true
}
},
"get": {
"summary": "List Form Set Conditions",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormSetConditions"
],
"description": "List form_set_conditions",
"operationId": "listFormSetConditions",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[form_field_id]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/form_set_condition_list"
}
}
}
}
}
}
},
"/v1/form_set_conditions/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a Form Set Condition",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormSetConditions"
],
"description": "Retrieves a specific form_set_condition by id",
"operationId": "getFormSetCondition",
"responses": {
"200": {
"description": "form_set_condition found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/form_set_condition_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a Form Set Condition",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormSetConditions"
],
"description": "Update a specific form_set_condition by id",
"operationId": "updateFormSetCondition",
"parameters": [],
"responses": {
"200": {
"description": "form_set_condition updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/form_set_condition_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_form_set_condition"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a Form Set Condition",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormSetConditions"
],
"description": "Delete a specific form_set_condition by id",
"operationId": "deleteFormSetCondition",
"responses": {
"200": {
"description": "form_set_condition deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/form_set_condition_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/form_sets": {
"post": {
"summary": "Creates a Form Set",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormSets"
],
"description": "Creates a new form_set from provided data",
"operationId": "createFormSet",
"parameters": [],
"responses": {
"201": {
"description": "form_set created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/form_set_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_form_set"
}
}
},
"required": true
}
},
"get": {
"summary": "List Form Sets",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormSets"
],
"description": "List form_sets",
"operationId": "listFormSets",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[is_default]",
"in": "query",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/form_set_list"
}
}
}
}
}
}
},
"/v1/form_sets/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "Resource UUID"
},
{
"type": "string",
"pattern": "^[a-z0-9_-]+$",
"description": "Resource slug"
}
]
},
"required": true
}
],
"get": {
"summary": "Retrieves a Form Set",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormSets"
],
"description": "Retrieves a specific form_set by id",
"operationId": "getFormSet",
"responses": {
"200": {
"description": "form_set found by slug",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/form_set_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a Form Set",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormSets"
],
"description": "Update a specific form_set by id",
"operationId": "updateFormSet",
"parameters": [],
"responses": {
"200": {
"description": "form_set updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/form_set_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_form_set"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a Form Set",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormSets"
],
"description": "Delete a specific form_set by id",
"operationId": "deleteFormSet",
"responses": {
"200": {
"description": "form_set deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/form_set_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/functionalities": {
"post": {
"summary": "Creates a functionality",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Functionalities"
],
"description": "Creates a new functionality from provided data",
"operationId": "createFunctionality",
"parameters": [],
"responses": {
"201": {
"description": "functionality created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/functionality_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_functionality"
}
}
},
"required": true
}
},
"get": {
"summary": "List functionalities",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Functionalities"
],
"description": "List functionalities",
"operationId": "listFunctionalities",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[backstage_id]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[cortex_id]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[opslevel_id]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[external_id]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/functionality_list"
}
}
}
}
}
}
},
"/v1/functionalities/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "Resource UUID"
},
{
"type": "string",
"pattern": "^[a-z0-9_-]+$",
"description": "Resource slug"
}
]
},
"required": true
}
],
"get": {
"summary": "Retrieves a functionality",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Functionalities"
],
"description": "Retrieves a specific functionality by id",
"operationId": "getFunctionality",
"responses": {
"200": {
"description": "functionality found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/functionality_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a functionality",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Functionalities"
],
"description": "Update a specific functionality by id",
"operationId": "updateFunctionality",
"parameters": [],
"responses": {
"200": {
"description": "functionality updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/functionality_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_functionality"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a functionality",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Functionalities"
],
"description": "Delete a specific functionality by id",
"operationId": "deleteFunctionality",
"responses": {
"200": {
"description": "functionality deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/functionality_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/functionalities/{id}/incidents_chart": {
"parameters": [
{
"name": "id",
"in": "path",
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "Resource UUID"
},
{
"type": "string",
"pattern": "^[a-z0-9_-]+$",
"description": "Resource slug"
}
]
},
"required": true
}
],
"get": {
"summary": "Get functionality incidents chart",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Functionalities"
],
"description": "Get functionality incidents chart",
"operationId": "getFunctionalityIncidentsChart",
"parameters": [
{
"name": "period",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incidents_chart_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/functionalities/{id}/uptime_chart": {
"parameters": [
{
"name": "id",
"in": "path",
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "Resource UUID"
},
{
"type": "string",
"pattern": "^[a-z0-9_-]+$",
"description": "Resource slug"
}
]
},
"required": true
}
],
"get": {
"summary": "Get functionality uptime chart",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Functionalities"
],
"description": "Get functionality uptime chart",
"operationId": "getFunctionalityUptimeChart",
"parameters": [
{
"name": "period",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/uptime_chart_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/functionalities/properties": {
"get": {
"summary": "List Catalog Properties",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Functionalities"
],
"description": "List Functionality Catalog Properties",
"operationId": "listFunctionalityCatalogProperties",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: catalog",
"schema": {
"type": "string",
"enum": [
"catalog"
]
},
"required": false
},
{
"name": "sort",
"in": "query",
"description": "comma separated if needed. eg: created_at,updated_at",
"schema": {
"type": "string",
"enum": [
"created_at",
"-created_at",
"updated_at",
"-updated_at",
"position",
"-position"
]
},
"required": false
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[kind]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/catalog_property_list"
}
}
}
}
}
},
"post": {
"summary": "Creates a Catalog Property",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Functionalities"
],
"description": "Creates a new Catalog Property from provided data",
"operationId": "createFunctionalityCatalogProperty",
"parameters": [],
"responses": {
"201": {
"description": "catalog_property created ignores wrong catalog_type attribute",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/catalog_property_response"
}
}
}
},
"422": {
"description": "exceeds max fields per catalog",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_catalog_property"
}
}
},
"required": true
}
}
},
"/v1/workflows/{workflow_id}/workflow_tasks": {
"parameters": [
{
"name": "workflow_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates a workflow task",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"WorkflowTasks"
],
"description": "Creates a new workflow task from provided data",
"operationId": "createWorkflowTask",
"parameters": [],
"responses": {
"201": {
"description": "workflow task created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/workflow_task_response"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_workflow_task"
}
}
},
"required": true
}
},
"get": {
"summary": "List workflow tasks",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"WorkflowTasks"
],
"description": "List workflow tasks",
"operationId": "listWorkflowTasks",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/workflow_task_list"
}
}
}
}
}
}
},
"/v1/workflow_tasks/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a workflow task",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"WorkflowTasks"
],
"description": "Retrieves a specific workflow_task by id",
"operationId": "getWorkflowTask",
"responses": {
"200": {
"description": "workflow_task found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/workflow_task_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a workflow task",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"WorkflowTasks"
],
"description": "Update a specific workflow task by id",
"operationId": "updateWorkflowTask",
"parameters": [],
"responses": {
"200": {
"description": "workflow_task updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/workflow_task_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_workflow_task"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a workflow task",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"WorkflowTasks"
],
"description": "Delete a specific workflow task by id",
"operationId": "deleteWorkflowTask",
"responses": {
"200": {
"description": "workflow_task deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/workflow_task_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/workflows/{workflow_id}/action_item_form_field_conditions": {
"parameters": [
{
"name": "workflow_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates a workflow action item form field condition",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"WorkflowActionItemFormFieldConditions"
],
"description": "Creates a new workflow action item form field condition from provided data",
"operationId": "createWorkflowActionItemFormFieldCondition",
"parameters": [],
"responses": {
"201": {
"description": "workflow_action_item_form_field_condition created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/workflow_action_item_form_field_condition_response"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"403": {
"description": "responds with forbidden when the feature flag is disabled"
},
"422": {
"description": "rejects conditions on a non-action-item workflow",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_workflow_action_item_form_field_condition"
}
}
},
"required": true
}
},
"get": {
"summary": "List workflow action item form field conditions",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"WorkflowActionItemFormFieldConditions"
],
"description": "List workflow action item form field conditions",
"operationId": "listWorkflowActionItemFormFieldConditions",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/workflow_action_item_form_field_condition_list"
}
}
}
}
}
}
},
"/v1/workflow_action_item_form_field_conditions/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a workflow action item form field condition",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"WorkflowActionItemFormFieldConditions"
],
"description": "Retrieves a specific workflow action item form field condition by id",
"operationId": "getWorkflowActionItemFormFieldCondition",
"responses": {
"200": {
"description": "includes native field ids",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/workflow_action_item_form_field_condition_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a workflow action item form field condition",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"WorkflowActionItemFormFieldConditions"
],
"description": "Update a specific workflow action item form field condition by id",
"operationId": "updateWorkflowActionItemFormFieldCondition",
"parameters": [],
"responses": {
"200": {
"description": "ignores non-allowlisted attributes such as workflow_id",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/workflow_action_item_form_field_condition_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_workflow_action_item_form_field_condition"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a workflow action item form field condition",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"WorkflowActionItemFormFieldConditions"
],
"description": "Delete a specific workflow action item form field condition by id",
"operationId": "deleteWorkflowActionItemFormFieldCondition",
"responses": {
"200": {
"description": "allows deleting an existing condition when the feature flag is disabled",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/workflow_action_item_form_field_condition_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/workflows/{workflow_id}/custom_field_selections": {
"parameters": [
{
"name": "workflow_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "[DEPRECATED] Creates a workflow custom field selection",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"[DEPRECATED] WorkflowCustomFieldSelections"
],
"description": "[DEPRECATED] Use form field endpoints instead. Creates a new workflow custom field selection from provided data",
"deprecated": true,
"operationId": "createWorkflowCustomFieldSelection",
"parameters": [],
"responses": {
"201": {
"description": "workflow_custom_field_selection created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/workflow_custom_field_selection_response"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_workflow_custom_field_selection"
}
}
},
"required": true
}
},
"get": {
"summary": "[DEPRECATED] List workflow custom field selections",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"[DEPRECATED] WorkflowCustomFieldSelections"
],
"description": "[DEPRECATED] Use form field endpoints instead. List workflow custom field selections",
"deprecated": true,
"operationId": "listWorkflowCustomFieldSelections",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/workflow_custom_field_selection_list"
}
}
}
}
}
}
},
"/v1/workflow_custom_field_selections/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "[DEPRECATED] Retrieves a workflow custom field selection",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"[DEPRECATED] WorkflowCustomFieldSelections"
],
"description": "[DEPRECATED] Use form field endpoints instead. Retrieves a specific workflow custom field selection by id",
"deprecated": true,
"operationId": "getWorkflowCustomFieldSelection",
"responses": {
"200": {
"description": "workflow_custom_field_selection found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/workflow_custom_field_selection_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "[DEPRECATED] Update a workflow custom field selection",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"[DEPRECATED] WorkflowCustomFieldSelections"
],
"description": "[DEPRECATED] Use form field endpoints instead. Update a specific workflow custom field selection by id",
"deprecated": true,
"operationId": "updateWorkflowCustomFieldSelection",
"parameters": [],
"responses": {
"200": {
"description": "workflow_custom_field_selection updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/workflow_custom_field_selection_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_workflow_custom_field_selection"
}
}
},
"required": true
}
},
"delete": {
"summary": "[DEPRECATED] Delete a workflow custom field selection",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"[DEPRECATED] WorkflowCustomFieldSelections"
],
"description": "[DEPRECATED] Use form field endpoints instead. Delete a specific workflow custom field selection by id",
"deprecated": true,
"operationId": "deleteWorkflowCustomFieldSelection",
"responses": {
"200": {
"description": "workflow_custom_field_selection deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/workflow_custom_field_selection_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/workflows/{workflow_id}/form_field_conditions": {
"parameters": [
{
"name": "workflow_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates a workflow form field condition",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"WorkflowFormFieldConditions"
],
"description": "Creates a new workflow form field condition from provided data",
"operationId": "createWorkflowFormFieldCondition",
"parameters": [],
"responses": {
"201": {
"description": "workflow_form_field_condition created with environment ids for non-environment form field",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/workflow_form_field_condition_response"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_workflow_form_field_condition"
}
}
},
"required": true
}
},
"get": {
"summary": "List workflow form field conditions",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"WorkflowFormFieldConditions"
],
"description": "List workflow form field conditions",
"operationId": "listWorkflowFormFieldConditions",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/workflow_form_field_condition_list"
}
}
}
}
}
}
},
"/v1/workflow_form_field_conditions/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a workflow form field condition",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"WorkflowFormFieldConditions"
],
"description": "Retrieves a specific workflow form field condition by id",
"operationId": "getWorkflowFormFieldCondition",
"responses": {
"200": {
"description": "includes native field ids",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/workflow_form_field_condition_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a workflow form field condition",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"WorkflowFormFieldConditions"
],
"description": "Update a specific workflow form field condition by id",
"operationId": "updateWorkflowFormFieldCondition",
"parameters": [],
"responses": {
"200": {
"description": "workflow_form_field_condition updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/workflow_form_field_condition_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_workflow_form_field_condition"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a workflow_form field condition",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"WorkflowFormFieldConditions"
],
"description": "Delete a specific workflow form field condition by id",
"operationId": "deleteWorkflowFormFieldCondition",
"responses": {
"200": {
"description": "workflow_form_field_condition deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/workflow_form_field_condition_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/workflow_groups": {
"post": {
"summary": "Creates a workflow group",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"WorkflowGroups"
],
"description": "Creates a new workflow group from provided data",
"operationId": "createWorkflowGroup",
"parameters": [],
"responses": {
"201": {
"description": "workflow group created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/workflow_group_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_workflow_group"
}
}
},
"required": true
}
},
"get": {
"summary": "List workflow groups",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"WorkflowGroups"
],
"description": "List workflow groups",
"operationId": "listWorkflowGroups",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[kind]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[expanded]",
"in": "query",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"name": "filter[position]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/workflow_group_list"
}
}
}
}
}
}
},
"/v1/workflow_groups/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a workflow group",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"WorkflowGroups"
],
"description": "Retrieves a specific workflow group by id",
"operationId": "getWorkflowGroup",
"responses": {
"200": {
"description": "workflow group found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/workflow_group_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a workflow group",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"WorkflowGroups"
],
"description": "Update a specific workflow group by id",
"operationId": "updateWorkflowGroup",
"parameters": [],
"responses": {
"200": {
"description": "workflow group updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/workflow_group_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_workflow_group"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a workflow_group",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"WorkflowGroups"
],
"description": "Delete a specific workflow group by id",
"operationId": "deleteWorkflowGroup",
"responses": {
"200": {
"description": "workflow group deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/workflow_group_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/workflows/{workflow_id}/workflow_runs": {
"parameters": [
{
"name": "workflow_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "List workflow runs",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"WorkflowRuns"
],
"description": "List workflow runs",
"operationId": "ListWorkflowRuns",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: genius_task_runs",
"schema": {
"type": "string",
"enum": [
"genius_task_runs"
]
},
"required": false
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success with date filters using gte with timezone",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/workflow_runs_list"
}
}
}
}
}
},
"post": {
"summary": "Creates a workflow run",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"WorkflowRuns"
],
"description": "Creates a new workflow run from provided data",
"operationId": "createWorkflowRun",
"parameters": [],
"responses": {
"201": {
"description": "workflow run created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/workflow_run_response"
}
}
}
},
"422": {
"description": "workflow run not created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_workflow_run"
}
}
},
"required": true
}
}
},
"/v1/workflows": {
"post": {
"summary": "Creates a workflow",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Workflows"
],
"description": "Creates a new workflow from provided data",
"operationId": "createWorkflow",
"parameters": [],
"responses": {
"201": {
"description": "ignores alert field conditions in create request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/workflow_response"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"403": {
"description": "non-admins can't set 'locked' while creating a workflow",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_workflow"
}
}
},
"required": true
}
},
"get": {
"summary": "List workflows",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Workflows"
],
"description": "List workflows",
"operationId": "listWorkflows",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: form_field_conditions,alert_field_conditions",
"schema": {
"type": "string",
"enum": [
"form_field_conditions",
"alert_field_conditions",
"genius_tasks",
"genius_workflow_runs"
]
},
"required": false
},
{
"name": "sort",
"in": "query",
"description": "comma separated if needed. eg: created_at,updated_at",
"schema": {
"type": "string",
"enum": [
"created_at",
"-created_at",
"updated_at",
"-updated_at",
"position",
"-position"
]
},
"required": false
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/workflow_list"
}
}
}
}
}
}
},
"/v1/workflows/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "Resource UUID"
},
{
"type": "string",
"pattern": "^[a-z0-9_-]+$",
"description": "Resource slug"
}
]
},
"required": true
}
],
"get": {
"summary": "Retrieves a workflow",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Workflows"
],
"description": "Retrieves a specific workflow by id",
"operationId": "getWorkflow",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: form_field_conditions,alert_field_conditions",
"schema": {
"type": "string",
"enum": [
"form_field_conditions",
"alert_field_conditions",
"genius_tasks",
"genius_workflow_runs"
]
},
"required": false
}
],
"responses": {
"200": {
"description": "does not serialize alert field conditions",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/workflow_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a workflow",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Workflows"
],
"description": "Update a specific workflow by id",
"operationId": "updateWorkflow",
"parameters": [],
"responses": {
"200": {
"description": "preserves repeat_condition_* fields when omitted from PATCH payload",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/workflow_response"
}
}
}
},
"404": {
"description": "non-admin can't update locked workflow",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"403": {
"description": "non-admin can't update 'locked' attribute",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_workflow"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a workflow",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Workflows"
],
"description": "Delete a specific workflow by id",
"operationId": "deleteWorkflow",
"responses": {
"200": {
"description": "admin can destroy locked workflow",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/workflow_response"
}
}
}
},
"404": {
"description": "non-admin can't destroy locked workflow",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/heartbeats/{heartbeat_id}/ping": {
"parameters": [
{
"name": "heartbeat_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Ping a heartbeat",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Heartbeats"
],
"description": "Ping a specific heartbeat by id",
"operationId": "pingHeartbeat",
"responses": {
"204": {
"description": "create ping"
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/heartbeats": {
"post": {
"summary": "Creates a heartbeat",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Heartbeats"
],
"description": "Creates a new heartbeat from provided data",
"operationId": "createHeartbeat",
"parameters": [],
"responses": {
"201": {
"description": "heartbeat created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/heartbeat_response"
}
}
}
},
"422": {
"description": "interval less than 60 seconds",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_heartbeat"
}
}
},
"required": true
}
},
"get": {
"summary": "List heartbeats",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Heartbeats"
],
"description": "List heartbeats",
"operationId": "listHeartbeats",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "filter by name",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/heartbeat_list"
}
}
}
}
}
}
},
"/v1/heartbeats/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "Resource UUID"
},
{
"type": "string",
"pattern": "^[a-z0-9_-]+$",
"description": "Resource slug"
}
]
},
"required": true
}
],
"get": {
"summary": "Retrieves a heartbeat",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Heartbeats"
],
"description": "Retrieves a specific heartbeat by id",
"operationId": "getHeartbeat",
"responses": {
"200": {
"description": "heartbeat found by slug",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/heartbeat_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a heartbeat",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Heartbeats"
],
"description": "Update a specific heartbeat by id",
"operationId": "updateHeartbeat",
"parameters": [],
"responses": {
"200": {
"description": "heartbeat updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/heartbeat_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"422": {
"description": "invalid enum value",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_heartbeat"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a heartbeat",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Heartbeats"
],
"description": "Delete a specific heartbeat by id",
"operationId": "deleteHeartbeat",
"responses": {
"200": {
"description": "heartbeat deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/heartbeat_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/incidents/{incident_id}/action_items": {
"parameters": [
{
"name": "incident_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates an incident action item",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentActionItems"
],
"description": "Creates a new action item from provided data",
"operationId": "createIncidentActionItem",
"parameters": [],
"responses": {
"201": {
"description": "incident_action_item created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_action_item_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_incident_action_item"
}
}
},
"required": true
}
},
"get": {
"summary": "List incident action items",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentActionItems"
],
"description": "List incident action items",
"operationId": "listIncidentActionItems",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_action_item_list"
}
}
}
}
}
}
},
"/v1/action_items/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves an incident action item",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentActionItems"
],
"description": "Retrieves a specific incident_action_item by id",
"operationId": "getIncidentActionItems",
"responses": {
"200": {
"description": "incident_action_item found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_action_item_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update an incident action item",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentActionItems"
],
"description": "Update a specific incident action item by id",
"operationId": "updateIncidentActionItem",
"parameters": [],
"responses": {
"200": {
"description": "incident_action_item updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_action_item_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_incident_action_item"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete an incident action item",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentActionItems"
],
"description": "Delete a specific incident action item by id",
"operationId": "deleteIncidentActionItem",
"responses": {
"200": {
"description": "incident_action_item deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_action_item_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/action_items": {
"get": {
"summary": "List all action items for an organization",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentActionItems"
],
"description": "List all action items for an organization",
"operationId": "listAllIncidentActionItems",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[kind]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[priority]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[status]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[incident_status]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[incident_created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[incident_created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[incident_created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[incident_created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[due_date][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[due_date][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[due_date][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[due_date][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[kind][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[kind][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[kind][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[kind][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[priority][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[priority][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[priority][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[priority][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[status][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[status][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[status][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[status][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[incident_status][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[incident_status][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[incident_status][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[incident_status][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_action_item_list"
}
}
}
}
}
}
},
"/v1/incidents/{incident_id}/custom_field_selections": {
"parameters": [
{
"name": "incident_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "[DEPRECATED] Creates an incident custom field selection",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"[DEPRECATED] IncidentCustomFieldSelections"
],
"description": "[DEPRECATED] Use form field endpoints instead. Creates a new incident custom field selection from provided data",
"deprecated": true,
"operationId": "createIncidentCustomFieldSelection",
"parameters": [],
"responses": {
"201": {
"description": "incident_custom_field_selection created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_custom_field_selection_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_incident_custom_field_selection"
}
}
},
"required": true
}
},
"get": {
"summary": "[DEPRECATED] List incident custom field selections",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"[DEPRECATED] IncidentCustomFieldSelections"
],
"description": "[DEPRECATED] Use form field endpoints instead. List incident custom field selections",
"deprecated": true,
"operationId": "listIncidentCustomFieldSelections",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_custom_field_selection_list"
}
}
}
}
}
}
},
"/v1/incident_custom_field_selections/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "[DEPRECATED] Retrieves an incident custom field selection",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"[DEPRECATED] IncidentCustomFieldSelections"
],
"description": "[DEPRECATED] Use form field endpoints instead. Retrieves a specific incident custom field selection by id",
"deprecated": true,
"operationId": "getIncidentCustomFieldSelection",
"responses": {
"200": {
"description": "incident_custom_field_selection found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_custom_field_selection_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "[DEPRECATED] Update an incident custom field selection",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"[DEPRECATED] IncidentCustomFieldSelections"
],
"description": "[DEPRECATED] Use form field endpoints instead. Update a specific incident custom field selection by id",
"deprecated": true,
"operationId": "updateIncidentCustomFieldSelection",
"parameters": [],
"responses": {
"200": {
"description": "incident_custom_field_selection updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_custom_field_selection_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_incident_custom_field_selection"
}
}
},
"required": true
}
},
"delete": {
"summary": "[DEPRECATED] Delete an incident custom field selection",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"[DEPRECATED] IncidentCustomFieldSelections"
],
"description": "[DEPRECATED] Use form field endpoints instead. Delete a specific incident custom field selection by id",
"deprecated": true,
"operationId": "deleteIncidentCustomFieldSelection",
"responses": {
"200": {
"description": "incident_custom_field_selection deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_custom_field_selection_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/events/{incident_event_id}/functionalities": {
"parameters": [
{
"name": "incident_event_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates an incident event functionality",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentEventFunctionalities"
],
"description": "Creates a new event functionality from provided data",
"operationId": "createIncidentEventFunctionality",
"parameters": [],
"responses": {
"201": {
"description": "incident_event_functionality created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_event_functionality_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_incident_event_functionality"
}
}
},
"required": true
}
},
"get": {
"summary": "List incident event functionalities",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentEventFunctionalities"
],
"description": "List incident event functionalities",
"operationId": "listIncidentEventFunctionalities",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_event_functionality_list"
}
}
}
}
}
}
},
"/v1/incident_event_functionalities/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves an incident event functionality",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentEventFunctionalities"
],
"description": "Retrieves a specific incident_event_functionality by id",
"operationId": "getIncidentEventFunctionalities",
"responses": {
"200": {
"description": "incident_event_functionality found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_event_functionality_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update an incident event",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentEventFunctionalities"
],
"description": "Update a specific incident event functionality by id",
"operationId": "updateIncidentEventFunctionality",
"parameters": [],
"responses": {
"200": {
"description": "incident_event_functionality updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_event_functionality_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_incident_event_functionality"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete an incident event functionality",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentEventFunctionalities"
],
"description": "Delete a specific incident event functionality by id",
"operationId": "deleteIncidentEventFunctionality",
"responses": {
"200": {
"description": "incident_event deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_event_functionality_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/events/{incident_event_id}/services": {
"parameters": [
{
"name": "incident_event_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates an incident event service",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentEventServices"
],
"description": "Creates a new event service from provided data",
"operationId": "createIncidentEventService",
"parameters": [],
"responses": {
"201": {
"description": "incident_event_service created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_event_service_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_incident_event_service"
}
}
},
"required": true
}
},
"get": {
"summary": "List incident event services",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentEventServices"
],
"description": "List incident event services",
"operationId": "listIncidentEventServices",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_event_service_list"
}
}
}
}
}
}
},
"/v1/incident_event_services/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves an incident event service",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentEventServices"
],
"description": "Retrieves a specific incident_event_service by id",
"operationId": "getIncidentEventServices",
"responses": {
"200": {
"description": "incident_event_service found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_event_service_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update an incident event",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentEventServices"
],
"description": "Update a specific incident event service by id",
"operationId": "updateIncidentEventService",
"parameters": [],
"responses": {
"200": {
"description": "incident_event_service updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_event_service_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_incident_event_service"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete an incident event functionalitu",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentEventServices"
],
"description": "Delete a specific incident event service by id",
"operationId": "deleteIncidentEventService",
"responses": {
"200": {
"description": "incident_event deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_event_service_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/incidents/{incident_id}/events": {
"parameters": [
{
"name": "incident_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates an incident event",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentEvents"
],
"description": "Creates a new event from provided data",
"operationId": "createIncidentEvent",
"parameters": [],
"responses": {
"201": {
"description": "incident_event created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_event_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_incident_event"
}
}
},
"required": true
}
},
"get": {
"summary": "List incident events",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentEvents"
],
"description": "List incident events",
"operationId": "listIncidentEvents",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_event_list"
}
}
}
}
}
}
},
"/v1/events/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves an incident event",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentEvents"
],
"description": "Retrieves a specific incident_event by id",
"operationId": "getIncidentEvents",
"responses": {
"200": {
"description": "incident_event found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_event_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update an incident event",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentEvents"
],
"description": "Update a specific incident event by id",
"operationId": "updateIncidentEvent",
"parameters": [],
"responses": {
"200": {
"description": "incident_event updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_event_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_incident_event"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete an incident event",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentEvents"
],
"description": "Delete a specific incident event by id",
"operationId": "deleteIncidentEvent",
"responses": {
"200": {
"description": "incident_event deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_event_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/incidents/{incident_id}/feedbacks": {
"parameters": [
{
"name": "incident_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates an incident feedback",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentFeedbacks"
],
"description": "Creates a new feedback from provided data",
"operationId": "createIncidentFeedback",
"parameters": [],
"responses": {
"201": {
"description": "incident_feedback created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_feedback_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_incident_feedback"
}
}
},
"required": true
}
},
"get": {
"summary": "List incident feedbacks",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentFeedbacks"
],
"description": "List incident feedbacks",
"operationId": "listIncidentFeedbacks",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_feedback_list"
}
}
}
}
}
}
},
"/v1/feedbacks/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves an incident feedback",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentFeedbacks"
],
"description": "Retrieves a specific incident_feedback by id",
"operationId": "getIncidentFeedbacks",
"responses": {
"200": {
"description": "incident_feedback found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_feedback_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update an incident feedback",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentFeedbacks"
],
"description": "Update a specific incident feedback by id",
"operationId": "updateIncidentFeedback",
"parameters": [],
"responses": {
"200": {
"description": "incident_feedback updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_feedback_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_incident_feedback"
}
}
},
"required": true
}
}
},
"/v1/incidents/{incident_id}/form_field_selections": {
"parameters": [
{
"name": "incident_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates an incident form field selection",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentFormFieldSelections"
],
"description": "Creates a new incident form field selection from provided data",
"operationId": "createIncidentFormFieldSelection",
"parameters": [],
"responses": {
"201": {
"description": "incident_form_field_selection created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_form_field_selection_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_incident_form_field_selection"
}
}
},
"required": true
}
},
"get": {
"summary": "List incident form field selections",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentFormFieldSelections"
],
"description": "List incident form field selections",
"operationId": "listIncidentFormFieldSelections",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_form_field_selection_list"
}
}
}
}
}
}
},
"/v1/incident_form_field_selections/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves an incident form field selection",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentFormFieldSelections"
],
"description": "Retrieves a specific incident form field selection by id",
"operationId": "getIncidentFormFieldSelection",
"responses": {
"200": {
"description": "incident_form_field_selection found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_form_field_selection_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update an incident form field selection",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentFormFieldSelections"
],
"description": "Update a specific incident form field selection by id",
"operationId": "updateIncidentFormFieldSelection",
"parameters": [],
"responses": {
"200": {
"description": "incident_form_field_selection updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_form_field_selection_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_incident_form_field_selection"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete an incident form field selection",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentFormFieldSelections"
],
"description": "Delete a specific incident form field selection by id",
"operationId": "deleteIncidentFormFieldSelection",
"responses": {
"200": {
"description": "incident_form_field_selection deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_form_field_selection_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/incident_permission_sets/{incident_permission_set_id}/booleans": {
"parameters": [
{
"name": "incident_permission_set_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates an incident_permission_set_boolean",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentPermissionSetBooleans"
],
"description": "Creates a new incident_permission_set_boolean from provided data",
"operationId": "createIncidentPermissionSetBoolean",
"parameters": [],
"responses": {
"201": {
"description": "incident_permission_set_boolean created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_permission_set_boolean_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_incident_permission_set_boolean"
}
}
},
"required": true
}
},
"get": {
"summary": "List incident_permission_set_booleans",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentPermissionSetBooleans"
],
"description": "List incident_permission_set_booleans",
"operationId": "listIncidentPermissionSetBooleans",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[kind]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_permission_set_boolean_list"
}
}
}
}
}
}
},
"/v1/incident_permission_set_booleans/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves an incident_permission_set_boolean",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentPermissionSetBooleans"
],
"description": "Retrieves a specific incident_permission_set_boolean by id",
"operationId": "getIncidentPermissionSetBoolean",
"responses": {
"200": {
"description": "incident_permission_set_boolean found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_permission_set_boolean_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update an incident_permission_set_boolean",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentPermissionSetBooleans"
],
"description": "Update a specific incident_permission_set_boolean by id",
"operationId": "updateIncidentPermissionSetBoolean",
"parameters": [],
"responses": {
"200": {
"description": "incident_permission_set_boolean updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_permission_set_boolean_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_incident_permission_set_boolean"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete an incident_permission_set_boolean",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentPermissionSetBooleans"
],
"description": "Delete a specific incident_permission_set_boolean by id",
"operationId": "deleteIncidentPermissionSetBoolean",
"responses": {
"200": {
"description": "incident_permission_set_boolean deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_permission_set_boolean_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/incident_permission_sets/{incident_permission_set_id}/resources": {
"parameters": [
{
"name": "incident_permission_set_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates an incident_permission_set_resource",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentPermissionSetResources"
],
"description": "Creates a new incident_permission_set_resource from provided data",
"operationId": "createIncidentPermissionSetResource",
"parameters": [],
"responses": {
"201": {
"description": "incident_permission_set_resource created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_permission_set_resource_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_incident_permission_set_resource"
}
}
},
"required": true
}
},
"get": {
"summary": "List incident_permission_set_resources",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentPermissionSetResources"
],
"description": "List incident_permission_set_resources",
"operationId": "listIncidentPermissionSetResources",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[kind]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_permission_set_resource_list"
}
}
}
}
}
}
},
"/v1/incident_permission_set_resources/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves an incident_permission_set_resource",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentPermissionSetResources"
],
"description": "Retrieves a specific incident_permission_set_resource by id",
"operationId": "getIncidentPermissionSetResource",
"responses": {
"200": {
"description": "incident_permission_set_resource found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_permission_set_resource_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update an incident_permission_set_resource",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentPermissionSetResources"
],
"description": "Update a specific incident_permission_set_resource by id",
"operationId": "updateIncidentPermissionSetResource",
"parameters": [],
"responses": {
"200": {
"description": "incident_permission_set_resource updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_permission_set_resource_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_incident_permission_set_resource"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete an incident_permission_set_resource",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentPermissionSetResources"
],
"description": "Delete a specific incident_permission_set_resource by id",
"operationId": "deleteIncidentPermissionSetResource",
"responses": {
"200": {
"description": "incident_permission_set_resource deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_permission_set_resource_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/incident_permission_sets": {
"post": {
"summary": "Creates an incident_permission_set",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentPermissionSets"
],
"description": "Creates a new incident_permission_set from provided data",
"operationId": "createIncidentPermissionSet",
"parameters": [],
"responses": {
"201": {
"description": "incident_permission_set created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_permission_set_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_incident_permission_set"
}
}
},
"required": true
}
},
"get": {
"summary": "List incident_permission_sets",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentPermissionSets"
],
"description": "List incident_permission_sets",
"operationId": "listIncidentPermissionSets",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_permission_set_list"
}
}
}
}
}
}
},
"/v1/incident_permission_sets/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "Resource UUID"
},
{
"type": "string",
"pattern": "^[a-z0-9_-]+$",
"description": "Resource slug"
}
]
},
"required": true
}
],
"get": {
"summary": "Retrieves an incident_permission_set",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentPermissionSets"
],
"description": "Retrieves a specific incident_permission_set by id",
"operationId": "getIncidentPermissionSet",
"responses": {
"200": {
"description": "incident_permission_set found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_permission_set_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update an incident_permission_set",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentPermissionSets"
],
"description": "Update a specific incident_permission_set by id",
"operationId": "updateIncidentPermissionSet",
"parameters": [],
"responses": {
"200": {
"description": "incident_permission_set updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_permission_set_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_incident_permission_set"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete an incident_permission_set",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentPermissionSets"
],
"description": "Delete a specific incident_permission_set by id",
"operationId": "deleteIncidentPermissionSet",
"responses": {
"200": {
"description": "incident_permission_set deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_permission_set_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/post_mortems": {
"get": {
"summary": "List incident retrospectives",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentRetrospectives"
],
"description": "List incident retrospectives",
"operationId": "listIncidentPostMortems",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[status]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[severity]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[type]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[user_id]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[types]",
"in": "query",
"required": false,
"description": "Filter by incident type slugs",
"schema": {
"type": "string"
}
},
{
"name": "filter[type_ids]",
"in": "query",
"required": false,
"description": "Filter by incident type IDs (UUIDs)",
"schema": {
"type": "string"
}
},
{
"name": "filter[environments]",
"in": "query",
"required": false,
"description": "Filter by environment slugs",
"schema": {
"type": "string"
}
},
{
"name": "filter[environment_ids]",
"in": "query",
"required": false,
"description": "Filter by environment IDs (UUIDs)",
"schema": {
"type": "string"
}
},
{
"name": "filter[functionalities]",
"in": "query",
"required": false,
"description": "Filter by functionality slugs",
"schema": {
"type": "string"
}
},
{
"name": "filter[functionality_ids]",
"in": "query",
"required": false,
"description": "Filter by functionality IDs (UUIDs)",
"schema": {
"type": "string"
}
},
{
"name": "filter[services]",
"in": "query",
"required": false,
"description": "Filter by service slugs",
"schema": {
"type": "string"
}
},
{
"name": "filter[service_ids]",
"in": "query",
"required": false,
"description": "Filter by service IDs (UUIDs)",
"schema": {
"type": "string"
}
},
{
"name": "filter[teams]",
"in": "query",
"required": false,
"description": "Filter by team/group slugs",
"schema": {
"type": "string"
}
},
{
"name": "filter[team_ids]",
"in": "query",
"required": false,
"description": "Filter by team/group IDs (UUIDs)",
"schema": {
"type": "string"
}
},
{
"name": "filter[causes]",
"in": "query",
"required": false,
"description": "Filter by cause slugs",
"schema": {
"type": "string"
}
},
{
"name": "filter[cause_ids]",
"in": "query",
"required": false,
"description": "Filter by cause IDs (UUIDs)",
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[started_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[started_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[started_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[started_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[mitigated_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[mitigated_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[mitigated_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[mitigated_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[resolved_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[resolved_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[resolved_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[resolved_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_post_mortem_list"
}
}
}
}
}
}
},
"/v1/post_mortems/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "Resource UUID"
},
{
"type": "string",
"pattern": "^[a-z0-9_-]+$",
"description": "Resource slug"
}
]
},
"required": true
}
],
"get": {
"summary": "Retrieves an incident retrospective",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentRetrospectives"
],
"description": "List incidents retrospectives",
"operationId": "ListIncidentPostmortem",
"responses": {
"200": {
"description": "incident_post_mortem found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_post_mortem_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update an incident retrospective",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentRetrospectives"
],
"description": "Update a specific incident retrospective by id",
"operationId": "updateIncidentPostmortem",
"parameters": [],
"responses": {
"200": {
"description": "incident_post_mortem updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_post_mortem_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_incident_post_mortem"
}
}
},
"required": true
}
}
},
"/v1/incident_retrospective_steps/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves an incident retrospective step",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentRetrospectiveSteps"
],
"description": "Retrieves a specific incident retrospective step by id",
"operationId": "getIncidentRetrospectiveStep",
"responses": {
"200": {
"description": "incident retrospective_step found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_retrospective_step_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update an incident retrospective step",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentRetrospectiveSteps"
],
"description": "Update a specific incident retrospective step by id",
"operationId": "updateIncidentRetrospectiveStep",
"parameters": [],
"responses": {
"200": {
"description": "incident_retrospective_step updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_retrospective_step_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_incident_retrospective_step"
}
}
},
"required": true
}
}
},
"/v1/incident_roles/{incident_role_id}/incident_role_tasks": {
"parameters": [
{
"name": "incident_role_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates an incident role task",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentRoleTasks"
],
"description": "Creates a new task from provided data",
"operationId": "createIncidentRoleTask",
"parameters": [],
"responses": {
"201": {
"description": "incident_role_task created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_role_task_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_incident_role_task"
}
}
},
"required": true
}
},
"get": {
"summary": "List incident role tasks",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentRoleTasks"
],
"description": "List incident_role tasks",
"operationId": "listIncidentRoleTasks",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_role_task_list"
}
}
}
}
}
}
},
"/v1/incident_role_tasks/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves an incident role task",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentRoleTasks"
],
"description": "Retrieves a specific incident_role_task by id",
"operationId": "getIncidentRoleTask",
"responses": {
"200": {
"description": "incident_role_task found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_role_task_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update an incident role task",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentRoleTasks"
],
"description": "Update a specific incident_role task by id",
"operationId": "updateIncidentRoleTask",
"parameters": [],
"responses": {
"200": {
"description": "incident_role_task updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_role_task_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_incident_role_task"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete an incident role task",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentRoleTasks"
],
"description": "Delete a specific incident_role task by id",
"operationId": "deleteIncidentRoleTask",
"responses": {
"200": {
"description": "incident_role_task deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_role_task_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/incident_roles": {
"post": {
"summary": "Creates an incident role",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentRoles"
],
"description": "Creates a new incident role from provided data",
"operationId": "createIncidentRole",
"parameters": [],
"responses": {
"201": {
"description": "incident_role created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_role_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_incident_role"
}
}
},
"required": true
}
},
"get": {
"summary": "List incident roles",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentRoles"
],
"description": "List incident roles",
"operationId": "listIncidentRoles",
"parameters": [
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[enabled]",
"in": "query",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[enabled][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[enabled][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[enabled][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[enabled][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_role_list"
}
}
}
}
}
}
},
"/v1/incident_roles/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "Resource UUID"
},
{
"type": "string",
"pattern": "^[a-z0-9_-]+$",
"description": "Resource slug"
}
]
},
"required": true
}
],
"get": {
"summary": "Retrieves an incident role",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentRoles"
],
"description": "Retrieves a specific incident_role by id",
"operationId": "getIncidentRole",
"responses": {
"200": {
"description": "incident_role found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_role_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update an incident role",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentRoles"
],
"description": "Update a specific incident_role by id",
"operationId": "updateIncidentRole",
"parameters": [],
"responses": {
"200": {
"description": "incident_role updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_role_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_incident_role"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete an incident role",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentRoles"
],
"description": "Delete a specific incident_role by id",
"operationId": "deleteIncidentRole",
"responses": {
"200": {
"description": "incident_role deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_role_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/incidents/{incident_id}/status-page-events": {
"parameters": [
{
"name": "incident_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates an incident status page event",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentStatusPageEvents"
],
"description": "Creates a new event from provided data",
"operationId": "createIncidentStatusPage",
"parameters": [],
"responses": {
"201": {
"description": "incident_status_page_event created with started_at",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_status_page_event_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_incident_status_page_event"
}
}
},
"required": true
}
},
"get": {
"summary": "List incident status page events",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentStatusPageEvents"
],
"description": "List incident status page events",
"operationId": "listIncidentStatusPages",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_status_page_event_list"
}
}
}
}
}
}
},
"/v1/status-page-events/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves an incident status page event",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentStatusPageEvents"
],
"description": "Retrieves a specific incident_status_page_event by id",
"operationId": "getIncidentStatusPages",
"responses": {
"200": {
"description": "incident_status_page_event found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_status_page_event_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update an incident status page event",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentStatusPageEvents"
],
"description": "Update a specific incident status page event by id",
"operationId": "updateIncidentStatusPage",
"parameters": [],
"responses": {
"200": {
"description": "incident_status_page_event started_at updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_status_page_event_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_incident_status_page_event"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete an incident status page event",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentStatusPageEvents"
],
"description": "Delete a specific incident status page event by id",
"operationId": "deleteIncidentStatusPage",
"responses": {
"200": {
"description": "incident_status_page_event deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_status_page_event_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/incidents/{incident_id}/sub_statuses": {
"parameters": [
{
"name": "incident_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates a sub-status assignment",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentSubStatuses"
],
"description": "Creates a new sub-status assignment from provided data",
"operationId": "createIncidentSubStatus",
"parameters": [],
"responses": {
"201": {
"description": "incident_sub_status created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_sub_status_response"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_incident_sub_status"
}
}
},
"required": true
}
},
"get": {
"summary": "List incident_sub_statuses",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentSubStatuses"
],
"description": "List incident_sub_statuses",
"operationId": "listIncidentSubStatuses",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: sub_status,assigned_by_user",
"schema": {
"type": "string",
"enum": [
"sub_status",
"assigned_by_user"
]
},
"required": false
},
{
"name": "sort",
"in": "query",
"description": "comma separated if needed. eg: created_at,updated_at",
"schema": {
"type": "string",
"enum": [
"created_at",
"-created_at",
"updated_at",
"-updated_at",
"assigned_at",
"-assigned_at"
]
},
"required": false
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[sub_status_id]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[assigned_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[assigned_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[assigned_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[assigned_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_sub_status_list"
}
}
}
}
}
}
},
"/v1/incident_sub_statuses/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves incident_sub_status",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentSubStatuses"
],
"description": "Retrieves a specific incident_sub_status by id",
"operationId": "getIncidentSubStatus",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: sub_status,assigned_by_user",
"schema": {
"type": "string",
"enum": [
"sub_status",
"assigned_by_user"
]
},
"required": false
}
],
"responses": {
"200": {
"description": "sub_status found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_sub_status_response"
}
}
}
}
}
},
"put": {
"summary": "Update incident_sub_status",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentSubStatuses"
],
"description": "Update a specific incident_sub_status by id",
"operationId": "updateIncidentSubStatus",
"parameters": [],
"responses": {
"200": {
"description": "incident_sub_status updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_sub_status_response"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_incident_sub_status"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete an incident_sub_status",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentSubStatuses"
],
"description": "Delete a specific incident_sub_status by id",
"operationId": "deleteIncidentSubStatus",
"responses": {
"200": {
"description": "incident_sub_status deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_sub_status_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/incident_types": {
"post": {
"summary": "Creates an incident type",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentTypes"
],
"description": "Creates a new incident_type from provided data",
"operationId": "createIncidentType",
"parameters": [],
"responses": {
"201": {
"description": "incident_type created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_type_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_incident_type"
}
}
},
"required": true
}
},
"get": {
"summary": "List incident types",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentTypes"
],
"description": "List incident types",
"operationId": "listIncidentTypes",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[color]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[color][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[color][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[color][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[color][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_type_list"
}
}
}
}
}
}
},
"/v1/incident_types/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "Resource UUID"
},
{
"type": "string",
"pattern": "^[a-z0-9_-]+$",
"description": "Resource slug"
}
]
},
"required": true
}
],
"get": {
"summary": "Retrieves an incident type",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentTypes"
],
"description": "Retrieves a specific incident_type by id",
"operationId": "getIncidentType",
"responses": {
"200": {
"description": "incident_type found by slug",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_type_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update an incident type",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentTypes"
],
"description": "Update a specific incident_type by id",
"operationId": "updateIncidentType",
"parameters": [],
"responses": {
"200": {
"description": "incident_type updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_type_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_incident_type"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete an incident type",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentTypes"
],
"description": "Delete a specific incident_type by id",
"operationId": "deleteIncidentType",
"responses": {
"200": {
"description": "incident_type deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_type_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/incident_types/properties": {
"get": {
"summary": "List Catalog Properties",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentTypes"
],
"description": "List IncidentType Catalog Properties",
"operationId": "listIncidentTypeCatalogProperties",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: catalog",
"schema": {
"type": "string",
"enum": [
"catalog"
]
},
"required": false
},
{
"name": "sort",
"in": "query",
"description": "comma separated if needed. eg: created_at,updated_at",
"schema": {
"type": "string",
"enum": [
"created_at",
"-created_at",
"updated_at",
"-updated_at",
"position",
"-position"
]
},
"required": false
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[kind]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/catalog_property_list"
}
}
}
}
}
},
"post": {
"summary": "Creates a Catalog Property",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IncidentTypes"
],
"description": "Creates a new Catalog Property from provided data",
"operationId": "createIncidentTypeCatalogProperty",
"parameters": [],
"responses": {
"201": {
"description": "catalog_property created ignores wrong catalog_type attribute",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/catalog_property_response"
}
}
}
},
"422": {
"description": "exceeds max fields per catalog",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_catalog_property"
}
}
},
"required": true
}
}
},
"/v1/incidents": {
"post": {
"summary": "Creates an incident",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Incidents"
],
"description": "Creates a new incident from provided data",
"operationId": "createIncident",
"parameters": [],
"responses": {
"201": {
"description": "incident created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_response"
}
}
}
},
"422": {
"description": "invalid causes association",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_incident"
}
}
},
"required": true
}
},
"get": {
"summary": "List incidents",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Incidents"
],
"description": "List incidents",
"operationId": "listIncidents",
"parameters": [
{
"name": "page[after]",
"in": "query",
"required": false,
"description": "The cursor to fetch results using cursor pagination. A cursor is provided in meta.next_cursor in the response.",
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[kind]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[status]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[private]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[user_id]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[severity]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[severity_id]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[labels]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[types]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[type_ids]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[environments]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[environment_ids]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[functionalities]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[functionality_ids]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[functionality_names]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[services]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[service_ids]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[service_names]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[teams]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[team_ids]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[team_names]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[cause]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[cause_ids]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[custom_field_selected_option_ids]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slack_channel_id]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[sequential_id]",
"in": "query",
"required": false,
"description": "Filter by the human-readable incident number (the 123 in INC-123).",
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[updated_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[updated_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[updated_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[updated_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[started_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[started_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[started_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[started_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[detected_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[detected_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[detected_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[detected_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[acknowledged_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[acknowledged_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[acknowledged_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[acknowledged_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[mitigated_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[mitigated_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[mitigated_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[mitigated_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[resolved_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[resolved_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[resolved_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[resolved_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[closed_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[closed_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[closed_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[closed_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[in_triage_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[in_triage_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[in_triage_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[in_triage_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[kind][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[kind][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[kind][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[kind][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[status][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[status][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[status][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[status][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[private][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[private][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[private][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[private][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[user_id][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[user_id][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[user_id][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[user_id][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[severity][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[severity][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[severity][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[severity][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[severity_id][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[severity_id][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[severity_id][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[severity_id][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[labels][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[labels][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[labels][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[labels][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[zendesk_ticket_id][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[zendesk_ticket_id][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[zendesk_ticket_id][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[zendesk_ticket_id][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[sequential_id][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[sequential_id][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[sequential_id][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[sequential_id][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[types][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[types][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[types][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[types][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[type_ids][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[type_ids][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[type_ids][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[type_ids][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[environments][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[environments][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[environments][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[environments][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[environment_ids][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[environment_ids][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[environment_ids][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[environment_ids][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[services][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[services][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[services][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[services][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[service_ids][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[service_ids][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[service_ids][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[service_ids][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[service_names][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[service_names][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[service_names][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[service_names][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[functionalities][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[functionalities][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[functionalities][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[functionalities][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[functionality_ids][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[functionality_ids][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[functionality_ids][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[functionality_ids][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[functionality_names][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[functionality_names][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[functionality_names][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[functionality_names][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[causes][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[causes][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[causes][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[causes][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[cause_ids][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[cause_ids][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[cause_ids][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[cause_ids][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[teams][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[teams][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[teams][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[teams][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[team_ids][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[team_ids][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[team_ids][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[team_ids][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[team_names][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[team_names][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[team_names][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[team_names][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"description": "comma separated if needed. eg: created_at,updated_at",
"schema": {
"type": "string",
"enum": [
"created_at",
"-created_at",
"updated_at",
"-updated_at",
"started_at",
"-started_at",
"in_triage_at",
"-in_triage_at",
"mitigated_at",
"-mitigated_at",
"resolved_at",
"-resolved_at"
]
},
"required": false
},
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: sub_statuses,causes,subscribers",
"schema": {
"type": "string",
"enum": [
"sub_statuses",
"causes",
"subscribers",
"roles",
"slack_messages",
"environments",
"incident_types",
"services",
"functionalities",
"groups",
"events",
"action_items",
"custom_field_selections",
"feedbacks",
"incident_post_mortem",
"alerts"
]
},
"required": false
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_list"
}
}
}
},
"400": {
"description": "offset pagination exceeds limit",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/incidents/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "Resource UUID"
},
{
"type": "string",
"pattern": "^[a-z0-9_-]+$",
"description": "Resource slug"
}
]
},
"required": true
}
],
"get": {
"summary": "Retrieves an incident",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Incidents"
],
"description": "Retrieves a specific incident by id",
"operationId": "getIncident",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: sub_statuses,causes,subscribers",
"schema": {
"type": "string",
"enum": [
"sub_statuses",
"causes",
"subscribers",
"roles",
"slack_messages",
"environments",
"incident_types",
"services",
"functionalities",
"groups",
"events",
"action_items",
"custom_field_selections",
"feedbacks",
"incident_post_mortem",
"alerts"
]
},
"required": false
}
],
"responses": {
"200": {
"description": "incident found by slug",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update an incident",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Incidents"
],
"description": "Update a specific incident by id",
"operationId": "updateIncident",
"parameters": [],
"responses": {
"200": {
"description": "incident updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_incident"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete an incident",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Incidents"
],
"description": "Delete a specific incident by id",
"operationId": "deleteIncident",
"responses": {
"200": {
"description": "incident deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/incidents/{id}/mitigate": {
"parameters": [
{
"name": "id",
"in": "path",
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "Resource UUID"
},
{
"type": "string",
"pattern": "^[a-z0-9_-]+$",
"description": "Resource slug"
}
]
},
"required": true
}
],
"put": {
"summary": "Mitigate an incident",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Incidents"
],
"description": "Mitigate a specific incident by id",
"operationId": "mitigateIncident",
"parameters": [],
"responses": {
"200": {
"description": "incident mitigated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/mitigate_incident"
}
}
},
"required": true
}
}
},
"/v1/incidents/{id}/resolve": {
"parameters": [
{
"name": "id",
"in": "path",
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "Resource UUID"
},
{
"type": "string",
"pattern": "^[a-z0-9_-]+$",
"description": "Resource slug"
}
]
},
"required": true
}
],
"put": {
"summary": "Resolve an incident",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Incidents"
],
"description": "Resolve a specific incident by id",
"operationId": "resolveIncident",
"parameters": [],
"responses": {
"200": {
"description": "incident resolved",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/resolve_incident"
}
}
},
"required": true
}
}
},
"/v1/incidents/{id}/cancel": {
"parameters": [
{
"name": "id",
"in": "path",
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "Resource UUID"
},
{
"type": "string",
"pattern": "^[a-z0-9_-]+$",
"description": "Resource slug"
}
]
},
"required": true
}
],
"put": {
"summary": "Cancel an incident",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Incidents"
],
"description": "Cancel a specific incident by id",
"operationId": "cancelIncident",
"parameters": [],
"responses": {
"200": {
"description": "incident cancel",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/cancel_incident"
}
}
},
"required": true
}
}
},
"/v1/incidents/{id}/in_triage": {
"parameters": [
{
"name": "id",
"in": "path",
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "Resource UUID"
},
{
"type": "string",
"pattern": "^[a-z0-9_-]+$",
"description": "Resource slug"
}
]
},
"required": true
}
],
"put": {
"summary": "Triage an incident",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Incidents"
],
"description": "Set a specific incident by ID to triage state",
"operationId": "triageIncident",
"parameters": [],
"responses": {
"200": {
"description": "incident set to triage",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/in_triage_incident"
}
}
},
"required": true
}
}
},
"/v1/incidents/{id}/restart": {
"parameters": [
{
"name": "id",
"in": "path",
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "Resource UUID"
},
{
"type": "string",
"pattern": "^[a-z0-9_-]+$",
"description": "Resource slug"
}
]
},
"required": true
}
],
"put": {
"summary": "Restart an incident",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Incidents"
],
"description": "Restart a specific incident by id",
"operationId": "restartIncident",
"parameters": [],
"responses": {
"200": {
"description": "incident restarted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/restart_incident"
}
}
},
"required": true
}
}
},
"/v1/incidents/{id}/duplicate": {
"parameters": [
{
"name": "id",
"in": "path",
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "Resource UUID"
},
{
"type": "string",
"pattern": "^[a-z0-9_-]+$",
"description": "Resource slug"
}
]
},
"required": true
}
],
"put": {
"summary": "Mark an incident as a duplicate",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Incidents"
],
"description": "Mark an incident as a duplicate",
"operationId": "markAsDuplicateIncident",
"parameters": [],
"responses": {
"200": {
"description": "incident marked as duplicated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/resolve_incident"
}
}
},
"required": true
}
}
},
"/v1/incidents/{id}/detach_from_parent": {
"parameters": [
{
"name": "id",
"in": "path",
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "Resource UUID"
},
{
"type": "string",
"pattern": "^[a-z0-9_-]+$",
"description": "Resource slug"
}
]
},
"required": true
}
],
"put": {
"summary": "Detach an incident from its parent",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Incidents"
],
"description": "Detach a sub-incident from its parent incident",
"operationId": "detachFromParentIncident",
"responses": {
"200": {
"description": "incident detached from parent",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_response"
}
}
}
},
"422": {
"description": "incident has no parent"
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/incidents/{id}/unmark_as_duplicate": {
"parameters": [
{
"name": "id",
"in": "path",
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "Resource UUID"
},
{
"type": "string",
"pattern": "^[a-z0-9_-]+$",
"description": "Resource slug"
}
]
},
"required": true
}
],
"put": {
"summary": "Remove duplicate marking from an incident",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Incidents"
],
"description": "Remove the duplicate marking from an incident",
"operationId": "unmarkAsDuplicateIncident",
"responses": {
"200": {
"description": "duplicate marking removed",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_response"
}
}
}
},
"422": {
"description": "incident is not marked as duplicate"
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/incidents/{id}/add_subscribers": {
"parameters": [
{
"name": "id",
"in": "path",
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "Resource UUID"
},
{
"type": "string",
"pattern": "^[a-z0-9_-]+$",
"description": "Resource slug"
}
]
},
"required": true
}
],
"post": {
"summary": "Add subscribers to incident",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Incidents"
],
"description": "Add subscribers to incident",
"operationId": "addSubscribersToIncident",
"parameters": [],
"responses": {
"200": {
"description": "add subscribers to incident",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/add_subscribers"
}
}
},
"required": true
}
}
},
"/v1/incidents/{id}/remove_subscribers": {
"parameters": [
{
"name": "id",
"in": "path",
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "Resource UUID"
},
{
"type": "string",
"pattern": "^[a-z0-9_-]+$",
"description": "Resource slug"
}
]
},
"required": true
}
],
"delete": {
"summary": "Remove subscribers from incident",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Incidents"
],
"description": "Remove subscribers to incident",
"operationId": "removeSubscribersToIncident",
"parameters": [],
"responses": {
"200": {
"description": "remove subscribers from incident",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/remove_subscribers"
}
}
},
"required": true
}
}
},
"/v1/incidents/{id}/assign_role_to_user": {
"parameters": [
{
"name": "id",
"in": "path",
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "Resource UUID"
},
{
"type": "string",
"pattern": "^[a-z0-9_-]+$",
"description": "Resource slug"
}
]
},
"required": true
}
],
"post": {
"summary": "Assign user to incident",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Incidents"
],
"description": "Assign user to incident",
"operationId": "assignUserToIncident",
"parameters": [],
"responses": {
"200": {
"description": "assign user to incident",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/assign_role_to_user"
}
}
},
"required": true
}
}
},
"/v1/incidents/{id}/unassign_role_from_user": {
"parameters": [
{
"name": "id",
"in": "path",
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "Resource UUID"
},
{
"type": "string",
"pattern": "^[a-z0-9_-]+$",
"description": "Resource slug"
}
]
},
"required": true
}
],
"delete": {
"summary": "Remove assigned user from incident",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Incidents"
],
"description": "Remove assigned user from incident",
"operationId": "removeAssignedUserFromIncident",
"parameters": [],
"responses": {
"200": {
"description": "remove assigned user from incident",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incident_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/unassign_role_from_user"
}
}
},
"required": true
}
}
},
"/v1/ip_ranges": {
"get": {
"summary": "Retrieves IP ranges",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"IpRanges"
],
"description": "Retrieves the IP ranges for rootly.com services",
"operationId": "getIpRanges",
"responses": {
"200": {
"description": "ip_ranges found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ip_ranges_response"
}
}
}
}
}
}
},
"/v1/live_call_routers": {
"post": {
"summary": "Creates a Live Call Router",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"LiveCallRouters"
],
"description": "Creates a new Live Call Router from provided data",
"operationId": "createLiveCallRouter",
"parameters": [],
"responses": {
"201": {
"description": "live_call_router created with multiple targets without calling_tree_enabled (backward compat)",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/live_call_router_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_live_call_router"
}
}
},
"required": true
}
},
"get": {
"summary": "List Live Call Routers",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"LiveCallRouters"
],
"description": "List Live Call Routers",
"operationId": "listLiveCallRouters",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/live_call_router_list"
}
}
}
}
}
}
},
"/v1/live_call_routers/generate_phone_number": {
"get": {
"summary": "Generates a phone number for Live Call Router",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"LiveCallRouters"
],
"description": "Generates a phone number for Live Call Router",
"operationId": "generatePhoneNumberLiveCallRouter",
"parameters": [
{
"name": "country_code",
"in": "query",
"required": true,
"schema": {
"type": "string",
"enum": [
"AU",
"CA",
"DE",
"NL",
"NZ",
"SE",
"CH",
"GB",
"US"
]
}
},
{
"name": "phone_type",
"in": "query",
"required": true,
"schema": {
"type": "string",
"enum": [
"local",
"toll_free",
"mobile"
]
}
}
],
"responses": {
"200": {
"description": "live_call_router phone number"
},
"422": {
"description": "live_call_router without required params",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/live_call_routers/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a Live Call Router",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"LiveCallRouters"
],
"description": "Retrieves a specific Live Call Router by id",
"operationId": "getLiveCallRouter",
"responses": {
"200": {
"description": "live_call_router found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/live_call_router_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a Live Call Router",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"LiveCallRouters"
],
"description": "Update a specific Live Call Router by id",
"operationId": "updateLiveCallRouter",
"parameters": [],
"responses": {
"200": {
"description": "live_call_router unavailable responder message cleared",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/live_call_router_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_live_call_router"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a Live Call Router",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"LiveCallRouters"
],
"description": "Delete a specific Live Call Router by id",
"operationId": "deleteLiveCallRouter",
"responses": {
"200": {
"description": "live_call_router deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/live_call_router_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/incidents/{incident_id}/meeting_recordings": {
"get": {
"summary": "List meeting recordings",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Meeting Recordings"
],
"description": "List all meeting recording sessions for an incident. Returns recordings sorted by session number. Each recording represents one bot session with its own transcript, status, and metadata.",
"operationId": "listMeetingRecordings",
"parameters": [
{
"name": "incident_id",
"in": "path",
"description": "Incident UUID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"description": "Page number",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"description": "Number of recordings per page",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "meeting recordings listed",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/meeting_recording_list"
}
}
}
},
"404": {
"description": "incident not found"
}
}
},
"post": {
"summary": "Create meeting recording",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Meeting Recordings"
],
"description": "Invite a recording bot to the incident's meeting. If no previous recordings exist for the platform, a new bot is invited (session 1). If previous sessions exist, a new session is created (re-invite). The bot joins the meeting, records audio/video, and generates a transcript when the session ends.",
"operationId": "createMeetingRecording",
"parameters": [
{
"name": "incident_id",
"in": "path",
"description": "Incident UUID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "platform",
"in": "query",
"description": "Meeting platform",
"schema": {
"type": "string",
"enum": [
"zoom",
"google_meet",
"microsoft_teams",
"webex"
]
},
"required": false
}
],
"responses": {
"201": {
"description": "recording session created"
},
"422": {
"description": "validation error (e.g. bot already active)"
}
}
}
},
"/v1/incidents/{incident_id}/meeting_recordings/import": {
"post": {
"summary": "Import a meeting recording",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Meeting Recordings"
],
"description": "Import an externally captured meeting recording and attach it to an incident. Video and transcript are fetched asynchronously. The existing POST /v1/incidents/{incident_id}/meeting_recordings endpoint invites a bot — this endpoint handles recordings that were captured outside of the bot flow.",
"operationId": "importMeetingRecording",
"parameters": [
{
"name": "incident_id",
"in": "path",
"description": "Incident UUID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"201": {
"description": "recording imported"
},
"422": {
"description": "validation error (e.g. unsupported source, duplicate recording)"
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/import_meeting_recording"
}
}
}
}
}
},
"/v1/meeting_recordings": {
"get": {
"summary": "List all meeting recordings",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Meeting Recordings"
],
"description": "List meeting recordings across the organization. Returns the current user's standalone recordings plus incident-backed recordings the user can access. Supports filtering by status, platform, and created_by.",
"operationId": "listAllMeetingRecordings",
"parameters": [
{
"name": "status",
"in": "query",
"required": false,
"description": "Filter by status",
"schema": {
"type": "string"
}
},
{
"name": "platform",
"in": "query",
"required": false,
"description": "Filter by platform",
"schema": {
"type": "string"
}
},
{
"name": "created_by",
"in": "query",
"required": false,
"description": "Filter by creator type",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "meeting recordings found"
}
}
}
},
"/v1/meeting_recordings/start_session": {
"post": {
"summary": "Start a recording session",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Meeting Recordings"
],
"description": "Start a new desktop recording session. The server creates a recording record and returns a stream token the desktop client uses to send audio. No provider-specific configuration is needed from the client.",
"operationId": "startRecordingSession",
"parameters": [],
"responses": {
"201": {
"description": "session created"
},
"422": {
"description": "invalid platform"
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/start_session_request"
}
}
}
}
}
},
"/v1/meeting_recordings/{id}/delete_session": {
"delete": {
"summary": "Delete a standalone meeting recording",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Meeting Recordings"
],
"description": "Delete a standalone meeting recording (not linked to an incident). Only the recording owner can delete it. Active recordings (pending, recording, paused) must be stopped first. Returns 404 for incident-linked recordings or recordings owned by another user.",
"operationId": "deleteStandaloneMeetingRecording",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Meeting Recording UUID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "recording deleted"
},
"422": {
"description": "cannot delete active recording"
},
"404": {
"description": "recording not found or not owned by user"
}
}
}
},
"/v1/meeting_recordings/{id}": {
"get": {
"summary": "Get a meeting recording",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Meeting Recordings"
],
"description": "Retrieve a single meeting recording session including its status, duration, speaker count, word count, and transcript summary.",
"operationId": "getMeetingRecording",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Meeting Recording UUID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "meeting recording found"
},
"404": {
"description": "meeting recording not found"
}
}
},
"delete": {
"summary": "Delete a meeting recording",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Meeting Recordings"
],
"description": "Delete a meeting recording. Only completed or failed recordings can be deleted. Active recordings (pending, recording, paused) must be stopped first.",
"operationId": "deleteMeetingRecording",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Meeting Recording UUID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "meeting recording deleted"
},
"422": {
"description": "cannot delete active recording"
}
}
}
},
"/v1/meeting_recordings/{id}/delete_video": {
"delete": {
"summary": "Delete video from a meeting recording",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Meeting Recordings"
],
"description": "Delete only the video file from a meeting recording. The transcript, summary, and all metadata are preserved. Only non-active recordings with an attached video can have their video deleted.",
"operationId": "deleteMeetingRecordingVideo",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Meeting Recording UUID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "video deleted"
},
"422": {
"description": "cannot delete video (active recording or no video)"
}
}
}
},
"/v1/meeting_recordings/{id}/pause": {
"post": {
"summary": "Pause a meeting recording",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Meeting Recordings"
],
"description": "Pause an active recording session. The bot remains in the meeting but stops capturing audio/video. Use the resume endpoint to continue recording.",
"operationId": "pauseMeetingRecording",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Meeting Recording UUID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "recording paused"
},
"422": {
"description": "recording is not active"
}
}
}
},
"/v1/meeting_recordings/{id}/resume": {
"post": {
"summary": "Resume a meeting recording",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Meeting Recordings"
],
"description": "Resume a paused recording session. The bot continues capturing audio/video from the meeting.",
"operationId": "resumeMeetingRecording",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Meeting Recording UUID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "recording resumed"
},
"422": {
"description": "recording is not paused"
}
}
}
},
"/v1/meeting_recordings/{id}/stop": {
"post": {
"summary": "Stop a meeting recording",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Meeting Recordings"
],
"description": "Stop an active or paused recording. The bot finishes processing, generates a transcript, and the session status transitions to completed. This is irreversible — to record again, create a new session.",
"operationId": "stopMeetingRecording",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Meeting Recording UUID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "recording stopped"
},
"422": {
"description": "recording cannot be stopped"
}
}
}
},
"/v1/meeting_recordings/{id}/leave": {
"post": {
"summary": "Leave a meeting call",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Meeting Recordings"
],
"description": "Remove the recording bot from the meeting entirely. Unlike stop, this immediately disconnects the bot. The session will transition to analyzing and then completed once transcript processing finishes.",
"operationId": "leaveMeetingRecording",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Meeting Recording UUID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "bot left the call"
},
"422": {
"description": "bot is not in a call"
}
}
}
},
"/v1/on_call_pay_reports": {
"post": {
"summary": "Creates an On-Call Pay Report",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"OnCallPayReports"
],
"description": "Generates a new on-call pay report for the given date range. The report is generated asynchronously.",
"operationId": "createOnCallPayReport",
"parameters": [],
"responses": {
"201": {
"description": "on_call_pay_report created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/on_call_pay_report_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_on_call_pay_report"
}
}
},
"required": true
}
},
"get": {
"summary": "List On-Call Pay Reports",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"OnCallPayReports"
],
"description": "List on-call pay reports",
"operationId": "listOnCallPayReports",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[status]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/on_call_pay_report_list"
}
}
}
}
}
}
},
"/v1/on_call_pay_reports/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves an On-Call Pay Report",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"OnCallPayReports"
],
"description": "Retrieves a specific on-call pay report by id",
"operationId": "getOnCallPayReport",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "on_call_pay_report found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/on_call_pay_report_response"
}
}
}
},
"404": {
"description": "resource not found for different team",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update an On-Call Pay Report",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"OnCallPayReports"
],
"description": "Update a specific on-call pay report by id. Triggers report regeneration.",
"operationId": "updateOnCallPayReport",
"parameters": [],
"responses": {
"200": {
"description": "on_call_pay_report updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/on_call_pay_report_response"
}
}
}
},
"404": {
"description": "not allowed when flipper disabled",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_on_call_pay_report"
}
}
},
"required": true
}
}
},
"/v1/on_call_pay_reports/{id}/regenerate": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Regenerate an On-Call Pay Report",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"OnCallPayReports"
],
"description": "Triggers regeneration of an existing on-call pay report.",
"operationId": "regenerateOnCallPayReport",
"responses": {
"200": {
"description": "on_call_pay_report regeneration triggered",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/on_call_pay_report_response"
}
}
}
},
"404": {
"description": "on_call_pay_report not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/on_call_roles": {
"post": {
"summary": "Creates an On-Call Role",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"OnCallRoles"
],
"description": "Creates a new On-Call Role from provided data",
"operationId": "createOnCallRole",
"parameters": [],
"responses": {
"201": {
"description": "on_call_role created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/on_call_role_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_on_call_role"
}
}
},
"required": true
}
},
"get": {
"summary": "List On-Call Roles",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"OnCallRoles"
],
"description": "List On-Call Roles",
"operationId": "listOnCallRoles",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/on_call_role_list"
}
}
}
}
}
}
},
"/v1/on_call_roles/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves an On-Call Role",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"OnCallRoles"
],
"description": "Retrieves a specific On-Call Role by id",
"operationId": "getOnCallRole",
"responses": {
"200": {
"description": "on_call_role found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/on_call_role_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update an On-Call Role",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"OnCallRoles"
],
"description": "Update a specific On-Call Role by id",
"operationId": "updateOnCallRole",
"parameters": [],
"responses": {
"200": {
"description": "on_call_role updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/on_call_role_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_on_call_role"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete an On-Call Role",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"OnCallRoles"
],
"description": "Delete a specific On-Call Role by id",
"operationId": "deleteOnCallRole",
"responses": {
"200": {
"description": "on_call_role deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/on_call_role_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/schedules/{schedule_id}/on_call_shadows": {
"parameters": [
{
"name": "schedule_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "creates an shadow configuration",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"OnCallShadows"
],
"description": "Creates a new on call shadow configuration from provided data",
"operationId": "createOnCallShadow",
"parameters": [],
"responses": {
"201": {
"description": "shadow shift is created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/on_call_shadow_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_on_call_shadow"
}
}
},
"required": true
}
},
"get": {
"summary": "List On Call Shadows for Shift",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"OnCallShadows"
],
"description": "List shadow shifts for schedule",
"operationId": "listOnCallShadows",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/on_call_shadows_list"
}
}
}
}
}
}
},
"/v1/on_call_shadows/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves an On Call Shadow configuration by ID",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"OnCallShadows"
],
"description": "Retrieves a specific On Call Shadow configuration by ID",
"operationId": "getOnCallShadow",
"responses": {
"200": {
"description": "override shift found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/on_call_shadow_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update an On Call Shadow configuration",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"OnCallShadows"
],
"description": "Update a specific on call shadow configuration by id",
"operationId": "updateOnCallShadow",
"parameters": [],
"responses": {
"200": {
"description": "on call shadows configuration is is updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/on_call_shadow_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_on_call_shadow"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete an on call shadow configuration",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"OverrideShifts"
],
"description": "Delete a specific on call shadow configuration by id. Future shadows are hard-deleted. Active shadows (started in the past) have their end time truncated to preserve historical data.",
"operationId": "deleteOnCallShadow",
"responses": {
"200": {
"description": "active shadow is preserved with truncated end time",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/on_call_shadow_response"
}
}
}
},
"422": {
"description": "shadow period already ended",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/oncalls": {
"get": {
"summary": "List on-calls",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"OnCalls"
],
"description": "List who is currently on-call, with support for filtering by escalation policy, schedule, and user. Returns on-call entries grouped by escalation policy level.",
"operationId": "listOncalls",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: user,schedule",
"schema": {
"type": "string",
"enum": [
"user",
"schedule",
"escalation_policy"
]
},
"required": false
},
{
"name": "since",
"in": "query",
"description": "Start of time range in ISO-8601 format (e.g., 2025-01-01T00:00:00Z). Defaults to current time.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "until",
"in": "query",
"description": "End of time range in ISO-8601 format (e.g., 2025-01-01T00:00:00Z). Defaults to 'since' time.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "earliest",
"in": "query",
"description": "When true, returns only the first on-call entry per escalation policy path and level",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"name": "time_zone",
"in": "query",
"description": "Timezone for response times (e.g., America/New_York). Defaults to UTC.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[escalation_policy_ids]",
"in": "query",
"schema": {
"type": "string"
},
"description": "Comma-separated escalation policy IDs",
"required": false
},
{
"name": "filter[schedule_ids]",
"in": "query",
"schema": {
"type": "string"
},
"description": "Comma-separated schedule IDs",
"required": false
},
{
"name": "filter[user_ids]",
"in": "query",
"schema": {
"type": "string"
},
"description": "Comma-separated user IDs",
"required": false
},
{
"name": "filter[service_ids]",
"in": "query",
"schema": {
"type": "string"
},
"description": "Comma-separated service IDs",
"required": false
},
{
"name": "filter[group_ids]",
"in": "query",
"schema": {
"type": "string"
},
"description": "Comma-separated group IDs (teams)",
"required": false
},
{
"name": "filter[notification_types]",
"in": "query",
"schema": {
"type": "string"
},
"description": "Comma-separated notification types to include. One or both of: audible, quiet. When omitted, returns oncalls from all non-deferral escalation paths. When provided, limits results to matching notification types and sorts audible-first.",
"required": false
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/oncall_list"
}
}
}
},
"404": {
"description": "resource not found when alerting is disabled",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/schedules/{schedule_id}/override_shifts": {
"parameters": [
{
"name": "schedule_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "creates an override shift",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"OverrideShifts"
],
"description": "Creates a new override shift from provided data. If any existing override shifts overlap with the specified time range, they will be automatically deleted and replaced by the new override. This endpoint is idempotent: re-sending an identical override (same user and same start/end time) returns the existing override with a 200 status and does not recreate it.",
"operationId": "createOverrideShift",
"parameters": [],
"responses": {
"201": {
"description": "returns assignee relationship when schedule nesting enabled",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/override_shift_response"
}
}
}
},
"422": {
"description": "cannot create schedule-based override shift",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"200": {
"description": "returns the existing override without recreating it",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/override_shift_response"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_override_shift"
}
}
},
"required": true
}
},
"get": {
"summary": "List override shifts",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"OverrideShifts"
],
"description": "List override shifts",
"operationId": "listOverrideShifts",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/override_shift_list"
}
}
}
}
}
}
},
"/v1/override_shifts/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves an override shift",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"OverrideShifts"
],
"description": "Retrieves a specific override shift by id",
"operationId": "getOverrideShift",
"responses": {
"200": {
"description": "override shift found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/override_shift_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update an override shift",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"OverrideShifts"
],
"description": "Update a specific override shift by id",
"operationId": "updateOverrideShift",
"parameters": [],
"responses": {
"200": {
"description": "override shift updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/override_shift_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_override_shift"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete an override shift",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"OverrideShifts"
],
"description": "Delete a specific override shift by id",
"operationId": "deleteOverrideShift",
"responses": {
"200": {
"description": "override shift deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/override_shift_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/playbooks/{playbook_id}/playbook_tasks": {
"parameters": [
{
"name": "playbook_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates a playbook task",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"PlaybookTasks"
],
"description": "Creates a new task from provided data",
"operationId": "createPlaybookTask",
"parameters": [],
"responses": {
"201": {
"description": "playbook_task created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/playbook_task_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_playbook_task"
}
}
},
"required": true
}
},
"get": {
"summary": "List playbook tasks",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"PlaybookTasks"
],
"description": "List playbook tasks",
"operationId": "listPlaybookTasks",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/playbook_task_list"
}
}
}
}
}
}
},
"/v1/playbook_tasks/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a playbook task",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"PlaybookTasks"
],
"description": "Retrieves a specific playbook_task by id",
"operationId": "getPlaybookTask",
"responses": {
"200": {
"description": "playbook_task found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/playbook_task_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a playbook task",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"PlaybookTasks"
],
"description": "Update a specific playbook task by id",
"operationId": "updatePlaybookTask",
"parameters": [],
"responses": {
"200": {
"description": "playbook_task updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/playbook_task_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_playbook_task"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a playbook task",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"PlaybookTasks"
],
"description": "Delete a specific playbook task by id",
"operationId": "deletePlaybookTask",
"responses": {
"200": {
"description": "playbook_task deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/playbook_task_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/playbooks": {
"post": {
"summary": "Creates a playbook",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Playbooks"
],
"description": "Creates a new playbook from provided data",
"operationId": "createPlaybook",
"parameters": [],
"responses": {
"201": {
"description": "playbook created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/playbook_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_playbook"
}
}
},
"required": true
}
},
"get": {
"summary": "List playbooks",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Playbooks"
],
"description": "List playbooks",
"operationId": "listPlaybooks",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: severities,environments,services",
"schema": {
"type": "string",
"enum": [
"severities",
"environments",
"services",
"functionalities",
"groups",
"causes",
"incident_types"
]
},
"required": false
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/playbook_list"
}
}
}
}
}
}
},
"/v1/playbooks/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a playbook",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Playbooks"
],
"description": "Retrieves a specific playbook by id",
"operationId": "getPlaybook",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: severities,environments,services",
"schema": {
"type": "string",
"enum": [
"severities",
"environments",
"services",
"functionalities",
"groups",
"causes",
"incident_types"
]
},
"required": false
}
],
"responses": {
"200": {
"description": "playbook found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/playbook_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a playbook",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Playbooks"
],
"description": "Update a specific playbook by id",
"operationId": "updatePlaybook",
"parameters": [],
"responses": {
"200": {
"description": "playbook updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/playbook_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_playbook"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a playbook",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Playbooks"
],
"description": "Delete a specific playbook by id",
"operationId": "deletePlaybook",
"responses": {
"200": {
"description": "playbook deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/playbook_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/post_mortem_templates": {
"post": {
"summary": "Creates a retrospective template",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"RetrospectiveTemplates"
],
"description": "Creates a new Retrospective Template from provided data",
"operationId": "createPostmortemTemplate",
"parameters": [],
"responses": {
"201": {
"description": "post_mortem_template created with TipTap blocks",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/post_mortem_template_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_post_mortem_template"
}
}
},
"required": true
}
},
"get": {
"summary": "List Retrospective Templates",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"RetrospectiveTemplates"
],
"description": "List Retrospective Templates",
"operationId": "listPostmortemTemplates",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/post_mortem_template_list"
}
}
}
}
}
}
},
"/v1/post_mortem_templates/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "Resource UUID"
},
{
"type": "string",
"pattern": "^[a-z0-9_-]+$",
"description": "Resource slug"
}
]
},
"required": true
}
],
"get": {
"summary": "Retrieves a Retrospective Template",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"RetrospectiveTemplates"
],
"description": "Retrieves a specific Retrospective Template by id",
"operationId": "getPostmortemTemplate",
"responses": {
"200": {
"description": "Retrospective Template found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/post_mortem_template_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a Retrospective Template",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"RetrospectiveTemplates"
],
"description": "Update a specific Retrospective Template by id",
"operationId": "updatePostmortemTemplate",
"parameters": [],
"responses": {
"200": {
"description": "Retrospective Template updated with sanitized content",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/post_mortem_template_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_post_mortem_template"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a Retrospective Template",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"RetrospectiveTemplates"
],
"description": "Delete a specific Retrospective Template by id",
"operationId": "deletePostmortemTemplate",
"responses": {
"200": {
"description": "Retrospective Template deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/post_mortem_template_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/pulses": {
"post": {
"summary": "Creates a pulse",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Pulses"
],
"description": "Creates a new pulse from provided data",
"operationId": "createPulse",
"parameters": [],
"responses": {
"201": {
"description": "pulse created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/pulse_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_pulse"
}
}
},
"required": true
}
},
"get": {
"summary": "List pulses",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Pulses"
],
"description": "List pulses",
"operationId": "listPulses",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[source]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[services]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[environments]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[labels]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[refs]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[started_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[started_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[started_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[started_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[ended_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[ended_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[ended_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[ended_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[source][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[source][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[source][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[source][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[services][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[services][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[services][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[services][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[environments][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[environments][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[environments][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[environments][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[labels][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[labels][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[labels][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[labels][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[refs][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[refs][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[refs][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[refs][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/pulse_list"
}
}
}
}
}
}
},
"/v1/pulses/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a pulse",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Pulses"
],
"description": "Retrieves a specific pulse by id",
"operationId": "getPulse",
"responses": {
"200": {
"description": "pulse found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/pulse_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a pulse",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Pulses"
],
"description": "Update a specific pulse by id",
"operationId": "updatePulse",
"parameters": [],
"responses": {
"200": {
"description": "pulse updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/pulse_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_pulse"
}
}
},
"required": true
}
}
},
"/v1/alerts/receipts/{id}": {
"get": {
"summary": "Get a receipt",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Alerts"
],
"description": "Retrieve the delivery receipt for a notification by ID, including its state and (when applicable) failure reason and referenced resource.",
"operationId": "getReceipt",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Receipt ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "receipt found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/receipt"
}
}
}
},
"404": {
"description": "receipt not found"
}
}
}
},
"/v1/retrospective_configurations": {
"get": {
"summary": "List retrospective configurations",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"RetrospectiveConfigurations"
],
"description": "List retrospective configurations",
"operationId": "listRetrospectiveConfigurations",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: severities,groups",
"schema": {
"type": "string",
"enum": [
"severities",
"groups",
"incident_types"
]
},
"required": false
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[kind]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/retrospective_configuration_list"
}
}
}
}
}
}
},
"/v1/retrospective_configurations/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a Retrospective Configuration",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"RetrospectiveConfigurations"
],
"description": "Retrieves a specific retrospective_configuration by id",
"operationId": "getRetrospectiveConfiguration",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: severities,groups",
"schema": {
"type": "string",
"enum": [
"severities",
"groups",
"incident_types"
]
},
"required": false
}
],
"responses": {
"200": {
"description": "retrospective_configuration found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/retrospective_configuration_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a retrospective configuration",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"RetrospectiveConfigurations"
],
"description": "Update a specific retrospective configuration by id",
"operationId": "updateRetrospectiveConfiguration",
"parameters": [],
"responses": {
"200": {
"description": "retrospective configuration updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/retrospective_configuration_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_retrospective_configuration"
}
}
},
"required": true
}
}
},
"/v1/retrospective_process_groups/{retrospective_process_group_id}/steps": {
"parameters": [
{
"name": "retrospective_process_group_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates a retrospective process group step",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"RetrospectiveProcessGroupSteps"
],
"description": "Creates a new retrospective process group step from provided data",
"operationId": "createRetrospectiveProcessGroupStep",
"parameters": [],
"responses": {
"201": {
"description": "retrospective_process_group_step created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/retrospective_process_group_step_response"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_retrospective_process_group_step"
}
}
},
"required": true
}
},
"get": {
"summary": "List RetrospectiveProcessGroup Steps",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"RetrospectiveProcessGroupSteps"
],
"description": "List RetrospectiveProcessGroup Steps",
"operationId": "listRetrospectiveProcessGroupSteps",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[retrospective_step_id]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/retrospective_process_group_step_list"
}
}
}
}
}
}
},
"/v1/retrospective_process_group_steps/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a RetrospectiveProcessGroup Step",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"RetrospectiveProcessGroupSteps"
],
"description": "Retrieves a specific RetrospectiveProcessGroup Step by id",
"operationId": "getRetrospectiveProcessGroupStep",
"responses": {
"200": {
"description": "sub_status found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/retrospective_process_group_step_response"
}
}
}
}
}
},
"put": {
"summary": "Update RetrospectiveProcessGroup Step",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"RetrospectiveProcessGroupSteps"
],
"description": "Update a specific RetrospectiveProcessGroup Step by id",
"operationId": "updateRetrospectiveProcessGroupStep",
"parameters": [],
"responses": {
"200": {
"description": "retrospective_process_group_step updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/retrospective_process_group_step_response"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_retrospective_process_group_step"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a RetrospectiveProcessGroup Step",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"RetrospectiveProcessGroupSteps"
],
"description": "Delete a specific RetrospectiveProcessGroup Step by id",
"operationId": "deleteRetrospectiveProcessGroupStep",
"responses": {
"200": {
"description": "retrospective_process_group_step deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/retrospective_process_group_step_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/retrospective_processes/{retrospective_process_id}/groups": {
"parameters": [
{
"name": "retrospective_process_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates a retrospective process group",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"RetrospectiveProcessGroups"
],
"description": "Creates a new retrospective process group from provided data",
"operationId": "createRetrospectiveProcessGroup",
"parameters": [],
"responses": {
"201": {
"description": "retrospective_process_group created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/retrospective_process_group_response"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_retrospective_process_group"
}
}
},
"required": true
}
},
"get": {
"summary": "List Retrospective Process Groups",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"RetrospectiveProcessGroups"
],
"description": "List Retrospective Process Groups",
"operationId": "listRetrospectiveProcessGroups",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: retrospective_process_group_steps",
"schema": {
"type": "string",
"enum": [
"retrospective_process_group_steps"
]
},
"required": false
},
{
"name": "sort",
"in": "query",
"description": "comma separated if needed. eg: created_at,updated_at",
"schema": {
"type": "string",
"enum": [
"created_at",
"-created_at",
"updated_at",
"-updated_at",
"position",
"-position"
]
},
"required": false
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[sub_status_id]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/retrospective_process_group_list"
}
}
}
}
}
}
},
"/v1/retrospective_process_groups/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a Retrospective Process Group",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"RetrospectiveProcessGroups"
],
"description": "Retrieves a specific Retrospective Process Group by id",
"operationId": "getRetrospectiveProcessGroup",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: retrospective_process_group_steps",
"schema": {
"type": "string",
"enum": [
"retrospective_process_group_steps"
]
},
"required": false
}
],
"responses": {
"200": {
"description": "sub_status found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/retrospective_process_group_response"
}
}
}
}
}
},
"put": {
"summary": "Update a Retrospective Process Group",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"RetrospectiveProcessGroups"
],
"description": "Update a specific Retrospective Process Group by id",
"operationId": "updateRetrospectiveProcessGroup",
"parameters": [],
"responses": {
"200": {
"description": "retrospective_process_group updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/retrospective_process_group_response"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_retrospective_process_group"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a Retrospective Process Group",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"RetrospectiveProcessGroups"
],
"description": "Delete a specific Retrospective Process Group by id",
"operationId": "deleteRetrospectiveProcessGroup",
"responses": {
"200": {
"description": "retrospective_process_group deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/retrospective_process_group_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/retrospective_processes": {
"post": {
"summary": "Creates a retrospective process",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"RetrospectiveProcesses"
],
"description": "Creates a new retrospective process from provided data",
"operationId": "createRetrospectiveProcess",
"parameters": [],
"responses": {
"201": {
"description": "retrospective_process created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/retrospective_process_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_retrospective_process"
}
}
},
"required": true
}
},
"get": {
"summary": "List retrospective processes",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"RetrospectiveProcesses"
],
"description": "List retrospective processes",
"operationId": "listRetrospectiveProcesses",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: retrospective_steps,severities",
"schema": {
"type": "string",
"enum": [
"retrospective_steps",
"severities",
"incident_types",
"groups"
]
},
"required": false
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/retrospective_process_list"
}
}
}
}
}
}
},
"/v1/retrospective_processes/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a retrospective process",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"RetrospectiveProcesses"
],
"description": "Retrieves a specific retrospective process by id",
"operationId": "getRetrospectiveProcess",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: retrospective_steps,severities",
"schema": {
"type": "string",
"enum": [
"retrospective_steps",
"severities",
"incident_types",
"groups"
]
},
"required": false
}
],
"responses": {
"200": {
"description": "retrospective_process found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/retrospective_process_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a retrospective process",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"RetrospectiveProcesses"
],
"description": "Updates a specific retrospective process by id",
"operationId": "updateRetrospectiveProcess",
"parameters": [],
"responses": {
"200": {
"description": "retrospective_process updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/retrospective_process_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_retrospective_process"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a retrospective process",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"RetrospectiveProcesses"
],
"description": "Delete a specific retrospective process by id",
"operationId": "deleteRetrospectiveProcess",
"responses": {
"200": {
"description": "retrospective_process deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/retrospective_process_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/retrospective_processes/{retrospective_process_id}/retrospective_steps": {
"parameters": [
{
"name": "retrospective_process_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates a retrospective step",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"RetrospectiveSteps"
],
"description": "Creates a new retrospective step from provided data",
"operationId": "createRetrospectiveStep",
"parameters": [],
"responses": {
"201": {
"description": "retrospective_step created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/retrospective_step_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_retrospective_step"
}
}
},
"required": true
}
},
"get": {
"summary": "List retrospective steps",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"RetrospectiveSteps"
],
"description": "List retrospective steps",
"operationId": "listRetrospectiveSteps",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/retrospective_step_list"
}
}
}
}
}
}
},
"/v1/retrospective_steps/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a retrospective step",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"RetrospectiveSteps"
],
"description": "Retrieves a specific retrospective step by id",
"operationId": "getRetrospectiveStep",
"responses": {
"200": {
"description": "retrospective_step found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/retrospective_step_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a retrospective step",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"RetrospectiveSteps"
],
"description": "Update a specific retrospective step by id",
"operationId": "updateRetrospectiveStep",
"parameters": [],
"responses": {
"200": {
"description": "retrospective_step updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/retrospective_step_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_retrospective_step"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a retrospective step",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"RetrospectiveSteps"
],
"description": "Delete a specific retrospective step by id",
"operationId": "deleteRetrospectiveStep",
"responses": {
"200": {
"description": "retrospective_step deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/retrospective_step_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/roles": {
"post": {
"summary": "Creates a role",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Roles"
],
"description": "Creates a new role from provided data",
"operationId": "createRole",
"parameters": [],
"responses": {
"201": {
"description": "role created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/role_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_role"
}
}
},
"required": true
}
},
"get": {
"summary": "List roles",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Roles"
],
"description": "List roles",
"operationId": "listRoles",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/role_list"
}
}
}
}
}
}
},
"/v1/roles/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "Resource UUID"
},
{
"type": "string",
"pattern": "^[a-z0-9_-]+$",
"description": "Resource slug"
}
]
},
"required": true
}
],
"get": {
"summary": "Retrieves a role",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Roles"
],
"description": "Retrieves a specific role by id",
"operationId": "getRole",
"responses": {
"200": {
"description": "role found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/role_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a role",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Roles"
],
"description": "Update a specific role by id",
"operationId": "updateRole",
"parameters": [],
"responses": {
"200": {
"description": "role updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/role_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_role"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a role",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Roles"
],
"description": "Delete a specific role by id",
"operationId": "deleteRole",
"responses": {
"200": {
"description": "role deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/role_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/schedule_rotations/{schedule_rotation_id}/schedule_rotation_active_days": {
"parameters": [
{
"name": "schedule_rotation_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates a schedule rotation active day",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"ScheduleRotationActiveDays"
],
"description": "Creates a new schedule rotation active day from provided data",
"operationId": "createScheduleRotationActiveDay",
"parameters": [],
"responses": {
"201": {
"description": "schedule_rotation_active_day created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/schedule_rotation_active_day_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_schedule_rotation_active_day"
}
}
},
"required": true
}
},
"get": {
"summary": "List schedule rotation active days",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"ScheduleRotationActiveDays"
],
"description": "List schedule rotation active days",
"operationId": "listScheduleRotationActiveDays",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/schedule_rotation_active_day_list"
}
}
}
}
}
}
},
"/v1/schedule_rotation_active_days/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a schedule rotation active day",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"ScheduleRotationActiveDays"
],
"description": "Retrieves a specific schedule rotation active day by id",
"operationId": "getScheduleRotationActiveDay",
"responses": {
"200": {
"description": "schedule_rotation_active_day found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/schedule_rotation_active_day_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a schedule rotation active day",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"ScheduleRotationActiveDays"
],
"description": "Update a specific schedule rotation active day by id",
"operationId": "updateScheduleRotationActiveDay",
"parameters": [],
"responses": {
"200": {
"description": "schedule_rotation_active_day updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/schedule_rotation_active_day_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_schedule_rotation_active_day"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a schedule rotation active day",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"ScheduleRotationActiveDays"
],
"description": "Delete a specific schedule rotation active day",
"operationId": "deleteScheduleRotationActiveDay",
"responses": {
"200": {
"description": "schedule_rotation_active_day deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/schedule_rotation_active_day_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/schedule_rotations/{schedule_rotation_id}/schedule_rotation_users": {
"parameters": [
{
"name": "schedule_rotation_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates a schedule rotation user",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"ScheduleRotationUsers"
],
"description": "Creates a new schedule rotation user from provided data",
"operationId": "createScheduleRotationUser",
"parameters": [],
"responses": {
"201": {
"description": "schedule_rotation_user created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/schedule_rotation_user_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_schedule_rotation_user"
}
}
},
"required": true
}
},
"get": {
"summary": "List schedule rotation users",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"ScheduleRotationUsers"
],
"operationId": "listScheduleRotationUsers",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/schedule_rotation_user_list"
}
}
}
}
}
}
},
"/v1/schedule_rotation_users/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a schedule rotation user",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"ScheduleRotationUsers"
],
"description": "Retrieves a specific schedule rotation user by id",
"operationId": "getScheduleRotationUser",
"responses": {
"200": {
"description": "schedule_rotation_user found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/schedule_rotation_user_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update schedule rotation user",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"ScheduleRotationUsers"
],
"description": "Update a specific schedule rotation user by id",
"operationId": "updateScheduleRotationUser",
"parameters": [],
"responses": {
"200": {
"description": "schedule_rotation_user updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/schedule_rotation_user_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_schedule_rotation_user"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a schedule rotation user",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"ScheduleRotationUsers"
],
"description": "Delete a specific schedule rotation user by id",
"operationId": "deleteScheduleRotationUser",
"responses": {
"200": {
"description": "schedule_rotation_user deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/schedule_rotation_user_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/schedules/{schedule_id}/schedule_rotations": {
"parameters": [
{
"name": "schedule_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates a schedule rotation",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"ScheduleRotations"
],
"description": "Creates a new schedule rotation from provided data",
"operationId": "createScheduleRotation",
"parameters": [],
"responses": {
"201": {
"description": "schedule_rotation created with custom active times",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/schedule_rotation_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_schedule_rotation"
}
}
},
"required": true
}
},
"get": {
"summary": "List schedule rotations",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"ScheduleRotations"
],
"description": "List schedule rotations",
"operationId": "listScheduleRotations",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/schedule_rotation_list"
}
}
}
}
}
}
},
"/v1/schedule_rotations/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a schedule rotation",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"ScheduleRotations"
],
"description": "Retrieves a specific schedule rotation by id",
"operationId": "getScheduleRotation",
"responses": {
"200": {
"description": "schedule_rotation found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/schedule_rotation_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a schedule rotation",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"ScheduleRotations"
],
"description": "Update a specific schedule rotation by id",
"operationId": "updateScheduleRotation",
"parameters": [],
"responses": {
"200": {
"description": "schedule_rotation updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/schedule_rotation_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_schedule_rotation"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a schedule rotation",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"ScheduleRotations"
],
"description": "Delete a specific schedule rotation by id",
"operationId": "deleteScheduleRotation",
"responses": {
"200": {
"description": "schedule_rotation deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/schedule_rotation_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/schedules": {
"post": {
"summary": "Creates a schedule",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Schedules"
],
"description": "Creates a new schedule from provided data",
"operationId": "createSchedule",
"parameters": [],
"responses": {
"201": {
"description": "schedule created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/schedule_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_schedule"
}
}
},
"required": true
}
},
"get": {
"summary": "List schedules",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Schedules"
],
"description": "List schedules",
"operationId": "listSchedules",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/schedule_list"
}
}
}
}
}
}
},
"/v1/schedules/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a schedule",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Schedules"
],
"description": "Retrieves a specific schedule by id",
"operationId": "getSchedule",
"responses": {
"200": {
"description": "schedule found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/schedule_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a schedule",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Schedules"
],
"description": "Updates a specific schedule by id",
"operationId": "updateSchedule",
"parameters": [],
"responses": {
"200": {
"description": "schedule updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/schedule_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_schedule"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a schedule",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Schedules"
],
"description": "Delete a specific schedule by id",
"operationId": "deleteSchedule",
"responses": {
"200": {
"description": "schedule deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/schedule_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/schedules/{id}/shifts": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a schedule shifts",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Shifts"
],
"description": "Retrieves schedule shifts",
"operationId": "getScheduleShifts",
"parameters": [
{
"name": "to",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "from",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "schedule shifts found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/shift_list"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/secrets": {
"post": {
"summary": "Creates a secret",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Secrets"
],
"description": "Creates a new secret from provided data",
"operationId": "createSecret",
"parameters": [],
"responses": {
"201": {
"description": "secret created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/secret_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_secret"
}
}
},
"required": true
}
},
"get": {
"summary": "List secrets",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Secrets"
],
"description": "List secrets",
"operationId": "listSecrets",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/secret_list"
}
}
}
}
}
}
},
"/v1/secrets/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a secret",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Secrets"
],
"description": "Retrieve a specific secret by id",
"operationId": "getSecret",
"responses": {
"200": {
"description": "secret found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/secret_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a secret",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Secrets"
],
"description": "Update a specific secret by id",
"operationId": "updateSecret",
"parameters": [],
"responses": {
"200": {
"description": "secret updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/secret_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_secret"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a secret",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Secrets"
],
"description": "Delete a specific secret by id",
"operationId": "deleteSecret",
"responses": {
"200": {
"description": "secret deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/secret_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/services": {
"post": {
"summary": "Creates a service",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Services"
],
"description": "Creates a new service from provided data",
"operationId": "createService",
"parameters": [],
"responses": {
"201": {
"description": "service created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/service_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_service"
}
}
},
"required": true
}
},
"get": {
"summary": "List services",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Services"
],
"description": "List services",
"operationId": "listServices",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[backstage_id]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[cortex_id]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[opslevel_id]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[external_id]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[alert_broadcast_enabled]",
"in": "query",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"name": "filter[incident_broadcast_enabled]",
"in": "query",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[alert_broadcast_enabled][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[alert_broadcast_enabled][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[alert_broadcast_enabled][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[alert_broadcast_enabled][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[incident_broadcast_enabled][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[incident_broadcast_enabled][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[incident_broadcast_enabled][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[incident_broadcast_enabled][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/service_list"
}
}
}
}
}
}
},
"/v1/services/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "Resource UUID"
},
{
"type": "string",
"pattern": "^[a-z0-9_-]+$",
"description": "Resource slug"
}
]
},
"required": true
}
],
"get": {
"summary": "Retrieves a service",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Services"
],
"description": "Retrieves a specific service by id",
"operationId": "getService",
"responses": {
"200": {
"description": "service found by slug",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/service_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a service",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Services"
],
"description": "Update a specific service by id",
"operationId": "updateService",
"parameters": [],
"responses": {
"200": {
"description": "service updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/service_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_service"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a service",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Services"
],
"description": "Delete a specific service by id",
"operationId": "deleteService",
"responses": {
"200": {
"description": "service deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/service_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/services/{id}/incidents_chart": {
"parameters": [
{
"name": "id",
"in": "path",
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "Resource UUID"
},
{
"type": "string",
"pattern": "^[a-z0-9_-]+$",
"description": "Resource slug"
}
]
},
"required": true
}
],
"get": {
"summary": "Get service incidents chart",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Services"
],
"description": "Get service incidents chart",
"operationId": "getServiceIncidentsChart",
"parameters": [
{
"name": "period",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incidents_chart_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/services/{id}/uptime_chart": {
"parameters": [
{
"name": "id",
"in": "path",
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "Resource UUID"
},
{
"type": "string",
"pattern": "^[a-z0-9_-]+$",
"description": "Resource slug"
}
]
},
"required": true
}
],
"get": {
"summary": "Get service uptime chart",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Services"
],
"description": "Get service uptime chart",
"operationId": "getServiceUptimeChart",
"parameters": [
{
"name": "period",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/uptime_chart_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/services/properties": {
"get": {
"summary": "List Catalog Properties",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Services"
],
"description": "List Service Catalog Properties",
"operationId": "listServiceCatalogProperties",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: catalog",
"schema": {
"type": "string",
"enum": [
"catalog"
]
},
"required": false
},
{
"name": "sort",
"in": "query",
"description": "comma separated if needed. eg: created_at,updated_at",
"schema": {
"type": "string",
"enum": [
"created_at",
"-created_at",
"updated_at",
"-updated_at",
"position",
"-position"
]
},
"required": false
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[kind]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/catalog_property_list"
}
}
}
}
}
},
"post": {
"summary": "Creates a Catalog Property",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Services"
],
"description": "Creates a new Catalog Property from provided data",
"operationId": "createServiceCatalogProperty",
"parameters": [],
"responses": {
"201": {
"description": "catalog_property created ignores wrong catalog_type attribute",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/catalog_property_response"
}
}
}
},
"422": {
"description": "exceeds max fields per catalog",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_catalog_property"
}
}
},
"required": true
}
}
},
"/v1/severities": {
"post": {
"summary": "Creates a severity",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Severities"
],
"description": "Creates a new severity from provided data",
"operationId": "createSeverity",
"parameters": [],
"responses": {
"201": {
"description": "severity created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/severity_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_severity"
}
}
},
"required": true
}
},
"get": {
"summary": "List severities",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Severities"
],
"description": "List severities",
"operationId": "listSeverities",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[severity]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[color]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[severity][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[severity][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[severity][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[severity][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[color][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[color][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[color][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[color][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/severity_list"
}
}
}
}
}
}
},
"/v1/severities/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "Resource UUID"
},
{
"type": "string",
"pattern": "^[a-z0-9_-]+$",
"description": "Resource slug"
}
]
},
"required": true
}
],
"get": {
"summary": "Retrieves a severity",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Severities"
],
"description": "Retrieves a specific severity by id",
"operationId": "getSeverity",
"responses": {
"200": {
"description": "severity found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/severity_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a severity",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Severities"
],
"description": "Update a specific severity by id",
"operationId": "updateSeverity",
"parameters": [],
"responses": {
"200": {
"description": "severity updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/severity_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_severity"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a severity",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Severities"
],
"description": "Delete a specific severity by id",
"operationId": "deleteSeverity",
"responses": {
"200": {
"description": "severity deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/severity_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/schedules/{schedule_id}/shift_coverage_requests": {
"parameters": [
{
"name": "schedule_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "creates shift coverage requests",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"ShiftCoverageRequests"
],
"description": "Creates coverage requests for the shifts overlapping the requested time range. A range can span multiple consecutive shifts (e.g. across a handoff), so one or more coverage requests may be created; the response is always a list. A coverage request broadcasts to schedule members so someone can volunteer to cover the shift.",
"operationId": "createShiftCoverageRequest",
"parameters": [],
"responses": {
"201": {
"description": "without override permission, can request coverage for own shift",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/shift_coverage_request_list"
}
}
}
},
"422": {
"description": "without override permission, cannot request coverage for another user's shift",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_shift_coverage_request"
}
}
},
"required": true
}
},
"get": {
"summary": "list shift coverage requests",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"ShiftCoverageRequests"
],
"description": "List active shift coverage requests for a schedule.",
"operationId": "listShiftCoverageRequests",
"responses": {
"200": {
"description": "shift_coverage_requests listed",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/shift_coverage_request_list"
}
}
}
}
}
}
},
"/v1/shift_coverage_requests/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "retrieves a shift coverage request",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"ShiftCoverageRequests"
],
"description": "Retrieves a specific shift coverage request.",
"operationId": "getShiftCoverageRequest",
"responses": {
"200": {
"description": "shift_coverage_request found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/shift_coverage_request_response"
}
}
}
}
}
},
"delete": {
"summary": "deletes a shift coverage request",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"ShiftCoverageRequests"
],
"description": "Deletes a shift coverage request.",
"operationId": "deleteShiftCoverageRequest",
"responses": {
"200": {
"description": "shift_coverage_request deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/shift_coverage_request_response"
}
}
}
}
}
}
},
"/v1/shifts": {
"get": {
"summary": "List shifts",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Shifts"
],
"description": "List shifts",
"operationId": "listShifts",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: shift_override,user. Note: `user` is deprecated, use `assignee` instead.",
"schema": {
"type": "string",
"enum": [
"shift_override",
"user",
"assignee",
"shift_shadow"
]
},
"required": false
},
{
"name": "from",
"in": "query",
"description": "Start range for shifts in ISO-8601 format (e.g., 2025-01-01T00:00:00Z or 2025-01-01T00:00:00+00:00)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "to",
"in": "query",
"description": "End range for shifts in ISO-8601 format (e.g., 2025-01-01T00:00:00Z or 2025-01-01T00:00:00+00:00)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "user_ids[]",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
},
"style": "form",
"explode": true,
"required": false
},
{
"name": "schedule_ids[]",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "form",
"explode": true,
"required": false
},
{
"name": "page[number]",
"in": "query",
"description": "Page number (defaults to 1)",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"description": "Number of shifts per page (defaults to 50, max 1000)",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/shift_list"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/slas": {
"post": {
"summary": "Creates an SLA",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"SLAs"
],
"description": "Creates a new SLA from provided data",
"operationId": "createSLA",
"parameters": [],
"responses": {
"201": {
"description": "SLA created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/sla_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_sla"
}
}
},
"required": true
}
},
"get": {
"summary": "List SLAs",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"SLAs"
],
"description": "List SLAs",
"operationId": "listSLAs",
"parameters": [
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/sla_list"
}
}
}
}
}
}
},
"/v1/slas/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves an SLA",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"SLAs"
],
"description": "Retrieves a specific SLA by id",
"operationId": "getSLA",
"responses": {
"200": {
"description": "SLA found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/sla_response"
}
}
}
},
"404": {
"description": "resource not found for another team",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update an SLA",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"SLAs"
],
"description": "Update a specific SLA by id",
"operationId": "updateSLA",
"parameters": [],
"responses": {
"200": {
"description": "SLA updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/sla_response"
}
}
}
},
"404": {
"description": "resource not found for another team",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_sla"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete an SLA",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"SLAs"
],
"description": "Delete a specific SLA by id",
"operationId": "deleteSLA",
"responses": {
"200": {
"description": "SLA deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/sla_response"
}
}
}
},
"404": {
"description": "resource not found for another team",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/status-pages/{status_page_id}/templates": {
"parameters": [
{
"name": "status_page_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates a status page template",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"StatusPageTemplates"
],
"description": "Creates a new template from provided data",
"operationId": "createStatusPageTemplate",
"parameters": [],
"responses": {
"201": {
"description": "incident_event created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/status_page_template_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/status_page_template"
}
}
},
"required": true
}
},
"get": {
"summary": "List status page templates",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"StatusPageTemplates"
],
"description": "List status page templates",
"operationId": "listStatusPageTemplates",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/status_page_template_list"
}
}
}
}
}
}
},
"/v1/templates/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a status page template",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"StatusPageTemplates"
],
"description": "Retrieves a specific status_page_template by id",
"operationId": "getStatusPageTemplate",
"responses": {
"200": {
"description": "status page template found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/status_page_template_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update status page template",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"StatusPageTemplates"
],
"description": "Update a specific template event by id",
"operationId": "updateStatusPageTemplate",
"parameters": [],
"responses": {
"200": {
"description": "incident_event updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/status_page_template_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/status_page_template"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a incident event",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"StatusPageTemplates"
],
"description": "Delete a specific template event by id",
"operationId": "deleteStatusPageTemplate",
"responses": {
"200": {
"description": "incident_event deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/status_page_template_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/status-pages": {
"post": {
"summary": "Creates a status page",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"StatusPages"
],
"description": "Creates a new status page from provided data",
"operationId": "createStatusPage",
"parameters": [],
"responses": {
"201": {
"description": "status page with SAML created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/status_page_response"
}
}
}
},
"422": {
"description": "invalid SAML configuration",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_status_page"
}
}
},
"required": true
}
},
"get": {
"summary": "List status pages",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"StatusPages"
],
"description": "List status pages",
"operationId": "listStatusPages",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/status_page_list"
}
}
}
}
}
}
},
"/v1/status-pages/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "Resource UUID"
},
{
"type": "string",
"pattern": "^[a-z0-9_-]+$",
"description": "Resource slug"
}
]
},
"required": true
}
],
"get": {
"summary": "Retrieves a status page",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"StatusPages"
],
"description": "Retrieves a specific status page by id",
"operationId": "getStatusPage",
"responses": {
"200": {
"description": "status_page found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/status_page_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a status page",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"StatusPages"
],
"description": "Update a specific status page by id",
"operationId": "updateStatusPage",
"parameters": [],
"responses": {
"200": {
"description": "external_domain_names persisted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/status_page_response"
}
}
}
},
"422": {
"description": "invalid section_order",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_status_page"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a status page",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"StatusPages"
],
"description": "Delete a specific status page by id",
"operationId": "deleteStatusPage",
"responses": {
"200": {
"description": "status_page deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/status_page_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/statuses": {
"get": {
"summary": "List Statuses",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Statuses"
],
"description": "List Statuses",
"operationId": "listStatuses",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[enabled]",
"in": "query",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/status_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/statuses/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "Resource UUID"
},
{
"type": "string",
"pattern": "^[a-z0-9_-]+$",
"description": "Resource slug"
}
]
},
"required": true
}
],
"get": {
"summary": "Retrieves a Status",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Statuses"
],
"description": "Retrieves a specific Status by id",
"operationId": "getStatus",
"responses": {
"200": {
"description": "status found by slug",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/status_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/sub_statuses": {
"post": {
"summary": "Creates a Sub-Status",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"SubStatuses"
],
"description": "Creates a new Sub-Status from provided data",
"operationId": "createSubStatus",
"parameters": [],
"responses": {
"201": {
"description": "sub_status created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/sub_status_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_sub_status"
}
}
},
"required": true
}
},
"get": {
"summary": "List Sub-Statuses",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"SubStatuses"
],
"description": "List Sub-Statuses",
"operationId": "listSubStatuses",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[parent_status]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/sub_status_list"
}
}
}
}
}
}
},
"/v1/sub_statuses/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "Resource UUID"
},
{
"type": "string",
"pattern": "^[a-z0-9_-]+$",
"description": "Resource slug"
}
]
},
"required": true
}
],
"get": {
"summary": "Retrieves a Sub-Status",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"SubStatuses"
],
"description": "Retrieves a specific Sub-Status by id",
"operationId": "getSubStatus",
"responses": {
"200": {
"description": "sub_status found by slug",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/sub_status_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a Sub-Status",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"SubStatuses"
],
"description": "Update a specific Sub-Status by id",
"operationId": "updateSubStatus",
"parameters": [],
"responses": {
"200": {
"description": "sub_status updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/sub_status_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_sub_status"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a Sub-Status",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"SubStatuses"
],
"description": "Delete a specific Sub-Status by id",
"operationId": "deleteSubStatus",
"responses": {
"200": {
"description": "sub_status deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/sub_status_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/teams": {
"post": {
"summary": "Creates a team",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Teams"
],
"description": "Creates a new team from provided data",
"operationId": "createTeam",
"parameters": [],
"responses": {
"201": {
"description": "team created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/team_response"
}
}
}
},
"422": {
"description": "invalid association",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_team"
}
}
},
"required": true
}
},
"get": {
"summary": "List teams",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Teams"
],
"description": "List teams",
"operationId": "listTeams",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: users",
"schema": {
"type": "string",
"enum": [
"users",
"schedules",
"escalation_policies"
]
},
"required": false
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[backstage_id]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[cortex_id]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[opslevel_id]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[external_id]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[color]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[alert_broadcast_enabled]",
"in": "query",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"name": "filter[incident_broadcast_enabled]",
"in": "query",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[slug][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[color][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[color][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[color][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[color][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[alert_broadcast_enabled][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[alert_broadcast_enabled][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[alert_broadcast_enabled][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[alert_broadcast_enabled][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[incident_broadcast_enabled][eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[incident_broadcast_enabled][not_eq]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[incident_broadcast_enabled][in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[incident_broadcast_enabled][not_in]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/team_list"
}
}
}
}
}
}
},
"/v1/teams/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "Team UUID"
},
{
"type": "string",
"pattern": "^[a-z0-9_-]+$",
"description": "Team slug"
}
]
},
"required": true
}
],
"get": {
"summary": "Retrieves a team",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Teams"
],
"description": "Retrieves a specific team by id",
"operationId": "getTeam",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: users",
"schema": {
"type": "string",
"enum": [
"users",
"schedules",
"escalation_policies"
]
},
"required": false
}
],
"responses": {
"200": {
"description": "team found by slug",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/team_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a team",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Teams"
],
"description": "Update a specific team by id",
"operationId": "updateTeam",
"parameters": [],
"responses": {
"200": {
"description": "team updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/team_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_team"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a team",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Teams"
],
"description": "Delete a specific team by id",
"operationId": "deleteTeam",
"responses": {
"200": {
"description": "team deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/team_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/teams/{id}/incidents_chart": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Get team incidents chart",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Teams"
],
"description": "Get team incidents chart",
"operationId": "getTeamIncidentsChart",
"parameters": [
{
"name": "period",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/incidents_chart_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/teams/properties": {
"get": {
"summary": "List Catalog Properties",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Teams"
],
"description": "List Group Catalog Properties",
"operationId": "listGroupCatalogProperties",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: catalog",
"schema": {
"type": "string",
"enum": [
"catalog"
]
},
"required": false
},
{
"name": "sort",
"in": "query",
"description": "comma separated if needed. eg: created_at,updated_at",
"schema": {
"type": "string",
"enum": [
"created_at",
"-created_at",
"updated_at",
"-updated_at",
"position",
"-position"
]
},
"required": false
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[kind]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/catalog_property_list"
}
}
}
}
}
},
"post": {
"summary": "Creates a Catalog Property",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Teams"
],
"description": "Creates a new Catalog Property from provided data",
"operationId": "createGroupCatalogProperty",
"parameters": [],
"responses": {
"201": {
"description": "catalog_property created ignores wrong catalog_type attribute",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/catalog_property_response"
}
}
}
},
"422": {
"description": "exceeds max fields per catalog",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_catalog_property"
}
}
},
"required": true
}
}
},
"/v1/users/{user_id}/email_addresses": {
"parameters": [
{
"name": "user_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates a user email address",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"UserEmailAddresses"
],
"description": "Creates a new user email address from provided data",
"operationId": "createUserEmailAddress",
"parameters": [],
"responses": {
"201": {
"description": "user_email_address created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/user_email_address_response"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"404": {
"description": "responds with not found when accessing other user's resources",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_user_email_address"
}
}
},
"required": true
}
},
"get": {
"summary": "Retrieves user email addresses",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"UserEmailAddresses"
],
"description": "Retrieves all email addresses for the specified user",
"operationId": "getUserEmailAddresses",
"responses": {
"200": {
"description": "user_email_addresses found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/user_email_address_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"404": {
"description": "responds with not found when accessing other user's resources",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/email_addresses/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Show user email address",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"UserEmailAddresses"
],
"description": "Retrieves a specific user email address",
"operationId": "showUserEmailAddress",
"responses": {
"200": {
"description": "user_email_address found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/user_email_address_response"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"404": {
"description": "responds with not found when accessing other user's resources",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update user email address",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"UserEmailAddresses"
],
"description": "Updates a user email address",
"operationId": "updateUserEmailAddress",
"parameters": [],
"responses": {
"200": {
"description": "user_email_address updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/user_email_address_response"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"404": {
"description": "responds with not found when accessing other user's resources",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_user_email_address"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete user email address",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"UserEmailAddresses"
],
"description": "Deletes a user email address",
"operationId": "deleteUserEmailAddress",
"responses": {
"200": {
"description": "user_email_address deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/user_email_address_response"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"404": {
"description": "responds with not found when accessing other user's resources",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/email_addresses/{id}/verify": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Verifies an email address with token",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"UserEmailAddresses"
],
"description": "Verifies an email address using a verification token",
"operationId": "verifyUserEmailAddress",
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "email address verified successfully",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/user_email_address_response"
}
}
}
},
"422": {
"description": "invalid or expired token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"404": {
"description": "email address not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/email_addresses/{id}/resend_verification": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Resends verification email",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"UserEmailAddresses"
],
"description": "Resends verification email for an email address",
"operationId": "resendUserEmailAddressVerification",
"responses": {
"200": {
"description": "verification email sent successfully",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/user_email_address_response"
}
}
}
},
"422": {
"description": "email address already verified",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"404": {
"description": "email address not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/users/{user_id}/notification_rules": {
"parameters": [
{
"name": "user_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates an user notification rule",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"UserNotificationRules"
],
"description": "Creates a new user notification rule from provided data",
"operationId": "createUserNotificationRule",
"parameters": [],
"responses": {
"201": {
"description": "user_notification_rule created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/user_notification_rule_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_user_notification_rule"
}
}
},
"required": true
}
},
"get": {
"summary": "List user notification rules",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"UserNotificationRules"
],
"description": "List user notification rules",
"operationId": "listUserNotificationRules",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "sort",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/user_notification_rule_list"
}
}
}
}
}
}
},
"/v1/notification_rules/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves an user notification rule",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"UserNotificationRules"
],
"description": "Retrieves a specific user notification rule by id",
"operationId": "getUserNotificationRule",
"responses": {
"200": {
"description": "user_notification_rule found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/user_notification_rule_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update an user notification rule",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"UserNotificationRules"
],
"description": "Update a specific user notification rule by id",
"operationId": "updateUserNotificationRule",
"parameters": [],
"responses": {
"200": {
"description": "user_notification_rule updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/user_notification_rule_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_user_notification_rule"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete an user notification rule",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"UserNotificationRules"
],
"description": "Delete a specific user notification rule by id",
"operationId": "deleteUserNotificationRule",
"responses": {
"200": {
"description": "user_notification_rule deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/user_notification_rule_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/users/{user_id}/phone_numbers": {
"parameters": [
{
"name": "user_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates a user phone number",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"UserPhoneNumbers"
],
"description": "Creates a new user phone number from provided data",
"operationId": "createUserPhoneNumber",
"parameters": [],
"responses": {
"201": {
"description": "user_phone_number created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/user_phone_number_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_user_phone_number"
}
}
},
"required": true
}
},
"get": {
"summary": "Retrieves user phone numbers",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"UserPhoneNumbers"
],
"description": "Retrieves all phone numbers for the specified user",
"operationId": "getUserPhoneNumbers",
"responses": {
"200": {
"description": "user_phone_numbers found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/user_phone_number_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/phone_numbers/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Show user phone number",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"UserPhoneNumbers"
],
"description": "Retrieves a specific user phone number",
"operationId": "showUserPhoneNumber",
"responses": {
"200": {
"description": "user_phone_number found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/user_phone_number_response"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update user phone number",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"UserPhoneNumbers"
],
"description": "Updates a user phone number",
"operationId": "updateUserPhoneNumber",
"parameters": [],
"responses": {
"200": {
"description": "user_phone_number updated and verification status reset",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/user_phone_number_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_user_phone_number"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete user phone number",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"UserPhoneNumbers"
],
"description": "Deletes a user phone number",
"operationId": "deleteUserPhoneNumber",
"responses": {
"200": {
"description": "user_phone_number deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/user_phone_number_response"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"422": {
"description": "cannot delete phone number used by notification rule",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/users": {
"get": {
"summary": "List users",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Users"
],
"description": "List users",
"operationId": "listUsers",
"parameters": [
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[search]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[email]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"description": "comma separated if needed. eg: created_at,updated_at",
"schema": {
"type": "string",
"enum": [
"created_at",
"-created_at",
"updated_at",
"-updated_at"
]
},
"required": false
},
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: email_addresses,phone_numbers",
"schema": {
"type": "string",
"enum": [
"email_addresses",
"phone_numbers",
"devices",
"role",
"on_call_role",
"teams",
"schedules",
"notification_rules"
]
},
"required": false
}
],
"responses": {
"200": {
"description": "user found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/user_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/users/me": {
"get": {
"summary": "Get current user",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Users"
],
"description": "Get current user",
"operationId": "getCurrentUser",
"responses": {
"200": {
"description": "user found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/user_response"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/users/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves an user",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Users"
],
"description": "Retrieves a specific user by id",
"operationId": "getUser",
"parameters": [
{
"name": "include",
"in": "query",
"description": "comma separated if needed. eg: email_addresses,phone_numbers",
"schema": {
"type": "string",
"enum": [
"email_addresses",
"phone_numbers",
"devices",
"role",
"on_call_role",
"teams",
"schedules",
"notification_rules"
]
},
"required": false
}
],
"responses": {
"200": {
"description": "teams include only returns teams from the current team",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/user_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"delete": {
"summary": "Delete an user",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Users"
],
"description": "Delete a specific user by id",
"operationId": "deleteUser",
"responses": {
"200": {
"description": "user deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/user_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a user",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Users"
],
"description": "Update a specific user by id",
"operationId": "updateUser",
"parameters": [],
"responses": {
"200": {
"description": "custom role with roles_permissions can update user role (IR-5606)",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/user_response"
}
}
}
},
"404": {
"description": "returns 404 for on_call_role_id belonging to another team",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_user"
}
}
}
}
}
},
"/v1/webhooks/endpoints/{endpoint_id}/deliveries": {
"get": {
"summary": "List webhook deliveries",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"WebhooksDeliveries"
],
"description": "List webhook deliveries for given endpoint",
"operationId": "listWebhooksDeliveries",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "endpoint_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/webhooks_delivery_list"
}
}
}
}
}
}
},
"/v1/webhooks/deliveries/{id}/deliver": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Retries a webhook delivery",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"WebhooksDeliveries"
],
"description": "Retries a webhook delivery",
"operationId": "deliverWebhooksDelivery",
"responses": {
"200": {
"description": "webhooks_delivery delivered",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/webhooks_delivery_response"
}
}
}
}
}
}
},
"/v1/webhooks/deliveries/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a webhook delivery",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"WebhooksDeliveries"
],
"description": "Retrieves a specific webhook delivery by id",
"operationId": "getWebhooksDelivery",
"responses": {
"200": {
"description": "webhooks_delivery found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/webhooks_delivery_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/webhooks/endpoints": {
"post": {
"summary": "Creates a webhook endpoint",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"WebhooksEndpoints"
],
"description": "Creates a new webhook endpoint from provided data",
"operationId": "createWebhooksEndpoint",
"parameters": [],
"responses": {
"201": {
"description": "webhooks_endpoint created with custom_headers",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/webhooks_endpoint_response"
}
}
}
},
"422": {
"description": "invalid request",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"401": {
"description": "responds with unauthorized for invalid token",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_webhooks_endpoint"
}
}
},
"required": true
}
},
"get": {
"summary": "List webhook endpoints",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"WebhooksEndpoints"
],
"description": "List webhook endpoints",
"operationId": "listWebhooksEndpoints",
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[slug]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "excludes hidden endpoints from listing",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/webhooks_endpoint_list"
}
}
}
}
}
}
},
"/v1/webhooks/endpoints/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a webhook endpoint",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"WebhooksEndpoints"
],
"description": "Retrieves a specific webhook endpoint by id",
"operationId": "getWebhooksEndpoint",
"responses": {
"200": {
"description": "webhooks_endpoint found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/webhooks_endpoint_response"
}
}
}
},
"404": {
"description": "hidden endpoint not accessible",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a webhook endpoint",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"WebhooksEndpoints"
],
"description": "Update a specific webhook endpoint by id",
"operationId": "updateWebhooksEndpoint",
"parameters": [],
"responses": {
"200": {
"description": "webhooks_endpoint custom_headers cleared with empty array",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/webhooks_endpoint_response"
}
}
}
},
"404": {
"description": "hidden endpoint not accessible",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_webhooks_endpoint"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a webhook endpoint",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"WebhooksEndpoints"
],
"description": "Delete a specific webhook endpoint by id",
"operationId": "deleteWebhooksEndpoint",
"responses": {
"200": {
"description": "webhooks_endpoint deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/webhooks_endpoint_response"
}
}
}
},
"404": {
"description": "hidden endpoint not accessible",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
}
},
"servers": [
{
"url": "https://api.rootly.com"
}
],
"components": {
"securitySchemes": {
"bearer_auth": {
"type": "http",
"scheme": "bearer"
}
},
"schemas": {
"ai_chat_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Session UUID"
},
"type": {
"type": "string",
"enum": [
"ai_chat_responses"
]
},
"attributes": {
"type": "object",
"properties": {
"session_id": {
"type": "string",
"format": "uuid",
"description": "AI chat session UUID"
},
"reply": {
"type": "string",
"nullable": true,
"description": "Assistant reply text"
},
"status": {
"type": "string",
"nullable": true,
"description": "Response status (present when user input is required)",
"enum": [
"user_input_required"
]
}
},
"required": [
"session_id"
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"ai_chat_session_message": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Message UUID"
},
"role": {
"type": "string",
"description": "Message author role",
"enum": [
"user",
"assistant"
]
},
"content": {
"type": "string",
"description": "Message content"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "When the message was created"
}
},
"required": [
"id",
"role",
"content",
"created_at"
]
},
"ai_chat_session_message_list": {
"type": "object",
"properties": {
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ai_chat_session_message"
}
},
"meta": {
"type": "object"
}
},
"required": [
"messages"
]
},
"attach_alert": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"alerts"
]
},
"attributes": {
"type": "object",
"properties": {
"alert_ids": {
"type": "array",
"description": "Alert Id to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false,
"required": [
"alert_ids"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"new_alert": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"alerts"
]
},
"attributes": {
"type": "object",
"properties": {
"noise": {
"type": "string",
"description": "Whether the alert is marked as noise",
"enum": [
"noise",
"not_noise"
],
"nullable": true
},
"source": {
"type": "string",
"description": "Deprecated. Accepted for backwards compatibility; new clients should omit. Defaults to `api`.",
"deprecated": true
},
"status": {
"type": "string",
"enum": [
"open",
"triggered"
],
"description": "Only available for organizations with Rootly On-Call enabled. Can be one of open, triggered."
},
"summary": {
"type": "string",
"description": "The summary of the alert"
},
"description": {
"type": "string",
"description": "The description of the alert",
"nullable": true
},
"service_ids": {
"type": "array",
"description": "The Service IDs to attach to the alert. If your organization has On-Call enabled and your notification target is a Service. This field will be automatically set for you.",
"items": {
"type": "string"
},
"nullable": true
},
"group_ids": {
"type": "array",
"description": "The Group IDs to attach to the alert. If your organization has On-Call enabled and your notification target is a Group. This field will be automatically set for you.",
"items": {
"type": "string"
},
"nullable": true
},
"functionality_ids": {
"type": "array",
"description": "The Functionality IDs to attach to the alert",
"items": {
"type": "string"
},
"nullable": true
},
"environment_ids": {
"type": "array",
"description": "The Environment IDs to attach to the alert",
"items": {
"type": "string"
},
"nullable": true
},
"started_at": {
"type": "string",
"description": "Alert start datetime",
"format": "date-time",
"nullable": true
},
"ended_at": {
"type": "string",
"description": "Alert end datetime",
"format": "date-time",
"nullable": true
},
"external_id": {
"type": "string",
"description": "External ID",
"nullable": true
},
"external_url": {
"type": "string",
"description": "External Url",
"nullable": true
},
"alert_urgency_id": {
"type": "string",
"description": "The ID of the alert urgency",
"nullable": true
},
"notification_target_type": {
"type": "string",
"enum": [
"User",
"Group",
"EscalationPolicy",
"Service",
"Functionality"
],
"description": "Only available for organizations with Rootly On-Call enabled. Can be one of Group, Service, EscalationPolicy, Functionality, User. Please contact support if you encounter issues using `Functionality` as a notification target type.",
"nullable": true
},
"notification_target_id": {
"type": "string",
"description": "Only available for organizations with Rootly On-Call enabled. The _identifier_ of the notification target object.",
"nullable": true
},
"notification_targets": {
"type": "array",
"description": "Only available for organizations with Rootly On-Call enabled. Page multiple destinations (any combination of Group, Service, EscalationPolicy, Functionality, or User) in a single request. `Functionality` targets require the `enable_paging_functionalities` feature; a request that includes one while it is disabled is rejected. Applies to alert creation only. When provided, this takes precedence over the singular `notification_target_type` / `notification_target_id` fields.",
"nullable": true,
"minItems": 1,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"enum": [
"User",
"Group",
"EscalationPolicy",
"Service",
"Functionality"
],
"description": "The type of the notification target. Can be one of Group, Service, EscalationPolicy, Functionality, User."
},
"id": {
"type": "string",
"description": "The identifier of the notification target object."
}
},
"required": [
"type",
"id"
]
}
},
"labels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Key of the tag"
},
"value": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
],
"description": "Value of the tag"
}
},
"required": [
"key",
"value"
],
"nullable": true
}
},
"data": {
"type": "object",
"description": "Additional data",
"nullable": true
},
"deduplication_key": {
"type": "string",
"description": "Alerts sharing the same deduplication key are treated as a single alert.",
"nullable": true
},
"alert_field_values_attributes": {
"type": "array",
"description": "Custom alert field values to create with the alert",
"items": {
"type": "object",
"properties": {
"alert_field_id": {
"type": "string",
"description": "ID of the custom alert field"
},
"value": {
"type": "string",
"description": "Value for the alert field"
}
},
"required": [
"alert_field_id",
"value"
],
"nullable": true
}
}
},
"additionalProperties": false,
"required": [
"summary"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_alert": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"alerts"
]
},
"attributes": {
"type": "object",
"properties": {
"noise": {
"type": "string",
"description": "Whether the alert is marked as noise",
"enum": [
"noise",
"not_noise"
],
"nullable": true
},
"source": {
"type": "string",
"description": "Deprecated. Accepted for backwards compatibility; new clients should omit. Defaults to `api`.",
"deprecated": true
},
"summary": {
"type": "string",
"description": "The summary of the alert"
},
"description": {
"type": "string",
"description": "The description of the alert",
"nullable": true
},
"service_ids": {
"type": "array",
"description": "The Service IDs to attach to the alert",
"items": {
"type": "string"
},
"nullable": true
},
"group_ids": {
"type": "array",
"description": "The Group IDs to attach to the alert",
"items": {
"type": "string"
},
"nullable": true
},
"functionality_ids": {
"type": "array",
"description": "The Functionality IDs to attach to the alert",
"items": {
"type": "string"
},
"nullable": true
},
"environment_ids": {
"type": "array",
"description": "The Environment IDs to attach to the alert",
"items": {
"type": "string"
},
"nullable": true
},
"started_at": {
"type": "string",
"description": "Alert start datetime",
"format": "date-time",
"nullable": true
},
"ended_at": {
"type": "string",
"description": "Alert end datetime",
"format": "date-time",
"nullable": true
},
"external_id": {
"type": "string",
"description": "External ID",
"nullable": true
},
"external_url": {
"type": "string",
"description": "External Url",
"nullable": true
},
"alert_urgency_id": {
"type": "string",
"description": "The ID of the alert urgency",
"nullable": true
},
"labels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Key of the tag"
},
"value": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
],
"description": "Value of the tag"
}
},
"required": [
"key",
"value"
],
"nullable": true
}
},
"data": {
"type": "object",
"description": "Additional data",
"nullable": true
},
"deduplication_key": {
"type": "string",
"description": "Alerts sharing the same deduplication key are treated as a single alert.",
"nullable": true
},
"alert_field_values_attributes": {
"type": "array",
"description": "Custom alert field values to create with the alert",
"items": {
"type": "object",
"properties": {
"alert_field_id": {
"type": "string",
"description": "ID of the custom alert field"
},
"value": {
"type": "string",
"description": "Value for the alert field"
}
},
"required": [
"alert_field_id",
"value"
],
"nullable": true
}
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"alert": {
"type": "object",
"properties": {
"short_id": {
"type": "string",
"description": "Human-readable short identifier for the alert"
},
"noise": {
"type": "string",
"description": "Whether the alert is marked as noise",
"enum": [
"noise",
"not_noise"
],
"nullable": true
},
"source": {
"type": "string",
"description": "The source of the alert"
},
"status": {
"type": "string",
"enum": [
"open",
"triggered",
"acknowledged",
"resolved",
"deferred"
],
"description": "The status of the alert"
},
"summary": {
"type": "string",
"description": "The summary of the alert"
},
"description": {
"type": "string",
"description": "The description of the alert",
"nullable": true
},
"services": {
"type": "array",
"description": "Services attached to the alert",
"items": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/service"
}
]
}
},
"groups": {
"type": "array",
"description": "Groups attached to the alert",
"items": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/team"
}
]
}
},
"functionalities": {
"type": "array",
"description": "Functionalities attached to the alert",
"items": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/functionality"
}
]
}
},
"environments": {
"type": "array",
"description": "Environments attached to the alert",
"items": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/environment"
}
]
}
},
"service_ids": {
"type": "array",
"description": "The Service IDs to attach to the alert. If your organization has On-Call enabled and your notification target is a Service. This field will be automatically set for you.",
"items": {
"type": "string"
},
"nullable": true
},
"group_ids": {
"type": "array",
"description": "The Group IDs to attach to the alert. If your organization has On-Call enabled and your notification target is a Group. This field will be automatically set for you.",
"items": {
"type": "string"
},
"nullable": true
},
"functionality_ids": {
"type": "array",
"description": "The Functionality IDs to attach to the alert",
"items": {
"type": "string"
},
"nullable": true
},
"environment_ids": {
"type": "array",
"description": "The Environment IDs to attach to the alert",
"items": {
"type": "string"
},
"nullable": true
},
"external_id": {
"type": "string",
"description": "External ID",
"nullable": true
},
"external_url": {
"type": "string",
"description": "External Url",
"nullable": true
},
"alert_urgency_id": {
"type": "string",
"description": "The ID of the alert urgency",
"nullable": true
},
"alert_urgency": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/alert_urgency"
}
],
"nullable": true
},
"group_leader_alert_id": {
"type": "string",
"description": "The ID of the group leader alert",
"nullable": true
},
"is_group_leader_alert": {
"type": "boolean",
"description": "Whether the alert is a group leader alert",
"nullable": true
},
"labels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Key of the tag"
},
"value": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
],
"description": "Value of the tag"
}
},
"required": [
"key",
"value"
],
"nullable": true
}
},
"data": {
"type": "object",
"description": "Additional data",
"nullable": true
},
"notification_target_type": {
"type": "string",
"enum": [
"User",
"Group",
"EscalationPolicy",
"Service",
"Functionality"
],
"description": "Only available for organizations with Rootly On-Call enabled. Can be one of Group, Service, EscalationPolicy, Functionality, User.",
"nullable": true
},
"notification_target_id": {
"type": "string",
"description": "Only available for organizations with Rootly On-Call enabled. The identifier of the notification target object.",
"nullable": true
},
"deduplication_key": {
"type": "string",
"description": "Alerts sharing the same deduplication key are treated as a single alert.",
"nullable": true
},
"alert_field_values": {
"type": "array",
"description": "Custom alert field values associated with the alert. Only present when the enable_alert_fields feature flag is enabled for the team.",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the alert field value"
},
"value": {
"type": "string",
"description": "Value for the alert field"
},
"alert_field_id": {
"type": "string",
"description": "ID of the custom alert field"
},
"alert_id": {
"type": "string",
"description": "ID of the alert"
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"id",
"value",
"alert_field_id",
"alert_id",
"created_at",
"updated_at"
]
},
"nullable": true
},
"responders": {
"type": "array",
"description": "Users who responded to the alert. Included on all non-list responses (show, create, update, resolve, etc.); on list responses only when `include=responders` is requested.",
"items": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/user_flat_response"
}
]
},
"nullable": true
},
"notified_users": {
"type": "array",
"description": "Users who were notified about the alert. Included on all non-list responses (show, create, update, resolve, etc.); on list responses only when `include=notified_users` is requested.",
"items": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/user"
}
]
},
"nullable": true
},
"alerting_targets": {
"type": "array",
"description": "Alerting targets associated with the alert. Only present when advanced routing is enabled for the team.",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the alerting target"
},
"type": {
"type": "string",
"description": "Type of the alerting target (e.g. team, user, escalation_policy, service, functionality, slack_channel)"
}
},
"required": [
"id",
"type"
]
},
"nullable": true
},
"url": {
"type": "string",
"description": "The Rootly dashboard URL for the alert",
"format": "uri"
},
"started_at": {
"type": "string",
"description": "When the alert started",
"format": "date-time",
"nullable": true
},
"ended_at": {
"type": "string",
"description": "When the alert ended",
"format": "date-time",
"nullable": true
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"short_id",
"source",
"summary",
"created_at",
"updated_at"
]
},
"alert_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the alert"
},
"source": {
"type": "string",
"description": "The source of the alert"
},
"type": {
"type": "string",
"enum": [
"alerts"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/alert"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"alert_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the alert"
},
"source": {
"type": "string",
"description": "The source of the alert"
},
"type": {
"type": "string",
"enum": [
"alerts"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/alert"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"resolve_alert": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"alerts"
]
},
"attributes": {
"type": "object",
"properties": {
"resolution_message": {
"type": "string",
"description": "How was the alert resolved?",
"nullable": true
},
"resolve_related_incidents": {
"type": "boolean",
"description": "Resolve all associated incidents",
"nullable": true
}
},
"additionalProperties": false
}
}
}
}
},
"snooze_alert": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"alerts"
]
},
"attributes": {
"type": "object",
"properties": {
"delay_minutes": {
"type": "integer",
"minimum": 1,
"maximum": 10080,
"description": "Number of minutes to snooze the alert for"
}
},
"additionalProperties": false,
"required": [
"delay_minutes"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"escalate_alert": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"alerts"
]
},
"attributes": {
"type": "object",
"properties": {
"escalation_policy_id": {
"type": "string",
"description": "The ID of the escalation policy to escalate to. If omitted, uses the alert's current escalation policy from metadata. Required for resolved alerts whose metadata may have been cleared."
},
"escalation_policy_level": {
"type": "integer",
"minimum": 1,
"description": "The escalation policy level to escalate to. If omitted, defaults to the next level (same EP) or level 1 (different EP)."
}
},
"additionalProperties": false
}
}
}
}
},
"alert_event_user": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"first_name": {
"type": "string",
"nullable": true
},
"last_name": {
"type": "string",
"nullable": true
},
"preferred_name": {
"type": "string",
"nullable": true
},
"full_name": {
"type": "string",
"nullable": true
},
"time_zone": {
"type": "string",
"nullable": true
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"id",
"name",
"email",
"created_at",
"updated_at"
]
},
"new_alert_event": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"alert_events"
]
},
"attributes": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"note"
]
},
"user_id": {
"type": "integer",
"description": "Author of the note."
},
"details": {
"type": "string",
"description": "Note message."
}
},
"additionalProperties": false,
"required": [
"kind",
"details"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_alert_event": {
"type": "object",
"description": "Update an alert event. Note: Only alert events with kind='note' can be updated. You cannot change the kind field.",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"alert_events"
]
},
"attributes": {
"type": "object",
"properties": {
"user_id": {
"type": "integer",
"description": "Author of the note."
},
"details": {
"type": "string",
"description": "Note message."
}
},
"additionalProperties": false,
"required": [
"details"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"alert_event": {
"type": "object",
"properties": {
"alert_id": {
"type": "string",
"description": "ID of the alert this event belongs to."
},
"kind": {
"type": "string",
"enum": [
"informational",
"notification",
"action",
"status_update",
"recording",
"alert_grouping",
"alert_urgency",
"alert_routing",
"note",
"noise",
"maintenance",
"deferral"
]
},
"action": {
"type": "string",
"enum": [
"created",
"escalation_policy_paged",
"ignored_alert_request",
"emailed",
"slacked",
"ms_teams_messaged",
"google_chat_messaged",
"called",
"texted",
"notified",
"skipped",
"opened",
"retriggered",
"answered",
"acknowledged",
"escalated",
"paged",
"resolved",
"attached",
"snoozed",
"triggered",
"open",
"updated",
"added",
"removed",
"marked",
"not_marked",
"muted",
"deferred"
]
},
"source": {
"type": "string"
},
"user_id": {
"type": "integer",
"description": "Author of the note.",
"nullable": true
},
"details": {
"type": "string",
"description": "Note message.",
"nullable": true
},
"user": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/alert_event_user"
}
],
"nullable": true
},
"incident": {
"type": "object",
"nullable": true,
"properties": {
"id": {
"type": "string"
},
"sequential_id": {
"type": "integer",
"nullable": true
},
"title": {
"type": "string"
},
"slug": {
"type": "string"
},
"kind": {
"type": "string"
},
"status": {
"type": "string"
},
"private": {
"type": "boolean"
},
"description": {
"type": "string",
"nullable": true
},
"started_at": {
"type": "string",
"nullable": true
},
"duration": {
"type": "integer",
"description": "Duration in seconds.",
"nullable": true
},
"url": {
"type": "string"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
}
},
"schedule": {
"type": "object",
"nullable": true,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"escalation_policies": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
}
}
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
}
},
"escalation_level": {
"type": "integer",
"nullable": true
},
"escalation_target_type": {
"type": "string",
"description": "e.g. EscalationPolicy, User.",
"nullable": true
},
"escalation_target": {
"type": "object",
"description": "JSON:API-wrapped escalation target (User or EscalationPolicy).",
"nullable": true,
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"description": "e.g. users, escalation_policies."
},
"attributes": {
"type": "object"
}
}
}
}
},
"slack_channel": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/slack_channel"
}
],
"nullable": true
},
"incident_ids": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"alert_id",
"source",
"kind",
"action",
"created_at",
"updated_at"
]
},
"alert_event_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the alert event"
},
"type": {
"type": "string",
"enum": [
"alert_events"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/alert_event"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"alert_event_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the alert event"
},
"type": {
"type": "string",
"enum": [
"alert_events"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/alert_event"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"alert_event_feed_meta": {
"type": "object",
"description": "Cursor-pagination meta. `total_count` and `total_pages` are nullable because the feed does not run a COUNT query.",
"properties": {
"next_cursor": {
"type": "string",
"nullable": true,
"description": "Pass as `page[after]` on the next request to fetch the following page."
},
"current_page": {
"type": "integer",
"nullable": true
},
"next_page": {
"type": "integer",
"nullable": true
},
"prev_page": {
"type": "integer",
"nullable": true
},
"total_count": {
"type": "integer",
"nullable": true
},
"total_pages": {
"type": "integer",
"nullable": true
}
},
"required": [
"next_cursor"
]
},
"alert_event_feed_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the alert event"
},
"type": {
"type": "string",
"enum": [
"alert_events"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/alert_event"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/alert_event_feed_meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"meta"
]
},
"new_alerts_source": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"alert_sources"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the alert source"
},
"enabled": {
"type": "boolean",
"description": "Whether the alert source is enabled. Disabled sources do not create alerts from incoming events."
},
"source_type": {
"type": "string",
"description": "The alert source type",
"enum": [
"email",
"app_dynamics",
"catchpoint",
"cloudflare",
"datadog",
"dynatrace",
"alertmanager",
"google_cloud",
"grafana",
"sentry",
"generic_webhook",
"cloud_watch",
"aws_sns",
"checkly",
"azure",
"new_relic",
"splunk",
"chronosphere",
"app_optics",
"bug_snag",
"honeycomb",
"monte_carlo",
"nagios",
"prtg"
]
},
"alert_urgency_id": {
"type": "string",
"description": "ID for the default alert urgency assigned to this alert source"
},
"deduplicate_alerts_by_key": {
"type": "boolean",
"description": "Toggle alert deduplication using deduplication key. If enabled, deduplication_key_kind and deduplication_key_path are required."
},
"deduplication_key_kind": {
"type": "string",
"description": "Kind of deduplication key.",
"enum": [
"payload"
]
},
"deduplication_key_path": {
"type": "string",
"description": "Path to deduplication key. This is a JSON Path to extract the deduplication key from the request body.",
"nullable": true
},
"deduplication_key_regexp": {
"type": "string",
"description": "Regular expression to extract key from value found at key path.",
"nullable": true
},
"owner_group_ids": {
"type": "array",
"description": "List of team IDs that will own the alert source",
"items": {
"type": "string"
}
},
"alert_template_attributes": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The alert title.",
"nullable": true
},
"description": {
"type": "string",
"description": "The alert description.",
"nullable": true
},
"external_url": {
"type": "string",
"description": "The alert URL.",
"nullable": true
}
},
"nullable": true
},
"alert_source_urgency_rules_attributes": {
"type": "array",
"description": "List of rules that define the conditions under which the alert urgency will be set automatically based on the alert payload",
"items": {
"type": "object",
"properties": {
"json_path": {
"type": "string",
"description": "JSON path expression to extract a specific value from the alert's payload for evaluation",
"nullable": true
},
"operator": {
"type": "string",
"description": "Comparison operator used to evaluate the extracted value against the specified condition",
"enum": [
"is",
"is_not",
"contains",
"does_not_contain"
]
},
"value": {
"type": "string",
"description": "Value that the extracted payload data is compared to using the specified operator to determine a match"
},
"conditionable_type": {
"type": "string",
"description": "The type of the conditionable",
"enum": [
"AlertField"
],
"nullable": true
},
"conditionable_id": {
"type": "string",
"description": "The ID of the conditionable. If conditionable_type is AlertField, this is the ID of the alert field.",
"nullable": true
},
"kind": {
"type": "string",
"description": "The kind of the conditionable",
"enum": [
"payload",
"alert_field"
]
},
"alert_urgency_id": {
"type": "string",
"description": "The ID of the alert urgency"
}
}
}
},
"sourceable_attributes": {
"type": "object",
"description": "Provide additional attributes for generic_webhook alerts source",
"properties": {
"auto_resolve": {
"type": "boolean",
"description": "Set this to true to auto-resolve alerts based on field_mappings_attributes conditions"
},
"resolve_state": {
"type": "string",
"description": "This value is matched with the value extracted from alerts payload using JSON path in field_mappings_attributes",
"nullable": true
},
"accept_threaded_emails": {
"type": "boolean",
"description": "Set this to false to reject threaded emails"
},
"field_mappings_attributes": {
"type": "array",
"description": "Specify rules to auto resolve alerts",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "Select the field on which the condition to be evaluated",
"enum": [
"external_id",
"state",
"alert_title",
"alert_description",
"alert_external_url",
"notification_target_type",
"notification_target_id"
]
},
"json_path": {
"type": "string",
"description": "JSON path expression to extract a specific value from the alert's payload for evaluation. For `notification_target_id` only: if your account has opted in to Dynamic Notification Targets, this may also be a Liquid template that resolves to a notification target id at routing time."
}
}
}
}
},
"nullable": true
},
"resolution_rule_attributes": {
"type": "object",
"description": "Provide additional attributes for email alerts source",
"properties": {
"enabled": {
"type": "boolean",
"description": "Set this to true to enable the auto resolution rule"
},
"condition_type": {
"type": "string",
"description": "The type of condition to evaluate to apply auto resolution rule",
"enum": [
"all",
"any"
]
},
"identifier_matchable_type": {
"type": "string",
"description": "The type of the identifier matchable",
"enum": [
"AlertField"
],
"nullable": true
},
"identifier_matchable_id": {
"type": "string",
"description": "The ID of the identifier matchable. If identifier_matchable_type is AlertField, this is the ID of the alert field.",
"nullable": true
},
"identifier_reference_kind": {
"type": "string",
"description": "The kind of the identifier reference",
"enum": [
"payload",
"alert_field"
]
},
"identifier_json_path": {
"type": "string",
"description": "JSON path expression to extract unique alert identifier used to match triggered alerts with resolving alerts",
"nullable": true
},
"identifier_value_regex": {
"type": "string",
"description": "Regex group to further specify the part of the string used as a unique identifier",
"nullable": true
},
"conditions_attributes": {
"type": "array",
"description": "List of conditions to evaluate for auto resolution",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "JSON path expression to extract a specific value from the alert's payload for evaluation",
"nullable": true
},
"operator": {
"type": "string",
"description": "Comparison operator used to evaluate the extracted value against the specified condition",
"enum": [
"is",
"is_not",
"contains",
"does_not_contain",
"starts_with",
"ends_with"
]
},
"value": {
"type": "string",
"description": "Value that the extracted payload data is compared to using the specified operator to determine a match"
},
"conditionable_type": {
"type": "string",
"description": "The type of the conditionable",
"enum": [
"AlertField"
],
"nullable": true
},
"conditionable_id": {
"type": "string",
"description": "The ID of the conditionable. If conditionable_type is AlertField, this is the ID of the alert field.",
"nullable": true
},
"kind": {
"type": "string",
"description": "The kind of the conditionable",
"enum": [
"payload",
"alert_field"
]
}
}
}
}
},
"nullable": true
},
"alert_source_fields_attributes": {
"type": "array",
"description": "List of alert fields to be added to the alert source. Note: This attribute requires the alert field feature to be enabled on your account. Contact Rootly customer support if you need assistance with this feature.",
"items": {
"type": "object",
"properties": {
"alert_field_id": {
"type": "string",
"description": "The ID of the alert field"
},
"template_body": {
"type": "string",
"description": "Liquid expression to extract a specific value from the alert's payload for evaluation",
"nullable": true
}
}
}
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_alerts_source": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"alert_sources"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the alert source"
},
"enabled": {
"type": "boolean",
"description": "Whether the alert source is enabled. Disabled sources do not create alerts from incoming events."
},
"source_type": {
"type": "string",
"description": "The alert source type",
"enum": [
"email",
"app_dynamics",
"catchpoint",
"cloudflare",
"datadog",
"dynatrace",
"alertmanager",
"google_cloud",
"grafana",
"sentry",
"generic_webhook",
"cloud_watch",
"aws_sns",
"checkly",
"azure",
"new_relic",
"splunk",
"chronosphere",
"app_optics",
"bug_snag",
"honeycomb",
"monte_carlo",
"nagios",
"prtg"
]
},
"alert_urgency_id": {
"type": "string",
"description": "ID for the default alert urgency assigned to this alert source"
},
"deduplicate_alerts_by_key": {
"type": "boolean",
"description": "Toggle alert deduplication using deduplication key. If enabled, deduplication_key_kind and deduplication_key_path are required."
},
"deduplication_key_kind": {
"type": "string",
"description": "Kind of deduplication key.",
"enum": [
"payload"
]
},
"deduplication_key_path": {
"type": "string",
"description": "Path to deduplication key. This is a JSON Path to extract the deduplication key from the request body.",
"nullable": true
},
"deduplication_key_regexp": {
"type": "string",
"description": "Regular expression to extract key from value found at key path.",
"nullable": true
},
"owner_group_ids": {
"type": "array",
"description": "List of team IDs that will own the alert source",
"items": {
"type": "string"
}
},
"alert_template_attributes": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The alert title.",
"nullable": true
},
"description": {
"type": "string",
"description": "The alert description.",
"nullable": true
},
"external_url": {
"type": "string",
"description": "The alert URL.",
"nullable": true
}
},
"nullable": true
},
"alert_source_urgency_rules_attributes": {
"type": "array",
"description": "List of rules that define the conditions under which the alert urgency will be set automatically based on the alert payload",
"items": {
"type": "object",
"properties": {
"json_path": {
"type": "string",
"description": "JSON path expression to extract a specific value from the alert's payload for evaluation",
"nullable": true
},
"operator": {
"type": "string",
"description": "Comparison operator used to evaluate the extracted value against the specified condition",
"enum": [
"is",
"is_not",
"contains",
"does_not_contain"
]
},
"value": {
"type": "string",
"description": "Value that the extracted payload data is compared to using the specified operator to determine a match"
},
"conditionable_type": {
"type": "string",
"description": "The type of the conditionable",
"enum": [
"AlertField"
],
"nullable": true
},
"conditionable_id": {
"type": "string",
"description": "The ID of the conditionable. If conditionable_type is AlertField, this is the ID of the alert field.",
"nullable": true
},
"kind": {
"type": "string",
"description": "The kind of the conditionable",
"enum": [
"payload",
"alert_field"
]
},
"alert_urgency_id": {
"type": "string",
"description": "The ID of the alert urgency"
}
}
}
},
"sourceable_attributes": {
"type": "object",
"description": "Provide additional attributes for generic_webhook alerts source",
"properties": {
"auto_resolve": {
"type": "boolean",
"description": "Set this to true to auto-resolve alerts based on field_mappings_attributes conditions"
},
"resolve_state": {
"type": "string",
"description": "This value is matched with the value extracted from alerts payload using JSON path in field_mappings_attributes",
"nullable": true
},
"accept_threaded_emails": {
"type": "boolean",
"description": "Set this to false to reject threaded emails"
},
"field_mappings_attributes": {
"type": "array",
"description": "Specify rules to auto resolve alerts",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "Select the field on which the condition to be evaluated",
"enum": [
"external_id",
"state",
"alert_title",
"alert_description",
"alert_external_url",
"notification_target_type",
"notification_target_id"
]
},
"json_path": {
"type": "string",
"description": "JSON path expression to extract a specific value from the alert's payload for evaluation. For `notification_target_id` only: if your account has opted in to Dynamic Notification Targets, this may also be a Liquid template that resolves to a notification target id at routing time."
}
}
}
}
},
"nullable": true
},
"resolution_rule_attributes": {
"type": "object",
"description": "Provide additional attributes for email alerts source",
"properties": {
"enabled": {
"type": "boolean",
"description": "Set this to true to enable the auto resolution rule"
},
"condition_type": {
"type": "string",
"description": "The type of condition to evaluate to apply auto resolution rule",
"enum": [
"all",
"any"
]
},
"identifier_matchable_type": {
"type": "string",
"description": "The type of the identifier matchable",
"enum": [
"AlertField"
],
"nullable": true
},
"identifier_matchable_id": {
"type": "string",
"description": "The ID of the identifier matchable. If identifier_matchable_type is AlertField, this is the ID of the alert field.",
"nullable": true
},
"identifier_reference_kind": {
"type": "string",
"description": "The kind of the identifier reference",
"enum": [
"payload",
"alert_field"
]
},
"identifier_json_path": {
"type": "string",
"description": "JSON path expression to extract unique alert identifier used to match triggered alerts with resolving alerts",
"nullable": true
},
"identifier_value_regex": {
"type": "string",
"description": "Regex group to further specify the part of the string used as a unique identifier",
"nullable": true
},
"conditions_attributes": {
"type": "array",
"description": "List of conditions to evaluate for auto resolution",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "JSON path expression to extract a specific value from the alert's payload for evaluation",
"nullable": true
},
"operator": {
"type": "string",
"description": "Comparison operator used to evaluate the extracted value against the specified condition",
"enum": [
"is",
"is_not",
"contains",
"does_not_contain",
"starts_with",
"ends_with"
]
},
"value": {
"type": "string",
"description": "Value that the extracted payload data is compared to using the specified operator to determine a match"
},
"conditionable_type": {
"type": "string",
"description": "The type of the conditionable",
"enum": [
"AlertField"
],
"nullable": true
},
"conditionable_id": {
"type": "string",
"description": "The ID of the conditionable. If conditionable_type is AlertField, this is the ID of the alert field.",
"nullable": true
},
"kind": {
"type": "string",
"description": "The kind of the conditionable",
"enum": [
"payload",
"alert_field"
]
}
}
}
}
},
"nullable": true
},
"alert_source_fields_attributes": {
"type": "array",
"description": "List of alert fields to be added to the alert source. Note: This attribute requires the alert field feature to be enabled on your account. Contact Rootly customer support if you need assistance with this feature.",
"items": {
"type": "object",
"properties": {
"alert_field_id": {
"type": "string",
"description": "The ID of the alert field"
},
"template_body": {
"type": "string",
"description": "Liquid expression to extract a specific value from the alert's payload for evaluation",
"nullable": true
}
}
}
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"alerts_source": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the alert source"
},
"enabled": {
"type": "boolean",
"description": "Whether the alert source is enabled. Disabled sources do not create alerts from incoming events."
},
"source_type": {
"type": "string",
"description": "The alert source type",
"enum": [
"email",
"app_dynamics",
"catchpoint",
"cloudflare",
"datadog",
"dynatrace",
"alertmanager",
"google_cloud",
"grafana",
"sentry",
"generic_webhook",
"cloud_watch",
"aws_sns",
"checkly",
"azure",
"new_relic",
"splunk",
"chronosphere",
"app_optics",
"bug_snag",
"honeycomb",
"monte_carlo",
"nagios",
"prtg"
]
},
"alert_urgency_id": {
"type": "string",
"description": "ID for the default alert urgency assigned to this alert source"
},
"deduplicate_alerts_by_key": {
"type": "boolean",
"description": "Toggle alert deduplication using deduplication key. If enabled, deduplication_key_kind and deduplication_key_path are required."
},
"deduplication_key_kind": {
"type": "string",
"description": "Kind of deduplication key.",
"enum": [
"payload"
]
},
"deduplication_key_path": {
"type": "string",
"description": "Path to deduplication key. This is a JSON Path to extract the deduplication key from the request body.",
"nullable": true
},
"deduplication_key_regexp": {
"type": "string",
"description": "Regular expression to extract key from value found at key path.",
"nullable": true
},
"owner_group_ids": {
"type": "array",
"description": "List of team IDs that will own the alert source",
"items": {
"type": "string"
}
},
"alert_template_attributes": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The alert title.",
"nullable": true
},
"description": {
"type": "string",
"description": "The alert description.",
"nullable": true
},
"external_url": {
"type": "string",
"description": "The alert URL.",
"nullable": true
}
},
"nullable": true
},
"alert_source_urgency_rules_attributes": {
"type": "array",
"description": "List of rules that define the conditions under which the alert urgency will be set automatically based on the alert payload",
"items": {
"type": "object",
"properties": {
"json_path": {
"type": "string",
"description": "JSON path expression to extract a specific value from the alert's payload for evaluation",
"nullable": true
},
"operator": {
"type": "string",
"description": "Comparison operator used to evaluate the extracted value against the specified condition",
"enum": [
"is",
"is_not",
"contains",
"does_not_contain"
]
},
"value": {
"type": "string",
"description": "Value that the extracted payload data is compared to using the specified operator to determine a match"
},
"conditionable_type": {
"type": "string",
"description": "The type of the conditionable",
"enum": [
"AlertField"
],
"nullable": true
},
"conditionable_id": {
"type": "string",
"description": "The ID of the conditionable. If conditionable_type is AlertField, this is the ID of the alert field.",
"nullable": true
},
"kind": {
"type": "string",
"description": "The kind of the conditionable",
"enum": [
"payload",
"alert_field"
]
},
"alert_urgency_id": {
"type": "string",
"description": "The ID of the alert urgency"
}
}
}
},
"sourceable_attributes": {
"type": "object",
"description": "Provide additional attributes for generic_webhook alerts source",
"properties": {
"auto_resolve": {
"type": "boolean",
"description": "Set this to true to auto-resolve alerts based on field_mappings_attributes conditions"
},
"resolve_state": {
"type": "string",
"description": "This value is matched with the value extracted from alerts payload using JSON path in field_mappings_attributes",
"nullable": true
},
"accept_threaded_emails": {
"type": "boolean",
"description": "Set this to false to reject threaded emails"
},
"field_mappings_attributes": {
"type": "array",
"description": "Specify rules to auto resolve alerts",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "Select the field on which the condition to be evaluated",
"enum": [
"external_id",
"state",
"alert_title",
"alert_description",
"alert_external_url",
"notification_target_type",
"notification_target_id"
]
},
"json_path": {
"type": "string",
"description": "JSON path expression to extract a specific value from the alert's payload for evaluation. For `notification_target_id` only: if your account has opted in to Dynamic Notification Targets, this may also be a Liquid template that resolves to a notification target id at routing time."
}
}
}
}
},
"nullable": true
},
"resolution_rule_attributes": {
"type": "object",
"description": "Provide additional attributes for email alerts source",
"properties": {
"enabled": {
"type": "boolean",
"description": "Set this to true to enable the auto resolution rule"
},
"condition_type": {
"type": "string",
"description": "The type of condition to evaluate to apply auto resolution rule",
"enum": [
"all",
"any"
]
},
"identifier_matchable_type": {
"type": "string",
"description": "The type of the identifier matchable",
"enum": [
"AlertField"
],
"nullable": true
},
"identifier_matchable_id": {
"type": "string",
"description": "The ID of the identifier matchable. If identifier_matchable_type is AlertField, this is the ID of the alert field.",
"nullable": true
},
"identifier_reference_kind": {
"type": "string",
"description": "The kind of the identifier reference",
"enum": [
"payload",
"alert_field"
]
},
"identifier_json_path": {
"type": "string",
"description": "JSON path expression to extract unique alert identifier used to match triggered alerts with resolving alerts",
"nullable": true
},
"identifier_value_regex": {
"type": "string",
"description": "Regex group to further specify the part of the string used as a unique identifier",
"nullable": true
},
"conditions_attributes": {
"type": "array",
"description": "List of conditions to evaluate for auto resolution",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "JSON path expression to extract a specific value from the alert's payload for evaluation",
"nullable": true
},
"operator": {
"type": "string",
"description": "Comparison operator used to evaluate the extracted value against the specified condition",
"enum": [
"is",
"is_not",
"contains",
"does_not_contain",
"starts_with",
"ends_with"
]
},
"value": {
"type": "string",
"description": "Value that the extracted payload data is compared to using the specified operator to determine a match"
},
"conditionable_type": {
"type": "string",
"description": "The type of the conditionable",
"enum": [
"AlertField"
],
"nullable": true
},
"conditionable_id": {
"type": "string",
"description": "The ID of the conditionable. If conditionable_type is AlertField, this is the ID of the alert field.",
"nullable": true
},
"kind": {
"type": "string",
"description": "The kind of the conditionable",
"enum": [
"payload",
"alert_field"
]
}
}
}
}
},
"nullable": true
},
"alert_source_fields_attributes": {
"type": "array",
"description": "List of alert fields to be added to the alert source. Note: This attribute requires the alert field feature to be enabled on your account. Contact Rootly customer support if you need assistance with this feature.",
"items": {
"type": "object",
"properties": {
"alert_field_id": {
"type": "string",
"description": "The ID of the alert field"
},
"template_body": {
"type": "string",
"description": "Liquid expression to extract a specific value from the alert's payload for evaluation",
"nullable": true
}
}
}
},
"status": {
"type": "string",
"description": "The status of the alert source",
"enum": [
"connected",
"setup_complete",
"setup_incomplete"
]
},
"secret": {
"type": "string",
"description": "The secret used to authenticate non-email alert sources"
},
"email": {
"type": "string",
"description": "The email generated for email alert sources",
"nullable": true
},
"webhook_endpoint": {
"type": "string",
"description": "The webhook URL generated for non-email alert sources",
"nullable": true
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"name",
"status",
"secret",
"created_at",
"updated_at"
]
},
"alerts_source_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the alert source"
},
"type": {
"type": "string",
"enum": [
"alert_sources"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/alerts_source"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"alerts_source_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the alert source"
},
"type": {
"type": "string",
"enum": [
"alert_sources"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/alerts_source"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_alert_route": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"alert_routes"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the alert route"
},
"enabled": {
"type": "boolean",
"description": "Whether the alert route is enabled"
},
"alerts_source_ids": {
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"description": "The ID of the alerts source"
}
},
"owning_team_ids": {
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"description": "The ID of the owning team"
}
},
"rules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the alert routing rule"
},
"position": {
"type": "integer",
"description": "The position of the alert routing rule for ordering evaluation"
},
"fallback_rule": {
"type": "boolean",
"description": "Whether this is a fallback rule",
"default": false
},
"destinations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"target_type": {
"type": "string",
"enum": [
"Service",
"Group",
"Functionality",
"EscalationPolicy"
],
"description": "The type of the target. Please contact support if you encounter issues using `Functionality` as a target type."
},
"target_id": {
"type": "string",
"format": "uuid",
"description": "The ID of the target"
}
},
"required": [
"target_type",
"target_id"
]
}
},
"condition_groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"position": {
"type": "integer",
"description": "The position of the condition group"
},
"conditions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"property_field_condition_type": {
"type": "string",
"enum": [
"is_one_of",
"is_not_one_of",
"contains",
"does_not_contain",
"starts_with",
"ends_with",
"matches_regex",
"is_empty"
]
},
"property_field_name": {
"type": "string",
"description": "The name of the property field"
},
"property_field_type": {
"type": "string",
"enum": [
"attribute",
"payload",
"alert_field"
]
},
"property_field_value": {
"type": "string",
"description": "The value of the property field",
"nullable": true
},
"property_field_values": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"alert_urgency_ids": {
"type": "array",
"description": "The Alert Urgency IDs to check in the condition",
"items": {
"type": "string"
},
"nullable": true
},
"conditionable_type": {
"type": "string",
"description": "The type of the conditionable",
"enum": [
"AlertField"
],
"nullable": true
},
"conditionable_id": {
"type": "string",
"format": "uuid",
"description": "The ID of the conditionable",
"nullable": true
}
},
"required": [
"property_field_condition_type",
"property_field_type"
]
}
}
},
"required": [
"conditions"
]
}
}
},
"required": [
"name",
"destinations",
"condition_groups"
]
}
}
},
"required": [
"name",
"alerts_source_ids"
]
}
}
}
}
},
"update_alert_route": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"alert_routes"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the alert route"
},
"enabled": {
"type": "boolean",
"description": "Whether the alert route is enabled"
},
"alerts_source_ids": {
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"description": "The ID of the alerts source"
}
},
"owning_team_ids": {
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"description": "The ID of the owning team"
}
},
"rules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the alert routing rule"
},
"position": {
"type": "integer",
"description": "The position of the alert routing rule for ordering evaluation"
},
"fallback_rule": {
"type": "boolean",
"description": "Whether this is a fallback rule",
"default": false
},
"destinations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"target_type": {
"type": "string",
"enum": [
"Service",
"Group",
"Functionality",
"EscalationPolicy"
],
"description": "The type of the target. Please contact support if you encounter issues using `Functionality` as a target type."
},
"target_id": {
"type": "string",
"format": "uuid",
"description": "The ID of the target"
}
},
"required": [
"target_type",
"target_id"
]
}
},
"condition_groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"position": {
"type": "integer",
"description": "The position of the condition group"
},
"conditions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"property_field_condition_type": {
"type": "string",
"enum": [
"is_one_of",
"is_not_one_of",
"contains",
"does_not_contain",
"starts_with",
"ends_with",
"matches_regex",
"is_empty"
]
},
"property_field_name": {
"type": "string",
"description": "The name of the property field"
},
"property_field_type": {
"type": "string",
"enum": [
"attribute",
"payload",
"alert_field"
]
},
"property_field_value": {
"type": "string",
"description": "The value of the property field",
"nullable": true
},
"property_field_values": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"alert_urgency_ids": {
"type": "array",
"description": "The Alert Urgency IDs to check in the condition",
"items": {
"type": "string"
},
"nullable": true
},
"conditionable_type": {
"type": "string",
"description": "The type of the conditionable",
"enum": [
"AlertField"
],
"nullable": true
},
"conditionable_id": {
"type": "string",
"format": "uuid",
"description": "The ID of the conditionable",
"nullable": true
}
},
"required": [
"property_field_condition_type",
"property_field_type"
]
}
}
},
"required": [
"conditions"
]
}
}
},
"required": [
"name",
"destinations",
"condition_groups"
]
}
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"patch_alert_route": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"alert_routes"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the alert route"
},
"enabled": {
"type": "boolean",
"description": "Whether the alert route is enabled"
},
"alerts_source_ids": {
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"description": "The ID of the alerts source"
}
},
"owning_team_ids": {
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"description": "The ID of the owning team"
}
},
"rules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The ID of the alert routing rule. Required for updating or deleting existing rules."
},
"_destroy": {
"type": "boolean",
"description": "Set to true to delete this rule. When true, only the id field is required."
},
"name": {
"type": "string",
"description": "The name of the alert routing rule"
},
"position": {
"type": "integer",
"description": "The position of the alert routing rule for ordering evaluation"
},
"fallback_rule": {
"type": "boolean",
"description": "Whether this is a fallback rule",
"default": false
},
"destinations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The ID of the destination. Required for updating or deleting existing destinations."
},
"_destroy": {
"type": "boolean",
"description": "Set to true to delete this destination"
},
"target_type": {
"type": "string",
"enum": [
"Service",
"Group",
"Functionality",
"EscalationPolicy"
],
"description": "The type of the target. Please contact support if you encounter issues using `Functionality` as a target type."
},
"target_id": {
"type": "string",
"format": "uuid",
"description": "The ID of the target"
}
}
}
},
"condition_groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The ID of the condition group. Required for updating or deleting existing condition groups."
},
"_destroy": {
"type": "boolean",
"description": "Set to true to delete this condition group"
},
"position": {
"type": "integer",
"description": "The position of the condition group"
},
"conditions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The ID of the condition. Required for updating or deleting existing conditions."
},
"_destroy": {
"type": "boolean",
"description": "Set to true to delete this condition"
},
"property_field_condition_type": {
"type": "string",
"enum": [
"is_one_of",
"is_not_one_of",
"contains",
"does_not_contain",
"starts_with",
"ends_with",
"matches_regex",
"is_empty"
]
},
"property_field_name": {
"type": "string",
"description": "The name of the property field"
},
"property_field_type": {
"type": "string",
"enum": [
"attribute",
"payload",
"alert_field"
]
},
"property_field_value": {
"type": "string",
"description": "The value of the property field",
"nullable": true
},
"property_field_values": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"alert_urgency_ids": {
"type": "array",
"description": "The Alert Urgency IDs to check in the condition",
"items": {
"type": "string"
},
"nullable": true
},
"conditionable_type": {
"type": "string",
"description": "The type of the conditionable",
"enum": [
"AlertField"
],
"nullable": true
},
"conditionable_id": {
"type": "string",
"format": "uuid",
"description": "The ID of the conditionable",
"nullable": true
}
}
}
}
}
}
}
}
}
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"alert_route": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the alert route"
},
"enabled": {
"type": "boolean",
"description": "Whether the alert route is enabled"
},
"alerts_source_ids": {
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"description": "The ID of the alerts source"
}
},
"owning_team_ids": {
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"description": "The ID of the owning team"
}
},
"rules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the alert routing rule"
},
"position": {
"type": "integer",
"description": "The position of the alert routing rule for ordering evaluation"
},
"fallback_rule": {
"type": "boolean",
"description": "Whether this is a fallback rule",
"default": false
},
"destinations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"target_type": {
"type": "string",
"enum": [
"Service",
"Group",
"Functionality",
"EscalationPolicy"
],
"description": "The type of the target. Please contact support if you encounter issues using `Functionality` as a target type."
},
"target_id": {
"type": "string",
"format": "uuid",
"description": "The ID of the target"
}
},
"required": [
"target_type",
"target_id"
]
}
},
"condition_groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"position": {
"type": "integer",
"description": "The position of the condition group"
},
"conditions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"property_field_condition_type": {
"type": "string",
"enum": [
"is_one_of",
"is_not_one_of",
"contains",
"does_not_contain",
"starts_with",
"ends_with",
"matches_regex",
"is_empty"
]
},
"property_field_name": {
"type": "string",
"description": "The name of the property field"
},
"property_field_type": {
"type": "string",
"enum": [
"attribute",
"payload",
"alert_field"
]
},
"property_field_value": {
"type": "string",
"description": "The value of the property field",
"nullable": true
},
"property_field_values": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"alert_urgency_ids": {
"type": "array",
"description": "The Alert Urgency IDs to check in the condition",
"items": {
"type": "string"
},
"nullable": true
},
"conditionable_type": {
"type": "string",
"description": "The type of the conditionable",
"enum": [
"AlertField"
],
"nullable": true
},
"conditionable_id": {
"type": "string",
"format": "uuid",
"description": "The ID of the conditionable",
"nullable": true
}
},
"required": [
"property_field_condition_type",
"property_field_type"
]
}
}
},
"required": [
"conditions"
]
}
}
},
"required": [
"name",
"destinations",
"condition_groups"
]
}
}
},
"required": [
"name",
"alerts_source_ids"
]
},
"alert_route_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the alert route"
},
"type": {
"type": "string",
"enum": [
"alert_routes"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/alert_route"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"alert_route_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the alert route"
},
"type": {
"type": "string",
"enum": [
"alert_routes"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/alert_route"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_alert_routing_rule": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"alert_routing_rules"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the alert routing rule"
},
"enabled": {
"type": "boolean",
"description": "Whether the alert routing rule is enabled"
},
"owning_team_ids": {
"type": "array",
"description": "The IDs of the teams which own the alert routing rule. If the user doesn't have Alert Routing Create Permission in On-Call Roles, then this field is required and can contain Team IDs the user is an admin of.",
"items": {
"type": "string",
"format": "uuid"
}
},
"alerts_source_id": {
"type": "string",
"format": "uuid",
"description": "The ID of the alerts source"
},
"position": {
"type": "integer",
"description": "The position of the alert routing rule for ordering evaluation"
},
"condition_type": {
"type": "string",
"description": "The type of condition for the alert routing rule",
"enum": [
"all",
"any"
]
},
"conditions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"property_field_type": {
"type": "string",
"description": "The type of the property field",
"enum": [
"attribute",
"payload"
]
},
"property_field_name": {
"type": "string",
"description": "The name of the property field. If the property field type is selected as 'attribute', then the allowed property field names are 'summary' (for Title), 'description', 'alert_urgency' and 'external_url' (for Alert Source URL). If the property field type is selected as 'payload', then the property field name should be supplied in JSON Path syntax."
},
"property_field_condition_type": {
"type": "string",
"description": "The condition type of the property field",
"enum": [
"is_one_of",
"is_not_one_of",
"contains",
"does_not_contain",
"starts_with",
"ends_with",
"matches_regex",
"is_empty"
]
},
"property_field_value": {
"type": "string",
"description": "The value of the property field. Can be null if the property field condition type is 'is_one_of' or 'is_not_one_of'"
},
"property_field_values": {
"type": "array",
"description": "The values of the property field. Need to be passed if the property field condition type is 'is_one_of' or 'is_not_one_of' except for when property field name is 'alert_urgency'",
"items": {
"type": "string"
}
}
},
"required": [
"property_field_type",
"property_field_name",
"property_field_condition_type"
]
}
},
"destination": {
"type": "object",
"properties": {
"target_type": {
"type": "string",
"description": "The type of the target. Please contact support if you encounter issues using `Functionality` as a target type.",
"enum": [
"Service",
"Group",
"Functionality",
"EscalationPolicy"
]
},
"target_id": {
"type": "string",
"format": "uuid",
"description": "The ID of the target"
}
},
"required": [
"target_type",
"target_id"
]
}
},
"additionalProperties": false,
"required": [
"name",
"alerts_source_id",
"destination"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_alert_routing_rule": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"alert_routing_rules"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the alert routing rule"
},
"enabled": {
"type": "boolean",
"description": "Whether the alert routing rule is enabled"
},
"alerts_source_id": {
"type": "string",
"format": "uuid",
"description": "The ID of the alerts source"
},
"position": {
"type": "integer",
"description": "The position of the alert routing rule for ordering evaluation"
},
"owning_team_ids": {
"type": "array",
"description": "The IDs of the teams that own the alert routing rule",
"items": {
"type": "string",
"format": "uuid"
}
},
"condition_type": {
"type": "string",
"description": "The type of condition for the alert routing rule",
"enum": [
"all",
"any"
]
},
"conditions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The ID of the alert routing rule condition"
},
"property_field_type": {
"type": "string",
"description": "The type of the property field",
"enum": [
"attribute",
"payload"
]
},
"property_field_name": {
"type": "string",
"description": "The name of the property field. If the property field type is selected as 'attribute', then the allowed property field names are 'summary' (for Title), 'description', 'alert_urgency' and 'external_url' (for Alert Source URL). If the property field type is selected as 'payload', then the property field name should be supplied in JSON Path syntax."
},
"property_field_condition_type": {
"type": "string",
"description": "The condition type of the property field",
"enum": [
"is_one_of",
"is_not_one_of",
"contains",
"does_not_contain",
"starts_with",
"ends_with",
"matches_regex",
"is_empty"
]
},
"property_field_value": {
"type": "string",
"description": "The value of the property field. Can be null if the property field condition type is 'is_one_of' or 'is_not_one_of'",
"nullable": true
},
"property_field_values": {
"type": "array",
"description": "The values of the property field. Used if the property field condition type is 'is_one_of' or 'is_not_one_of' except for when property field name is 'alert_urgency'",
"items": {
"type": "string"
}
}
}
}
},
"destination": {
"type": "object",
"properties": {
"target_type": {
"type": "string",
"description": "The type of the target. Please contact support if you encounter issues using `Functionality` as a target type.",
"enum": [
"Service",
"Group",
"Functionality",
"EscalationPolicy"
]
},
"target_id": {
"type": "string",
"format": "uuid",
"description": "The ID of the target"
}
}
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"alert_routing_rule": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the alert routing rule"
},
"enabled": {
"type": "boolean",
"description": "Whether the alert routing rule is enabled"
},
"alerts_source_id": {
"type": "string",
"format": "uuid",
"description": "The ID of the alerts source"
},
"position": {
"type": "integer",
"description": "The position of the alert routing rule for ordering evaluation"
},
"condition_type": {
"type": "string",
"description": "The type of condition for the alert routing rule",
"enum": [
"all",
"any"
]
},
"conditions": {
"type": "array",
"description": "The conditions for the alert routing rule",
"items": {
"type": "object",
"properties": {
"property_field_type": {
"type": "string",
"description": "The type of the property field",
"enum": [
"attribute",
"payload"
]
},
"property_field_name": {
"type": "string",
"description": "The name of the property field. If the property field type is selected as 'attribute', then the allowed property field names are 'summary' (for Title), 'description', 'alert_urgency' and 'external_url' (for Alert Source URL). If the property field type is selected as 'payload', then the property field name should be supplied in JSON Path syntax."
},
"property_field_condition_type": {
"type": "string",
"description": "The condition type of the property field",
"enum": [
"is_one_of",
"is_not_one_of",
"contains",
"does_not_contain",
"starts_with",
"ends_with",
"matches_regex",
"is_empty"
]
},
"property_field_value": {
"type": "string",
"description": "The value of the property field. Can be null if the property field condition type is 'is_one_of' or 'is_not_one_of'",
"nullable": true
},
"property_field_values": {
"type": "array",
"description": "The values of the property field. Used if the property field condition type is 'is_one_of' or 'is_not_one_of' except for when property field name is 'alert_urgency'",
"items": {
"type": "string"
}
}
},
"required": [
"property_field_type",
"property_field_name",
"property_field_condition_type"
]
}
},
"destination": {
"type": "object",
"description": "The destinations for the alert routing rule",
"nullable": true,
"properties": {
"target_type": {
"type": "string",
"description": "The type of the target. Please contact support if you encounter issues using `Functionality` as a target type.",
"enum": [
"Service",
"Group",
"Functionality",
"EscalationPolicy"
]
},
"target_id": {
"type": "string",
"format": "uuid",
"description": "The ID of the target"
}
},
"required": [
"target_type",
"target_id"
]
},
"condition_groups": {
"type": "array",
"description": "The condition groups for the alert routing rule",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique ID of the condition group"
},
"position": {
"type": "integer",
"description": "The position of the condition group for ordering"
},
"conditions": {
"type": "array",
"description": "The conditions within this group",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique ID of the condition"
},
"property_field_type": {
"type": "string",
"description": "The type of the property field",
"enum": [
"attribute",
"payload"
]
},
"property_field_name": {
"type": "string",
"description": "The name of the property field"
},
"property_field_condition_type": {
"type": "string",
"description": "The condition type of the property field",
"enum": [
"is_one_of",
"is_not_one_of",
"contains",
"does_not_contain",
"starts_with",
"ends_with",
"matches_regex",
"is_empty"
]
},
"property_field_value": {
"type": "string",
"description": "The value of the property field",
"nullable": true
},
"property_field_values": {
"type": "array",
"description": "The values of the property field",
"items": {
"type": "string"
},
"nullable": true
},
"conditionable_id": {
"type": "string",
"format": "uuid",
"description": "The ID of the conditionable object",
"nullable": true
},
"conditionable_type": {
"type": "string",
"description": "The type of the conditionable object",
"nullable": true
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"property_field_type",
"property_field_name",
"property_field_condition_type"
]
}
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"position"
]
}
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"name",
"enabled",
"alerts_source_id",
"position",
"condition_type",
"created_at",
"updated_at"
]
},
"alert_routing_rule_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the alert_routing_rule"
},
"type": {
"type": "string",
"enum": [
"alert_routing_rules"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/alert_routing_rule"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"alert_routing_rule_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the alert_routing_rule"
},
"type": {
"type": "string",
"enum": [
"alert_routing_rules"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/alert_routing_rule"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"alert_routing_rule_target": {
"type": "object",
"description": "The destination target for the alert routing rule",
"nullable": true,
"properties": {
"target_type": {
"type": "string",
"description": "The type of the target. Please contact support if you encounter issues using `Functionality` as a target type.",
"enum": [
"Service",
"Group",
"Functionality",
"EscalationPolicy"
]
},
"target_id": {
"type": "string",
"format": "uuid",
"description": "The ID of the target"
}
},
"required": [
"target_type",
"target_id"
]
},
"alert_routing_rule_condition": {
"type": "object",
"description": "A condition for alert routing rule",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique ID of the condition"
},
"property_field_type": {
"type": "string",
"description": "The type of the property field",
"enum": [
"attribute",
"payload"
]
},
"property_field_name": {
"type": "string",
"description": "The name of the property field"
},
"property_field_condition_type": {
"type": "string",
"description": "The condition type of the property field",
"enum": [
"is_one_of",
"is_not_one_of",
"contains",
"does_not_contain",
"starts_with",
"ends_with",
"matches_regex",
"is_empty"
]
},
"property_field_value": {
"type": "string",
"description": "The value of the property field",
"nullable": true
},
"property_field_values": {
"type": "array",
"description": "The values of the property field",
"items": {
"type": "string"
},
"nullable": true
},
"conditionable_id": {
"type": "string",
"format": "uuid",
"description": "The ID of the conditionable object",
"nullable": true
},
"conditionable_type": {
"type": "string",
"description": "The type of the conditionable object",
"nullable": true
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"property_field_type",
"property_field_name",
"property_field_condition_type"
]
},
"alert_routing_rule_condition_group": {
"type": "object",
"description": "A group of conditions for alert routing rule",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique ID of the condition group"
},
"position": {
"type": "integer",
"description": "The position of the condition group for ordering"
},
"conditions": {
"type": "array",
"description": "The conditions within this group",
"items": {
"$ref": "#/components/schemas/alert_routing_rule_condition"
}
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"position"
]
},
"new_alert_field": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"alert_fields"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the alert field"
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_alert_field": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"alert_fields"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the alert field"
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"alert_field": {
"type": "object",
"properties": {
"slug": {
"type": "string",
"description": "The slug of the alert field"
},
"name": {
"type": "string",
"description": "The name of the alert field"
},
"kind": {
"type": "string",
"description": "The kind of alert field"
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"name",
"kind",
"created_at",
"updated_at"
]
},
"alert_field_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the alert field"
},
"type": {
"type": "string",
"enum": [
"alert_fields"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/alert_field"
}
]
}
},
"required": [
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"alert_field_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the alert field"
},
"type": {
"type": "string",
"enum": [
"alert_fields"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/alert_field"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_alert_urgency": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"alert_urgencies"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the alert urgency"
},
"description": {
"type": "string",
"description": "The description of the alert urgency"
},
"position": {
"type": "integer",
"description": "Position of the alert urgency",
"nullable": true
}
},
"additionalProperties": false,
"required": [
"name",
"description"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_alert_urgency": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"alert_urgencies"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the alert urgency"
},
"description": {
"type": "string",
"description": "The description of the alert urgency"
},
"position": {
"type": "integer",
"description": "Position of the alert urgency",
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"alert_urgency": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the alert urgency"
},
"name": {
"type": "string",
"description": "The name of the alert urgency"
},
"description": {
"type": "string",
"description": "The description of the alert urgency"
},
"position": {
"type": "integer",
"description": "Position of the alert urgency"
},
"urgency": {
"type": "string",
"description": "The urgency level",
"nullable": true
},
"color": {
"type": "string",
"description": "The color associated with this urgency level",
"nullable": true
},
"team_id": {
"type": "integer",
"description": "The ID of the team this urgency belongs to"
},
"deleted_at": {
"type": "string",
"description": "Date of deletion",
"nullable": true
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"name",
"description",
"position",
"created_at",
"updated_at"
]
},
"alert_urgency_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the alert urgency"
},
"type": {
"type": "string",
"enum": [
"alert_urgencies"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/alert_urgency"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"alert_urgency_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the alert urgency"
},
"type": {
"type": "string",
"enum": [
"alert_urgencies"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/alert_urgency"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_alert_group": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"alert_groups"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the alert group"
},
"description": {
"type": "string",
"description": "The description of the alert urgency",
"nullable": true
},
"time_window": {
"type": "integer",
"description": "The length of time an Alert Group should stay open and accept new alerts"
},
"targets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"target_type": {
"type": "string",
"description": "The type of the target. Please contact support if you encounter issues using `Functionality` as a target type.",
"enum": [
"Group",
"Service",
"EscalationPolicy",
"Functionality"
]
},
"target_id": {
"type": "string",
"format": "uuid",
"description": "id for the Group, Service, EscalationPolicy or Functionality"
}
},
"required": [
"target_type",
"target_id"
]
}
},
"attributes": {
"deprecated": true,
"description": "This field is deprecated. Please use the `conditions` field instead, `attributes` will be removed in the future.",
"type": "array",
"items": {
"type": "object",
"properties": {
"json_path": {
"type": "string",
"description": "The JSON path to the value to group by."
}
}
}
},
"group_by_alert_title": {
"type": "integer",
"enum": [
1,
0
],
"deprecated": true,
"description": "[DEPRECATED] Whether the alerts should be grouped by titles. This field is deprecated. Please use the `conditions` field with advanced alert grouping instead."
},
"group_by_alert_urgency": {
"type": "integer",
"enum": [
1,
0
],
"deprecated": true,
"description": "[DEPRECATED] Whether the alerts should be grouped by urgencies. This field is deprecated. Please use the `conditions` field with advanced alert grouping instead."
},
"condition_type": {
"type": "string",
"enum": [
"all",
"any"
],
"description": "Group alerts when ANY or ALL of the fields are matching."
},
"conditions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"property_field_type": {
"type": "string",
"description": "The type of the property field",
"enum": [
"attribute",
"payload",
"alert_field"
]
},
"property_field_name": {
"type": "string",
"description": "The name of the property field. If the property field type is selected as 'attribute', then the allowed property field names are 'summary' (for Title), 'description', 'alert_urgency' and 'external_url' (for Alert Source URL). If the property field type is selected as 'payload', then the property field name should be supplied in JSON Path syntax."
},
"property_field_condition_type": {
"type": "string",
"description": "The condition type of the property field",
"enum": [
"is_one_of",
"is_not_one_of",
"contains",
"does_not_contain",
"starts_with",
"ends_with",
"matches_regex",
"is_empty",
"matches_existing_alert"
]
},
"property_field_value": {
"type": "string",
"description": "The value of the property field. Can be null if the property field condition type is 'is_one_of' or 'is_not_one_of'"
},
"property_field_values": {
"type": "array",
"description": "The values of the property field. Need to be passed if the property field condition type is 'is_one_of' or 'is_not_one_of' except for when property field name is 'alert_urgency'",
"items": {
"type": "string"
}
},
"alert_urgency_ids": {
"type": "array",
"description": "The Alert Urgency IDs to check in the condition. Only need to be set when the property field type is 'attribute', the property field name is 'alert_urgency' and the property field condition type is 'is_one_of' or 'is_not_one_of'",
"items": {
"type": "string"
},
"nullable": true
},
"conditionable_type": {
"type": "string",
"description": "The type of the conditionable",
"enum": [
"AlertField"
]
},
"conditionable_id": {
"type": "string",
"description": "The ID of the conditionable. If conditionable_type is AlertField, this is the ID of the alert field."
}
},
"required": [
"property_field_type",
"property_field_condition_type"
]
}
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_alert_group": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"alert_groups"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the alert group"
},
"description": {
"type": "string",
"description": "The description of the alert group",
"nullable": true
},
"time_window": {
"type": "integer",
"description": "The length of time an Alert Group should stay open and accept new alerts"
},
"targets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"target_type": {
"type": "string",
"description": "The type of the target. Please contact support if you encounter issues using `Functionality` as a target type.",
"enum": [
"Group",
"Service",
"EscalationPolicy",
"Functionality"
]
},
"target_id": {
"type": "string",
"format": "uuid",
"description": "id for the Group, Service, EscalationPolicy or Functionality"
}
},
"required": [
"target_type",
"target_id"
]
}
},
"attributes": {
"deprecated": true,
"description": "This field is deprecated. Please use the `conditions` field instead, `attributes` will be removed in the future.",
"type": "array",
"items": {
"type": "object",
"properties": {
"json_path": {
"type": "string",
"description": "The JSON path to the value to group by."
}
}
}
},
"group_by_alert_title": {
"type": "integer",
"enum": [
1,
0
],
"deprecated": true,
"description": "[DEPRECATED] Whether the alerts should be grouped by titles. This field is deprecated. Please use the `conditions` field with advanced alert grouping instead."
},
"group_by_alert_urgency": {
"type": "integer",
"enum": [
1,
0
],
"deprecated": true,
"description": "[DEPRECATED] Whether the alerts should be grouped by urgencies. This field is deprecated. Please use the `conditions` field with advanced alert grouping instead."
},
"condition_type": {
"type": "string",
"enum": [
"all",
"any"
],
"description": "Group alerts when ANY or ALL of the fields are matching."
},
"conditions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"property_field_type": {
"type": "string",
"description": "The type of the property field",
"enum": [
"attribute",
"payload",
"alert_field"
]
},
"property_field_name": {
"type": "string",
"description": "The name of the property field. If the property field type is selected as 'attribute', then the allowed property field names are 'summary' (for Title), 'description', 'alert_urgency' and 'external_url' (for Alert Source URL). If the property field type is selected as 'payload', then the property field name should be supplied in JSON Path syntax."
},
"property_field_condition_type": {
"type": "string",
"description": "The condition type of the property field",
"enum": [
"is_one_of",
"is_not_one_of",
"contains",
"does_not_contain",
"starts_with",
"ends_with",
"matches_regex",
"is_empty",
"matches_existing_alert"
]
},
"property_field_value": {
"type": "string",
"description": "The value of the property field. Can be null if the property field condition type is 'is_one_of' or 'is_not_one_of'"
},
"property_field_values": {
"type": "array",
"description": "The values of the property field. Need to be passed if the property field condition type is 'is_one_of' or 'is_not_one_of' except for when property field name is 'alert_urgency'",
"items": {
"type": "string"
}
},
"alert_urgency_ids": {
"type": "array",
"description": "The Alert Urgency IDs to check in the condition. Only need to be set when the property field type is 'attribute', the property field name is 'alert_urgency' and the property field condition type is 'is_one_of' or 'is_not_one_of'",
"items": {
"type": "string"
},
"nullable": true
},
"conditionable_type": {
"type": "string",
"description": "The type of the conditionable",
"enum": [
"AlertField"
]
},
"conditionable_id": {
"type": "string",
"description": "The ID of the conditionable. If conditionable_type is AlertField, this is the ID of the alert field."
}
},
"required": [
"property_field_type",
"property_field_condition_type"
]
}
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"alert_group": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the alert group"
},
"description": {
"type": "string",
"description": "The description of the alert group",
"nullable": true
},
"slug": {
"type": "string",
"description": "The slug of the alert group"
},
"condition_type": {
"type": "string",
"description": "Grouping condition for the alert group"
},
"time_window": {
"type": "integer",
"description": "Time window for the alert grouping"
},
"group_by_alert_title": {
"type": "boolean",
"deprecated": true,
"description": "[DEPRECATED] Whether the alerts are grouped by title or not. This field is deprecated. Please use the `conditions` field with advanced alert grouping instead."
},
"group_by_alert_urgency": {
"type": "boolean",
"deprecated": true,
"description": "[DEPRECATED] Whether the alerts are grouped by urgency or not. This field is deprecated. Please use the `conditions` field with advanced alert grouping instead."
},
"targets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"target_type": {
"type": "string",
"description": "The type of the target. Please contact support if you encounter issues using `Functionality` as a target type.",
"enum": [
"Group",
"Service",
"EscalationPolicy",
"Functionality"
]
},
"target_id": {
"type": "string",
"format": "uuid",
"description": "id for the Group, Service, EscalationPolicy or Functionality"
}
},
"required": [
"target_type",
"target_id"
]
}
},
"attributes": {
"deprecated": true,
"description": "This field is deprecated. Please use the `conditions` field instead, `attributes` will be removed in the future.",
"type": "array",
"items": {
"type": "object",
"properties": {
"json_path": {
"type": "string",
"description": "The JSON path to the value to group by."
}
}
}
},
"conditions": {
"type": "array",
"description": "The conditions for the alert group",
"items": {
"type": "object",
"properties": {
"property_field_type": {
"type": "string",
"description": "The type of the property field",
"enum": [
"attribute",
"payload",
"alert_field"
]
},
"property_field_name": {
"type": "string",
"nullable": true,
"description": "The name of the property field. If the property field type is selected as 'attribute', then the allowed property field names are 'summary' (for Title), 'description', 'alert_urgency' and 'external_url' (for Alert Source URL). If the property field type is selected as 'payload', then the property field name should be supplied in JSON Path syntax."
},
"property_field_condition_type": {
"type": "string",
"description": "The condition type of the property field",
"enum": [
"is_one_of",
"is_not_one_of",
"contains",
"does_not_contain",
"starts_with",
"ends_with",
"matches_regex",
"is_empty",
"matches_existing_alert"
]
},
"property_field_value": {
"type": "string",
"description": "The value of the property field. Can be null if the property field condition type is 'is_one_of' or 'is_not_one_of'",
"nullable": true
},
"property_field_values": {
"type": "array",
"description": "The values of the property field. Used if the property field condition type is 'is_one_of' or 'is_not_one_of' except for when property field name is 'alert_urgency'",
"items": {
"type": "string"
}
},
"values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"record_id": {
"type": "string",
"description": "ID of the Alert Urgency to set."
},
"record_type": {
"type": "string",
"description": "Should be \"AlertUrgency\"."
}
},
"required": [
"record_id",
"record_type"
],
"nullable": true
}
},
"alert_urgency_ids": {
"type": "array",
"description": "The Alert Urgency IDs to check in the condition. Only need to be set when the property field type is 'attribute', the property field name is 'alert_urgency' and the property field condition type is 'is_one_of' or 'is_not_one_of'",
"items": {
"type": "string"
},
"nullable": true
},
"conditionable_type": {
"type": "string",
"description": "The type of the conditionable",
"enum": [
"AlertField"
],
"nullable": true
},
"conditionable_id": {
"type": "string",
"description": "The ID of the conditionable. If conditionable_type is AlertField, this is the ID of the alert field.",
"nullable": true
}
},
"required": [
"property_field_type",
"property_field_condition_type"
]
}
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
},
"deleted_at": {
"type": "string",
"nullable": true,
"description": "Date or deletion"
}
},
"required": [
"name",
"description",
"created_at",
"updated_at",
"deleted_at",
"condition_type",
"time_window"
]
},
"alert_group_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the alert group"
},
"type": {
"type": "string",
"enum": [
"alert_groups"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/alert_group"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"alert_group_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the alert group"
},
"type": {
"type": "string",
"enum": [
"alert_groups"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/alert_group"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"new_api_key": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"api_keys"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the API key"
},
"description": {
"type": "string",
"description": "A description of the API key",
"nullable": true
},
"kind": {
"type": "string",
"description": "The kind of the API key",
"enum": [
"personal",
"team",
"organization"
]
},
"expires_at": {
"type": "string",
"description": "The expiration date of the API key (ISO 8601)",
"format": "date-time"
},
"group_id": {
"type": "string",
"description": "The group (team) ID. Required when kind is 'team'.",
"nullable": true
},
"role_id": {
"type": "string",
"description": "The role ID for organization API keys",
"nullable": true
},
"on_call_role_id": {
"type": "string",
"description": "The on-call role ID for organization API keys",
"nullable": true
}
},
"additionalProperties": false,
"required": [
"name",
"kind",
"expires_at"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_api_key": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"api_keys"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the API key"
},
"description": {
"type": "string",
"description": "A description of the API key",
"nullable": true
},
"expires_at": {
"type": "string",
"description": "The expiration date of the API key (ISO 8601)",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"rotate_api_key": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"api_keys"
]
},
"attributes": {
"type": "object",
"properties": {
"expires_at": {
"type": "string",
"description": "The new expiration date after rotation (ISO 8601)",
"format": "date-time",
"nullable": true
},
"grace_period_minutes": {
"type": "integer",
"description": "How many minutes to keep the old token valid. Only applies when the grace period feature is enabled for your organization. Defaults to 30.",
"minimum": 0,
"maximum": 1440,
"default": 30
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"api_key": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the API key"
},
"description": {
"type": "string",
"description": "A description of the API key",
"nullable": true
},
"kind": {
"type": "string",
"description": "The kind of the API key",
"enum": [
"personal",
"team",
"organization"
]
},
"role_id": {
"type": "string",
"description": "The role ID",
"nullable": true
},
"on_call_role_id": {
"type": "string",
"description": "The on-call role ID",
"nullable": true
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
},
"expires_at": {
"type": "string",
"description": "Expiration date",
"nullable": true
},
"last_used_at": {
"type": "string",
"description": "Date of last use",
"nullable": true
},
"grace_period_ends_at": {
"type": "string",
"description": "Grace period end date",
"nullable": true
}
},
"required": [
"name",
"kind",
"created_at",
"updated_at"
]
},
"api_key_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the API key"
},
"type": {
"type": "string",
"enum": [
"api_keys"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/api_key"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"api_key_with_token_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the API key"
},
"type": {
"type": "string",
"enum": [
"api_keys"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/api_key"
},
{
"type": "object",
"properties": {
"token": {
"type": "string",
"description": "The API key token (only shown once)"
}
},
"required": [
"token"
]
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"api_key_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the API key"
},
"type": {
"type": "string",
"enum": [
"api_keys"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/api_key"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"audit": {
"type": "object",
"properties": {
"event": {
"type": "string",
"description": "Describes the action that was taken."
},
"item_type": {
"type": "string",
"description": "Describes the object in which the action was taken on",
"enum": [
"AlertRoute",
"AlertRoutingRule",
"Alerts::Source",
"ApiKey",
"Catalog",
"CatalogEntity",
"CatalogEntityProperty",
"CatalogField",
"Cause",
"CustomField",
"CustomFieldOption",
"CustomForm",
"Dashboard",
"EdgeConnector",
"EdgeConnector::Action",
"Environment",
"EscalationPolicy",
"EscalationPolicyPath",
"ExportJob",
"FormField",
"Functionality",
"GeniusWorkflow",
"GeniusWorkflowGroup",
"GeniusWorkflowRun",
"Group",
"GroupUser",
"Heartbeat",
"Incident",
"IncidentActionItem",
"IncidentEvent",
"IncidentFormFieldSelection",
"IncidentFormFieldSelectionUser",
"IncidentPermissionSet",
"IncidentPostMortem",
"IncidentRoleAssignment",
"IncidentRoleTask",
"IncidentStatusPageEvent",
"IncidentTask",
"IncidentType",
"Integrations::DatadogAccount",
"Integrations::GithubAccount",
"Integrations::GoogleMeetAccount",
"Integrations::JiraAccount",
"Integrations::MicrosoftTeamsAccount",
"Integrations::NotionAccount",
"Integrations::OpsgenieAccount",
"Integrations::PagerdutyAccount",
"Integrations::ServiceNowAccount",
"Integrations::SlackAccount",
"Integrations::StatusPageIoAccount",
"Integrations::ZendeskAccount",
"Integrations::ZoomAccount",
"LiveCallRouter",
"LoginActivity",
"Membership",
"OnCallRole",
"Playbook",
"PlaybookTask",
"Role",
"Schedule",
"Secret",
"Service",
"Severity",
"StatusPage"
],
"nullable": true
},
"item_type_display": {
"type": "string",
"description": "Human-friendly display name for the item type",
"nullable": true
},
"object": {
"type": "object",
"description": "The object in which the action was taken on",
"nullable": true
},
"object_changes": {
"type": "object",
"description": "The changes that occurred on the object",
"nullable": true
},
"user_id": {
"type": "integer",
"description": "The ID of who took action on the object. Together with whodunnit_type can be used to find the user",
"nullable": true
},
"user_name": {
"type": "string",
"description": "Display name of the user who performed the action",
"nullable": true
},
"user_email": {
"type": "string",
"description": "Email address of the user who performed the action",
"nullable": true
},
"ip_address": {
"type": "string",
"description": "IP address of the client that performed the action",
"nullable": true
},
"user_agent": {
"type": "string",
"description": "User-Agent header of the client that performed the action",
"nullable": true
},
"request_id": {
"type": "string",
"description": "Unique request ID (UUID) for the HTTP request that triggered the action",
"nullable": true
},
"session_id": {
"type": "string",
"description": "SHA-256 fingerprint of the web session for correlating multiple actions within the same browser session",
"nullable": true
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"item_id": {
"type": "string",
"description": "ID of the affected object",
"nullable": true
},
"id": {
"type": "integer",
"description": "ID of audit",
"nullable": true
}
},
"required": [
"event",
"created_at"
]
},
"audits_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the audit log item"
},
"type": {
"type": "string",
"enum": [
"audits"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/audit"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_authorization": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"authorizations"
]
},
"attributes": {
"type": "object",
"properties": {
"authorizable_id": {
"type": "string",
"description": "The id of the resource being accessed."
},
"authorizable_type": {
"type": "string",
"description": "The type of resource being accessed.",
"enum": [
"Dashboard"
]
},
"grantee_id": {
"type": "string",
"description": "The resource id granted access."
},
"grantee_type": {
"type": "string",
"description": "The type of resource granted access.",
"enum": [
"User",
"Team"
]
},
"permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"read",
"update",
"authorize",
"destroy"
]
}
}
},
"additionalProperties": false,
"required": [
"authorizable_id",
"authorizable_type",
"grantee_id",
"grantee_type",
"permissions"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_authorization": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"authorizations"
]
},
"attributes": {
"type": "object",
"properties": {
"permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"read",
"update",
"authorize",
"destroy"
]
}
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"authorization": {
"type": "object",
"properties": {
"authorizable_id": {
"type": "string",
"description": "The id of the resource being accessed."
},
"authorizable_type": {
"type": "string",
"description": "The type of resource being accessed.",
"enum": [
"Dashboard"
]
},
"grantee_id": {
"type": "string",
"description": "The resource id granted access."
},
"grantee_type": {
"type": "string",
"description": "The type of resource granted access.",
"enum": [
"User",
"Team"
]
},
"permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"read",
"update",
"authorize",
"destroy"
]
}
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"authorizable_id",
"authorizable_type",
"grantee_id",
"grantee_type",
"permissions",
"created_at",
"updated_at"
]
},
"authorization_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the authorization"
},
"type": {
"type": "string",
"enum": [
"authorizations"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/authorization"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"authorization_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the authorization"
},
"type": {
"type": "string",
"enum": [
"authorizations"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/authorization"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_catalog": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"catalogs"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"icon": {
"type": "string",
"enum": [
"globe-alt",
"server-stack",
"users",
"user-group",
"chart-bar",
"shapes",
"light-bulb",
"cursor-arrow-ripple"
]
},
"position": {
"type": "integer",
"description": "Default position of the catalog when displayed in a list.",
"nullable": true
},
"external_id": {
"type": "string",
"description": "An external identifier for this catalog. Must be unique within the team.",
"nullable": true
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_catalog": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"catalogs"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"icon": {
"type": "string",
"enum": [
"globe-alt",
"server-stack",
"users",
"user-group",
"chart-bar",
"shapes",
"light-bulb",
"cursor-arrow-ripple"
]
},
"position": {
"type": "integer",
"description": "Default position of the catalog when displayed in a list.",
"nullable": true
},
"external_id": {
"type": "string",
"description": "An external identifier for this catalog. Must be unique within the team.",
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"catalog": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"icon": {
"type": "string",
"enum": [
"globe-alt",
"server-stack",
"users",
"user-group",
"chart-bar",
"shapes",
"light-bulb",
"cursor-arrow-ripple"
]
},
"position": {
"type": "integer",
"description": "Default position of the catalog when displayed in a list.",
"nullable": true
},
"external_id": {
"type": "string",
"description": "An external identifier for this catalog. Must be unique within the team.",
"nullable": true
},
"managed_by": {
"type": "string",
"enum": [
"web",
"admin_web",
"api",
"terraform",
"pulumi",
"backstage",
"catalog_sync"
],
"description": "Which source manages this resource (read-only)."
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"name",
"icon",
"position",
"created_at",
"updated_at"
]
},
"catalog_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the catalog"
},
"type": {
"type": "string",
"enum": [
"catalogs"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/catalog"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"catalog_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the catalog"
},
"type": {
"type": "string",
"enum": [
"catalogs"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/catalog"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_catalog_field": {
"type": "object",
"description": "A catalog can have a maximum of 50 fields.",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"catalog_properties"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"text",
"reference",
"boolean",
"service",
"functionality",
"environment",
"group",
"cause",
"incident_type",
"user"
]
},
"kind_catalog_id": {
"type": "string",
"description": "Restricts values to items of specified catalog.",
"nullable": true
},
"multiple": {
"type": "boolean",
"description": "Whether the attribute accepts multiple values."
},
"position": {
"type": "integer",
"description": "Default position of the item when displayed in a list.",
"nullable": true
},
"required": {
"type": "boolean",
"description": "Whether the field is required."
},
"catalog_type": {
"type": "string",
"description": "The type of catalog the field belongs to.",
"enum": [
"catalog",
"cause",
"environment",
"functionality",
"incident_type",
"service",
"team"
]
},
"external_id": {
"type": "string",
"description": "An external identifier for this catalog field. Must be unique within the scope.",
"nullable": true
}
},
"additionalProperties": false,
"required": [
"name",
"kind"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_catalog_field": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"catalog_properties"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"text",
"reference",
"boolean",
"service",
"functionality",
"environment",
"group",
"cause",
"incident_type",
"user"
]
},
"kind_catalog_id": {
"type": "string",
"description": "Restricts values to items of specified catalog.",
"nullable": true
},
"position": {
"type": "integer",
"description": "Default position of the item when displayed in a list.",
"nullable": true
},
"required": {
"type": "boolean",
"description": "Whether the field is required."
},
"catalog_type": {
"type": "string",
"description": "The type of catalog the field belongs to.",
"enum": [
"catalog",
"cause",
"environment",
"functionality",
"incident_type",
"service",
"team"
]
},
"external_id": {
"type": "string",
"description": "An external identifier for this catalog field. Must be unique within the scope.",
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"catalog_field": {
"type": "object",
"properties": {
"catalog_id": {
"type": "string",
"nullable": true
},
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"text",
"reference"
]
},
"kind_catalog_id": {
"type": "string",
"description": "Restricts values to items of specified catalog.",
"nullable": true
},
"multiple": {
"type": "boolean",
"description": "Whether the attribute accepts multiple values."
},
"position": {
"type": "integer",
"description": "Default position of the item when displayed in a list.",
"nullable": true
},
"required": {
"type": "boolean",
"description": "Whether the field is required."
},
"catalog_type": {
"type": "string",
"description": "The type of catalog the field belongs to.",
"enum": [
"catalog",
"cause",
"environment",
"functionality",
"incident_type",
"service",
"team"
]
},
"external_id": {
"type": "string",
"description": "An external identifier for this catalog field. Must be unique within the scope.",
"nullable": true
},
"managed_by": {
"type": "string",
"enum": [
"web",
"admin_web",
"api",
"terraform",
"pulumi",
"backstage",
"catalog_sync"
],
"description": "Which source manages this resource (read-only)."
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"catalog_id",
"name",
"kind",
"multiple",
"position",
"created_at",
"updated_at"
]
},
"catalog_field_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the catalog_field"
},
"type": {
"type": "string",
"enum": [
"catalog_properties"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/catalog_field"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"catalog_field_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the catalog_field"
},
"type": {
"type": "string",
"enum": [
"catalog_properties"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/catalog_field"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_catalog_property": {
"type": "object",
"description": "A catalog can have a maximum of 50 properties.",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"catalog_properties"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"text",
"reference",
"boolean",
"service",
"functionality",
"environment",
"group",
"cause",
"incident_type",
"user"
]
},
"kind_catalog_id": {
"type": "string",
"description": "Restricts values to items of specified catalog.",
"nullable": true
},
"multiple": {
"type": "boolean",
"description": "Whether the attribute accepts multiple values."
},
"position": {
"type": "integer",
"description": "Default position of the item when displayed in a list.",
"nullable": true
},
"required": {
"type": "boolean",
"description": "Whether the property is required."
},
"catalog_type": {
"type": "string",
"description": "The type of catalog the property belongs to.",
"enum": [
"catalog",
"cause",
"environment",
"functionality",
"incident_type",
"service",
"team"
]
},
"external_id": {
"type": "string",
"description": "An external identifier for this catalog property. Must be unique within the scope.",
"nullable": true
}
},
"additionalProperties": false,
"required": [
"name",
"kind"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_catalog_property": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"catalog_properties"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"text",
"reference",
"boolean",
"service",
"functionality",
"environment",
"group",
"cause",
"incident_type",
"user"
]
},
"kind_catalog_id": {
"type": "string",
"description": "Restricts values to items of specified catalog.",
"nullable": true
},
"position": {
"type": "integer",
"description": "Default position of the item when displayed in a list.",
"nullable": true
},
"required": {
"type": "boolean",
"description": "Whether the property is required."
},
"catalog_type": {
"type": "string",
"description": "The type of catalog the property belongs to.",
"enum": [
"catalog",
"cause",
"environment",
"functionality",
"incident_type",
"service",
"team"
]
},
"external_id": {
"type": "string",
"description": "An external identifier for this catalog property. Must be unique within the scope.",
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"catalog_property": {
"type": "object",
"properties": {
"catalog_id": {
"type": "string",
"nullable": true
},
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"text",
"reference"
]
},
"kind_catalog_id": {
"type": "string",
"description": "Restricts values to items of specified catalog.",
"nullable": true
},
"multiple": {
"type": "boolean",
"description": "Whether the attribute accepts multiple values."
},
"position": {
"type": "integer",
"description": "Default position of the item when displayed in a list.",
"nullable": true
},
"required": {
"type": "boolean",
"description": "Whether the property is required."
},
"catalog_type": {
"type": "string",
"description": "The type of catalog the property belongs to.",
"enum": [
"catalog",
"cause",
"environment",
"functionality",
"incident_type",
"service",
"team"
]
},
"external_id": {
"type": "string",
"description": "An external identifier for this catalog property. Must be unique within the scope.",
"nullable": true
},
"managed_by": {
"type": "string",
"enum": [
"web",
"admin_web",
"api",
"terraform",
"pulumi",
"backstage",
"catalog_sync"
],
"description": "Which source manages this resource (read-only)."
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"catalog_id",
"name",
"kind",
"multiple",
"position",
"created_at",
"updated_at"
]
},
"catalog_property_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the catalog_property"
},
"type": {
"type": "string",
"enum": [
"catalog_properties"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/catalog_property"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"catalog_property_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the catalog_property"
},
"type": {
"type": "string",
"enum": [
"catalog_properties"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/catalog_property"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_catalog_entity": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"catalog_entities"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"position": {
"type": "integer",
"description": "Default position of the item when displayed in a list.",
"nullable": true
},
"backstage_id": {
"type": "string",
"description": "The Backstage entity ID this catalog entity is linked to.",
"nullable": true
},
"external_id": {
"type": "string",
"description": "An external identifier for this catalog entity. Must be unique within the catalog.",
"nullable": true
},
"properties": {
"type": "array",
"description": "Array of property values for this catalog entity",
"items": {
"type": "object",
"properties": {
"catalog_property_id": {
"type": "string",
"description": "Unique ID of the catalog property"
},
"value": {
"type": "string",
"description": "The value for this property"
}
},
"required": [
"catalog_property_id",
"value"
]
}
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_catalog_entity": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"catalog_entities"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"position": {
"type": "integer",
"description": "Default position of the item when displayed in a list.",
"nullable": true
},
"backstage_id": {
"type": "string",
"description": "The Backstage entity ID this catalog entity is linked to.",
"nullable": true
},
"external_id": {
"type": "string",
"description": "An external identifier for this catalog entity. Must be unique within the catalog.",
"nullable": true
},
"properties": {
"type": "array",
"description": "Array of property values for this catalog entity",
"items": {
"type": "object",
"properties": {
"catalog_property_id": {
"type": "string",
"description": "Unique ID of the catalog property"
},
"value": {
"type": "string",
"description": "The value for this property"
}
},
"required": [
"catalog_property_id",
"value"
]
}
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"catalog_entity": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"position": {
"type": "integer",
"description": "Default position of the item when displayed in a list.",
"nullable": true
},
"backstage_id": {
"type": "string",
"description": "The Backstage entity ID this catalog entity is linked to.",
"nullable": true
},
"external_id": {
"type": "string",
"description": "An external identifier for this catalog entity. Must be unique within the catalog.",
"nullable": true
},
"managed_by": {
"type": "string",
"enum": [
"web",
"admin_web",
"api",
"terraform",
"pulumi",
"backstage",
"catalog_sync"
],
"description": "Which source manages this resource (read-only)."
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"properties": {
"type": "array",
"description": "Array of property values for this catalog entity",
"items": {
"type": "object",
"properties": {
"catalog_property_id": {
"type": "string",
"description": "Unique ID of the catalog property"
},
"value": {
"type": "string",
"description": "The value for this property"
}
},
"required": [
"catalog_property_id",
"value"
]
}
}
},
"required": [
"name",
"position",
"created_at",
"updated_at"
]
},
"catalog_entity_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the catalog_entity"
},
"type": {
"type": "string",
"enum": [
"catalog_entities"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/catalog_entity"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"catalog_entity_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the catalog_entity"
},
"type": {
"type": "string",
"enum": [
"catalog_entities"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/catalog_entity"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"bulk_upsert_catalog_entities": {
"type": "object",
"properties": {
"entities": {
"type": "array",
"description": "Array of catalog entities to upsert. Each must have an external_id. Max 100 per request. external_ids must be unique within a batch.",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"description": "External identifier used as the upsert key. Must be unique within the catalog."
},
"name": {
"type": "string",
"description": "Required for new entities. Optional for updates (managed-fields: omitted attributes are preserved)."
},
"description": {
"type": "string",
"nullable": true
},
"backstage_id": {
"type": "string",
"nullable": true
},
"fields": {
"type": "array",
"description": "Property values for this entity. Only mentioned fields are written; unmentioned fields are preserved.",
"items": {
"type": "object",
"description": "Each field entry must include either catalog_field_id or catalog_property_id.",
"properties": {
"catalog_field_id": {
"type": "string",
"description": "UUID, slug, or external_id of the catalog field (required if catalog_property_id is absent)"
},
"catalog_property_id": {
"type": "string",
"description": "Alias for catalog_field_id (required if catalog_field_id is absent)"
},
"value": {
"type": "string",
"description": "The value for this field"
}
},
"required": [
"value"
]
}
}
},
"required": [
"external_id"
]
}
}
},
"required": [
"entities"
]
},
"bulk_upsert_catalog_entities_response": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"catalog_entities"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/catalog_entity"
}
]
}
}
}
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
}
},
"bulk_upsert_catalog_entities_error": {
"type": "object",
"required": [
"errors"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"required": [
"index",
"external_id",
"errors"
],
"properties": {
"index": {
"type": "integer",
"description": "Position of the failed entity in the batch"
},
"external_id": {
"type": "string"
},
"errors": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
},
"bulk_destroy_catalog_entities": {
"description": "Two mutually exclusive modes. Pass exactly one of: external_ids (delete specific entities) or managed_by (prune all managed entities not in keep set).",
"oneOf": [
{
"type": "object",
"required": [
"external_ids"
],
"additionalProperties": false,
"properties": {
"external_ids": {
"type": "array",
"description": "Array of external_ids to delete. Max 100 per request.",
"items": {
"type": "string",
"minLength": 1
},
"minItems": 1
}
}
},
{
"type": "object",
"required": [
"managed_by"
],
"additionalProperties": false,
"properties": {
"managed_by": {
"type": "string",
"enum": [
"api",
"terraform",
"pulumi",
"backstage",
"catalog_sync"
],
"description": "Delete all entities with this managed_by value (web/admin_web not allowed)."
},
"keep_external_ids": {
"type": "array",
"description": "Entities with these external_ids are preserved.",
"items": {
"type": "string"
}
}
}
}
]
},
"bulk_destroy_catalog_entities_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"deleted_external_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "External IDs that were successfully deleted"
},
"failed_external_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "External IDs where destroy failed (e.g. protected/synced entities)"
},
"not_found_external_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "External IDs that were not found (only present in external_ids mode)"
}
}
}
}
},
"new_catalog_entity_property": {
"type": "object",
"description": "**Deprecated:** This endpoint is deprecated, please use the `fields` attribute on catalog entities or native catalog endpoints (teams, services, functionalities, incident_types, causes, environments) to set field values instead.",
"deprecated": true,
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"catalog_entity_properties"
]
},
"attributes": {
"type": "object",
"description": "Maximum of 50 values allowed per catalog field.",
"properties": {
"catalog_entity_id": {
"type": "string"
},
"catalog_field_id": {
"type": "string"
},
"key": {
"type": "string",
"enum": [
"text",
"catalog_entity",
"slack"
]
},
"value": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"catalog_field_id",
"key",
"value"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_catalog_entity_property": {
"type": "object",
"description": "**Deprecated:** This endpoint is deprecated, please use the `fields` attribute on catalog entities or native catalog endpoints (teams, services, functionalities, incident_types, causes, environments) to set field values instead.",
"deprecated": true,
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"catalog_entity_properties"
]
},
"attributes": {
"type": "object",
"properties": {
"key": {
"type": "string",
"enum": [
"text",
"catalog_entity",
"slack"
]
},
"value": {
"type": "string"
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"catalog_entity_property": {
"type": "object",
"description": "**Deprecated:** This endpoint is deprecated, please use `include=fields` on catalog entities or native catalog endpoints (teams, services, functionalities, incident_types, causes, environments) to retrieve field values instead.",
"deprecated": true,
"properties": {
"catalog_entity_id": {
"type": "string"
},
"catalog_field_id": {
"type": "string"
},
"key": {
"type": "string",
"enum": [
"text",
"catalog_entity",
"slack"
]
},
"value": {
"type": "string"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"catalog_entity_id",
"catalog_field_id",
"key",
"value",
"created_at",
"updated_at"
]
},
"catalog_entity_property_response": {
"type": "object",
"description": "**Deprecated:** This endpoint is deprecated, please use `include=fields` on catalog entities or native catalog endpoints (teams, services, functionalities, incident_types, causes, environments) to retrieve field values instead.",
"deprecated": true,
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the catalog_entity_property"
},
"type": {
"type": "string",
"enum": [
"catalog_entity_properties"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/catalog_entity_property"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"catalog_entity_property_list": {
"type": "object",
"description": "**Deprecated:** This endpoint is deprecated, please use `include=fields` on catalog entities or native catalog endpoints (teams, services, functionalities, incident_types, causes, environments) to retrieve field values instead.",
"deprecated": true,
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the catalog_entity_property"
},
"type": {
"type": "string",
"enum": [
"catalog_entity_properties"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/catalog_entity_property"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_catalog_checklist_template": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"catalog_checklist_templates"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the checklist template"
},
"description": {
"type": "string",
"description": "The description of the checklist template",
"nullable": true
},
"catalog_type": {
"type": "string",
"description": "The catalog type",
"enum": [
"Service",
"Functionality",
"Environment",
"Group",
"Cause",
"IncidentType",
"Catalog"
]
},
"scope_type": {
"type": "string",
"description": "The scope type",
"enum": [
"Team",
"Catalog"
]
},
"scope_id": {
"type": "string",
"description": "The scope ID (team or catalog UUID)"
},
"fields": {
"type": "array",
"description": "Template fields. Position is determined by array order.",
"nullable": true,
"items": {
"type": "object",
"oneOf": [
{
"title": "Builtin field",
"properties": {
"field_source": {
"type": "string",
"enum": [
"builtin"
]
},
"field_key": {
"type": "string",
"description": "Key identifying the builtin field"
}
},
"required": [
"field_source",
"field_key"
]
},
{
"title": "Custom field",
"properties": {
"field_source": {
"type": "string",
"enum": [
"custom"
]
},
"catalog_property_id": {
"type": "string",
"description": "ID of the catalog property"
},
"field_key": {
"type": "string",
"description": "Ignored for custom fields (auto-derived from catalog property)"
}
},
"required": [
"field_source",
"catalog_property_id"
]
}
]
}
},
"owners": {
"type": "array",
"description": "Template owners",
"nullable": true,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "User ID for user owners, or field key for field owners"
},
"type": {
"type": "string",
"description": "Type of owner",
"enum": [
"field",
"user"
]
}
},
"required": [
"id",
"type"
]
}
}
},
"additionalProperties": false,
"required": [
"name",
"catalog_type",
"scope_type"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_catalog_checklist_template": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"catalog_checklist_templates"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the checklist template"
},
"description": {
"type": "string",
"description": "The description of the checklist template",
"nullable": true
},
"fields": {
"type": "array",
"description": "Template fields. Position is determined by array order. Replaces all existing fields.",
"nullable": true,
"items": {
"type": "object",
"oneOf": [
{
"title": "Builtin field",
"properties": {
"field_source": {
"type": "string",
"enum": [
"builtin"
]
},
"field_key": {
"type": "string",
"description": "Key identifying the builtin field"
}
},
"required": [
"field_source",
"field_key"
]
},
{
"title": "Custom field",
"properties": {
"field_source": {
"type": "string",
"enum": [
"custom"
]
},
"catalog_property_id": {
"type": "string",
"description": "ID of the catalog property"
},
"field_key": {
"type": "string",
"description": "Ignored for custom fields (auto-derived from catalog property)"
}
},
"required": [
"field_source",
"catalog_property_id"
]
}
]
}
},
"owners": {
"type": "array",
"description": "Template owners. Replaces all existing owners.",
"nullable": true,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "User ID for user owners, or field key for field owners"
},
"type": {
"type": "string",
"description": "Type of owner",
"enum": [
"field",
"user"
]
}
},
"required": [
"id",
"type"
]
}
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"catalog_checklist_template": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the checklist template"
},
"slug": {
"type": "string",
"description": "The slug of the checklist template"
},
"description": {
"type": "string",
"description": "The description of the checklist template",
"nullable": true
},
"catalog_type": {
"type": "string",
"description": "The catalog type",
"enum": [
"Service",
"Functionality",
"Environment",
"Group",
"Cause",
"IncidentType",
"Catalog"
]
},
"scope_type": {
"type": "string",
"description": "The scope type",
"enum": [
"Team",
"Catalog"
]
},
"scope_id": {
"type": "string",
"description": "The scope ID"
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
},
"fields": {
"type": "array",
"description": "Template fields in position order",
"nullable": true,
"items": {
"type": "object",
"properties": {
"field_source": {
"type": "string",
"description": "Source of the field",
"enum": [
"builtin",
"custom"
]
},
"field_key": {
"type": "string",
"description": "Key identifying the field"
},
"catalog_property_id": {
"type": "string",
"description": "ID of the catalog property for custom fields",
"nullable": true
}
}
}
},
"owners": {
"type": "array",
"description": "Template owners",
"nullable": true,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "User ID for user owners, or field key for field owners"
},
"type": {
"type": "string",
"description": "Type of owner",
"enum": [
"field",
"user"
]
}
}
}
}
},
"required": [
"name",
"catalog_type",
"scope_type",
"scope_id",
"created_at",
"updated_at"
]
},
"catalog_checklist_template_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the checklist template"
},
"type": {
"type": "string",
"enum": [
"catalog_checklist_templates"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/catalog_checklist_template"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"catalog_checklist_template_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the checklist template"
},
"type": {
"type": "string",
"enum": [
"catalog_checklist_templates"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/catalog_checklist_template"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"catalog_entity_checklist": {
"type": "object",
"properties": {
"catalog_checklist_template_id": {
"type": "string",
"description": "The ID of the checklist template"
},
"auditable_type": {
"type": "string",
"description": "The type of the auditable entity",
"enum": [
"Service",
"Functionality",
"Environment",
"Group",
"Cause",
"IncidentType",
"CatalogEntity"
]
},
"auditable_id": {
"type": "string",
"description": "The ID of the auditable entity"
},
"status": {
"type": "string",
"description": "The status of the checklist",
"enum": [
"triggered",
"in_progress",
"completed",
"cancelled"
]
},
"started_at": {
"type": "string",
"description": "When the checklist was started",
"nullable": true
},
"completed_at": {
"type": "string",
"description": "When the checklist was completed",
"nullable": true
},
"completed_by_user_id": {
"type": "string",
"description": "The ID of the user who completed the checklist",
"nullable": true
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
},
"checklist_fields": {
"type": "array",
"description": "Checklist fields",
"nullable": true,
"items": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the checklist field"
},
"type": {
"type": "string",
"enum": [
"catalog_entity_checklist_fields"
]
},
"attributes": {
"type": "object",
"properties": {
"catalog_entity_checklist_id": {
"type": "string",
"description": "The ID of the parent checklist"
},
"catalog_checklist_template_field_id": {
"type": "string",
"description": "The ID of the template field",
"nullable": true
},
"field_key": {
"type": "string",
"description": "The field key"
},
"checked": {
"type": "boolean",
"description": "Whether the field is checked"
},
"value_snapshot": {
"type": "object",
"description": "The value snapshot at time of checking",
"nullable": true
},
"completed_by_user_id": {
"type": "string",
"description": "The ID of the user who checked the field",
"nullable": true
},
"completed_at": {
"type": "string",
"description": "When the field was checked",
"nullable": true
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
}
}
}
}
}
}
},
"checklist_owners": {
"type": "array",
"description": "Checklist owners",
"nullable": true,
"items": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the checklist owner"
},
"type": {
"type": "string",
"enum": [
"catalog_entity_checklist_owners"
]
},
"attributes": {
"type": "object",
"properties": {
"catalog_entity_checklist_id": {
"type": "string",
"description": "The ID of the parent checklist"
},
"owner_user_id": {
"type": "string",
"description": "The ID of the owner user"
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
}
}
}
}
}
}
}
},
"required": [
"catalog_checklist_template_id",
"auditable_type",
"auditable_id",
"status",
"created_at",
"updated_at"
]
},
"catalog_entity_checklist_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the entity checklist"
},
"type": {
"type": "string",
"enum": [
"catalog_entity_checklists"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/catalog_entity_checklist"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"catalog_entity_checklist_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the entity checklist"
},
"type": {
"type": "string",
"enum": [
"catalog_entity_checklists"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/catalog_entity_checklist"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"new_cause": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"causes"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the cause"
},
"description": {
"type": "string",
"description": "The description of the cause",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the cause",
"nullable": true
},
"properties": {
"type": "array",
"items": {
"type": "object",
"description": "Set a value for a catalog property",
"properties": {
"catalog_property_id": {
"type": "string",
"description": "Catalog property ID"
},
"value": {
"type": "string",
"description": "The property value"
}
},
"required": [
"catalog_property_id",
"value"
]
},
"description": "Array of property values for this cause."
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_cause": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"causes"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the cause"
},
"description": {
"type": "string",
"description": "The description of the cause",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the cause",
"nullable": true
},
"properties": {
"type": "array",
"items": {
"type": "object",
"description": "Set a value for a catalog property",
"properties": {
"catalog_property_id": {
"type": "string",
"description": "Catalog property ID"
},
"value": {
"type": "string",
"description": "The property value"
}
},
"required": [
"catalog_property_id",
"value"
]
},
"description": "Array of property values for this cause."
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"cause": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the cause"
},
"slug": {
"type": "string",
"description": "The slug of the cause"
},
"description": {
"type": "string",
"description": "The description of the cause",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the cause",
"nullable": true
},
"properties": {
"type": "array",
"items": {
"type": "object",
"description": "Set a value for a catalog property",
"properties": {
"catalog_property_id": {
"type": "string",
"description": "Catalog property ID"
},
"value": {
"type": "string",
"description": "The property value"
}
},
"required": [
"catalog_property_id",
"value"
]
},
"description": "Array of property values for this cause."
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"name",
"created_at",
"updated_at"
]
},
"cause_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the cause"
},
"type": {
"type": "string",
"enum": [
"causes"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/cause"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"cause_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the cause"
},
"type": {
"type": "string",
"enum": [
"causes"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/cause"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"incidents_chart_response": {
"type": "object",
"properties": {
"data": {
"type": "object"
}
},
"required": [
"data"
]
},
"uptime_chart_response": {
"type": "object",
"properties": {
"data": {
"type": "object"
}
},
"required": [
"data"
]
},
"new_communications_stage": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"communications_stages"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the communications stage"
},
"description": {
"type": "string",
"description": "The description of the communications stage",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the communications stage",
"nullable": true
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_communications_stage": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"communications_stages"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the communications stage"
},
"description": {
"type": "string",
"description": "The description of the communications stage",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the communications stage",
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"communications_stage": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the communications stage"
},
"slug": {
"type": "string",
"description": "The slug of the communications stage"
},
"description": {
"type": "string",
"description": "The description of the communications stage",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the communications stage",
"nullable": true
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"name",
"position",
"created_at",
"updated_at"
]
},
"communications_stage_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the communications stage"
},
"type": {
"type": "string",
"enum": [
"communications_stages"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/communications_stage"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"communications_stages_response": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the communications stage"
},
"type": {
"type": "string",
"enum": [
"communications_stages"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/communications_stage"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"new_communications_type": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"communications_types"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the communications type"
},
"description": {
"type": "string",
"description": "The description of the communications type",
"nullable": true
},
"color": {
"type": "string",
"description": "The color of the communications type",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the communications type",
"nullable": true
}
},
"additionalProperties": false,
"required": [
"name",
"color"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_communications_type": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"communications_types"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the communications type"
},
"description": {
"type": "string",
"description": "The description of the communications type",
"nullable": true
},
"color": {
"type": "string",
"description": "The color of the communications type",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the communications type",
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"communications_type": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the communications type"
},
"slug": {
"type": "string",
"description": "The slug of the communications type"
},
"description": {
"type": "string",
"description": "The description of the communications type",
"nullable": true
},
"color": {
"type": "string",
"description": "The color of the communications type",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the communications type"
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"name",
"color",
"position",
"created_at",
"updated_at"
]
},
"communications_type_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the communications type"
},
"type": {
"type": "string",
"enum": [
"communications_types"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/communications_type"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"communications_types_response": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the communications type"
},
"type": {
"type": "string",
"enum": [
"communications_types"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/communications_type"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"new_communications_template": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"communications_templates"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the communications template"
},
"description": {
"type": "string",
"description": "The description of the communications template",
"nullable": true
},
"communication_type_id": {
"type": "string",
"description": "The communication type ID"
},
"position": {
"type": "integer",
"description": "Position of the communications template",
"nullable": true
},
"communication_template_stages_attributes": {
"type": "array",
"description": "Template stages attributes",
"nullable": true,
"items": {
"type": "object",
"properties": {
"communication_stage_id": {
"type": "string",
"description": "The communication stage ID"
},
"sms_content": {
"type": "string",
"description": "SMS content for the stage",
"nullable": true
},
"email_subject": {
"type": "string",
"description": "Email subject for the stage",
"nullable": true
},
"email_body": {
"type": "string",
"description": "Email body for the stage",
"nullable": true
},
"slack_content": {
"type": "string",
"description": "Slack content for the stage",
"nullable": true
}
}
}
}
},
"additionalProperties": false,
"required": [
"name",
"communication_type_id"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_communications_template": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"communications_templates"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the communications template"
},
"description": {
"type": "string",
"description": "The description of the communications template",
"nullable": true
},
"communication_type_id": {
"type": "string",
"description": "The communication type ID"
},
"position": {
"type": "integer",
"description": "Position of the communications template",
"nullable": true
},
"communication_template_stages_attributes": {
"type": "array",
"description": "Template stages attributes",
"nullable": true,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the communication template stage",
"nullable": true
},
"sms_content": {
"type": "string",
"description": "SMS content for the stage",
"nullable": true
},
"email_subject": {
"type": "string",
"description": "Email subject for the stage",
"nullable": true
},
"email_body": {
"type": "string",
"description": "Email body for the stage",
"nullable": true
},
"slack_content": {
"type": "string",
"description": "Slack content for the stage",
"nullable": true
}
}
}
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"communications_template": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the communications template"
},
"slug": {
"type": "string",
"description": "The slug of the communications template"
},
"description": {
"type": "string",
"description": "The description of the communications template",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the communications template",
"nullable": true
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
},
"communication_type_id": {
"type": "string",
"description": "The communication type ID"
},
"communication_template_stages": {
"type": "array",
"description": "Communication template stages",
"nullable": true,
"items": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the communication template stage"
},
"type": {
"type": "string",
"enum": [
"communications_template_stages"
]
},
"attributes": {
"type": "object",
"properties": {
"email_body": {
"type": "string",
"description": "Email body for the stage",
"nullable": true
},
"email_subject": {
"type": "string",
"description": "Email subject for the stage",
"nullable": true
},
"slack_content": {
"type": "string",
"description": "Slack content for the stage",
"nullable": true
},
"sms_content": {
"type": "string",
"description": "SMS content for the stage",
"nullable": true
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
},
"communication_stage": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The communication stage ID"
},
"name": {
"type": "string",
"description": "The communication stage name"
}
}
},
"communication_template": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The communication template ID"
},
"name": {
"type": "string",
"description": "The communication template name"
}
}
}
}
}
}
}
}
}
},
"communication_type": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the communication type"
},
"name": {
"type": "string",
"description": "Name of the communication type"
}
}
}
},
"required": [
"name",
"position",
"created_at",
"updated_at"
]
},
"communications_template_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the communications template"
},
"type": {
"type": "string",
"enum": [
"communications_templates"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/communications_template"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"communications_templates_response": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the communications template"
},
"type": {
"type": "string",
"enum": [
"communications_templates"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/communications_template"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"new_communications_group": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"communications_groups"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the communications group"
},
"description": {
"type": "string",
"description": "The description of the communications group",
"nullable": true
},
"communication_type_id": {
"type": "string",
"description": "The communication type ID"
},
"is_private": {
"type": "boolean",
"description": "Whether the group is private",
"nullable": true
},
"condition_type": {
"type": "string",
"description": "Condition type",
"enum": [
"any",
"all"
],
"nullable": true
},
"sms_channel": {
"type": "boolean",
"description": "SMS channel enabled",
"nullable": true
},
"email_channel": {
"type": "boolean",
"description": "Email channel enabled",
"nullable": true
},
"member_ids": {
"type": "array",
"description": "Array of member user IDs",
"nullable": true,
"items": {
"type": "integer"
}
},
"slack_channel_ids": {
"type": "array",
"description": "Array of Slack channel IDs",
"nullable": true,
"items": {
"type": "string"
}
},
"communication_group_conditions": {
"type": "array",
"description": "Group conditions attributes",
"nullable": true,
"items": {
"type": "object",
"properties": {
"property_type": {
"type": "string",
"description": "Property type",
"enum": [
"service",
"severity",
"functionality",
"group",
"incident_type"
]
},
"service_ids": {
"type": "array",
"description": "Array of service IDs",
"nullable": true,
"items": {
"type": "string"
}
},
"severity_ids": {
"type": "array",
"description": "Array of severity IDs",
"nullable": true,
"items": {
"type": "string"
}
},
"functionality_ids": {
"type": "array",
"description": "Array of functionality IDs",
"nullable": true,
"items": {
"type": "string"
}
},
"group_ids": {
"type": "array",
"description": "Array of group IDs",
"nullable": true,
"items": {
"type": "string"
}
},
"incident_type_ids": {
"type": "array",
"description": "Array of incident type IDs",
"nullable": true,
"items": {
"type": "string"
}
}
}
}
},
"communication_external_group_members": {
"type": "array",
"description": "External group members attributes",
"nullable": true,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the external member"
},
"email": {
"type": "string",
"description": "Email of the external member"
},
"phone_number": {
"type": "string",
"description": "Phone number of the external member"
}
}
}
}
},
"additionalProperties": false,
"required": [
"name",
"communication_type_id"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_communications_group": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"communications_groups"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the communications group"
},
"description": {
"type": "string",
"description": "The description of the communications group",
"nullable": true
},
"communication_type_id": {
"type": "string",
"description": "The communication type ID"
},
"is_private": {
"type": "boolean",
"description": "Whether the group is private",
"nullable": true
},
"condition_type": {
"type": "string",
"description": "Condition type",
"enum": [
"any",
"all"
],
"nullable": true
},
"sms_channel": {
"type": "boolean",
"description": "SMS channel enabled",
"nullable": true
},
"email_channel": {
"type": "boolean",
"description": "Email channel enabled",
"nullable": true
},
"member_ids": {
"type": "array",
"description": "Array of member user IDs",
"nullable": true,
"items": {
"type": "integer"
}
},
"slack_channel_ids": {
"type": "array",
"description": "Array of Slack channel IDs",
"nullable": true,
"items": {
"type": "string"
}
},
"communication_group_conditions": {
"type": "array",
"description": "Group conditions attributes",
"nullable": true,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the condition",
"nullable": true
},
"property_type": {
"type": "string",
"description": "Property type",
"enum": [
"service",
"severity",
"functionality",
"group",
"incident_type"
]
},
"service_ids": {
"type": "array",
"description": "Array of service IDs",
"nullable": true,
"items": {
"type": "string"
}
},
"severity_ids": {
"type": "array",
"description": "Array of severity IDs",
"nullable": true,
"items": {
"type": "string"
}
},
"functionality_ids": {
"type": "array",
"description": "Array of functionality IDs",
"nullable": true,
"items": {
"type": "string"
}
},
"group_ids": {
"type": "array",
"description": "Array of group IDs",
"nullable": true,
"items": {
"type": "string"
}
},
"incident_type_ids": {
"type": "array",
"description": "Array of incident type IDs",
"nullable": true,
"items": {
"type": "string"
}
}
}
}
},
"communication_external_group_members": {
"type": "array",
"description": "External group members attributes",
"nullable": true,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the external group member",
"nullable": true
},
"name": {
"type": "string",
"description": "Name of the external member"
},
"email": {
"type": "string",
"description": "Email of the external member"
},
"phone_number": {
"type": "string",
"description": "Phone number of the external member"
}
}
}
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"communications_group": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the communications group"
},
"slug": {
"type": "string",
"description": "The slug of the communications group"
},
"description": {
"type": "string",
"description": "The description of the communications group",
"nullable": true
},
"communication_type_id": {
"type": "string",
"description": "The communication type ID"
},
"is_private": {
"type": "boolean",
"description": "Whether the group is private"
},
"condition_type": {
"type": "string",
"description": "Condition type",
"enum": [
"any",
"all"
]
},
"sms_channel": {
"type": "boolean",
"description": "SMS channel enabled"
},
"email_channel": {
"type": "boolean",
"description": "Email channel enabled"
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
},
"communication_group_conditions": {
"type": "array",
"description": "Group conditions attributes",
"nullable": true,
"items": {
"type": "object",
"properties": {
"property_type": {
"type": "string",
"description": "Property type",
"enum": [
"service",
"severity",
"functionality",
"group",
"incident_type"
]
},
"service_ids": {
"type": "array",
"description": "Array of service IDs",
"nullable": true,
"items": {
"type": "string"
}
},
"severity_ids": {
"type": "array",
"description": "Array of severity IDs",
"nullable": true,
"items": {
"type": "string"
}
},
"functionality_ids": {
"type": "array",
"description": "Array of functionality IDs",
"nullable": true,
"items": {
"type": "string"
}
},
"group_ids": {
"type": "array",
"description": "Array of group IDs",
"nullable": true,
"items": {
"type": "string"
}
},
"incident_type_ids": {
"type": "array",
"description": "Array of incident type IDs",
"nullable": true,
"items": {
"type": "string"
}
}
}
}
},
"member_ids": {
"type": "array",
"description": "Array of member user IDs",
"nullable": true,
"items": {
"type": "integer"
}
},
"slack_channel_ids": {
"type": "array",
"description": "Array of Slack channel IDs",
"nullable": true,
"items": {
"type": "string"
}
},
"communication_external_group_members": {
"type": "array",
"description": "External group members",
"nullable": true,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the external group member"
},
"name": {
"type": "string",
"description": "Name of the external member"
},
"email": {
"type": "string",
"description": "Email of the external member"
},
"phone_number": {
"type": "string",
"description": "Phone number of the external member"
}
}
}
}
},
"required": [
"name",
"communication_type_id",
"is_private",
"condition_type",
"sms_channel",
"email_channel",
"created_at",
"updated_at"
]
},
"communications_group_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the communications group"
},
"type": {
"type": "string",
"enum": [
"communications_groups"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/communications_group"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"communications_groups_response": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the communications group"
},
"type": {
"type": "string",
"enum": [
"communications_groups"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/communications_group"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"new_custom_field_option": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"custom_field_options"
]
},
"attributes": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The value of the custom_field_option"
},
"color": {
"type": "string",
"description": "The hex color of the custom_field_option"
},
"default": {
"type": "boolean"
},
"position": {
"type": "integer",
"description": "The position of the custom_field_option"
}
},
"additionalProperties": false,
"required": [
"value"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_custom_field_option": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"custom_field_options"
]
},
"attributes": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The value of the custom_field_option"
},
"color": {
"type": "string",
"description": "The hex color of the custom_field_option"
},
"default": {
"type": "boolean"
},
"position": {
"type": "integer",
"description": "The position of the custom_field_option"
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"custom_field_option": {
"type": "object",
"properties": {
"custom_field_id": {
"type": "integer",
"description": "The ID of the parent custom field"
},
"value": {
"type": "string",
"description": "The value of the custom_field_option"
},
"color": {
"type": "string",
"description": "The hex color of the custom_field_option"
},
"default": {
"type": "boolean"
},
"position": {
"type": "integer",
"description": "The position of the custom_field_option"
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"value",
"color",
"position",
"created_at",
"updated_at"
]
},
"custom_field_option_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the custom_field_option"
},
"type": {
"type": "string",
"enum": [
"custom_field_options"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/custom_field_option"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"custom_field_option_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the custom_field_option"
},
"type": {
"type": "string",
"enum": [
"custom_field_options"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/custom_field_option"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_custom_field": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"custom_fields"
]
},
"attributes": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "The name of the custom_field"
},
"description": {
"type": "string",
"description": "The description of the custom_field",
"nullable": true
},
"shown": {
"type": "array",
"items": {
"type": "string",
"description": "Where the custom_field is shown",
"enum": [
"incident_form",
"incident_mitigation_form",
"incident_resolution_form",
"incident_post_mortem_form",
"incident_slack_form",
"incident_mitigation_slack_form",
"incident_resolution_slack_form",
"incident_post_mortem"
]
}
},
"required": {
"type": "array",
"items": {
"type": "string",
"description": "Where the custom_field is required",
"enum": [
"incident_form",
"incident_mitigation_form",
"incident_resolution_form",
"incident_post_mortem_form",
"incident_slack_form",
"incident_mitigation_slack_form",
"incident_resolution_slack_form"
]
},
"nullable": true
},
"default": {
"type": "string",
"description": "The default value for text field kinds",
"nullable": true
},
"position": {
"type": "integer",
"description": "The position of the custom_field"
}
},
"additionalProperties": false,
"required": [
"label"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_custom_field": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"custom_fields"
]
},
"attributes": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "The name of the custom_field"
},
"description": {
"type": "string",
"description": "The description of the custom_field",
"nullable": true
},
"shown": {
"type": "array",
"items": {
"type": "string",
"description": "Where the custom_field is shown",
"enum": [
"incident_form",
"incident_mitigation_form",
"incident_resolution_form",
"incident_post_mortem_form",
"incident_slack_form",
"incident_mitigation_slack_form",
"incident_resolution_slack_form",
"incident_post_mortem"
]
}
},
"required": {
"type": "array",
"items": {
"type": "string",
"description": "Where the custom_field is required",
"enum": [
"incident_form",
"incident_mitigation_form",
"incident_resolution_form",
"incident_post_mortem_form",
"incident_slack_form",
"incident_mitigation_slack_form",
"incident_resolution_slack_form"
]
},
"nullable": true
},
"default": {
"type": "string",
"description": "The default value for text field kinds",
"nullable": true
},
"position": {
"type": "integer",
"description": "The position of the custom_field"
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"custom_field": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "The name of the custom_field"
},
"kind": {
"type": "string",
"description": "The kind of the custom_field"
},
"enabled": {
"type": "boolean",
"description": "Whether the custom_field is enabled"
},
"slug": {
"type": "string",
"description": "The slug of the custom_field"
},
"description": {
"type": "string",
"description": "The description of the custom_field",
"nullable": true
},
"shown": {
"type": "array",
"items": {
"type": "string",
"description": "Where the custom_field is shown",
"enum": [
"incident_form",
"incident_mitigation_form",
"incident_resolution_form",
"incident_post_mortem_form",
"incident_slack_form",
"incident_mitigation_slack_form",
"incident_resolution_slack_form",
"incident_post_mortem"
]
}
},
"required": {
"type": "array",
"items": {
"type": "string",
"description": "Where the custom_field is required",
"enum": [
"incident_form",
"incident_mitigation_form",
"incident_resolution_form",
"incident_post_mortem_form",
"incident_slack_form",
"incident_mitigation_slack_form",
"incident_resolution_slack_form"
]
},
"nullable": true
},
"default": {
"type": "string",
"description": "The default value for text field kinds",
"nullable": true
},
"position": {
"type": "integer",
"description": "The position of the custom_field"
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"label",
"shown",
"required",
"position",
"created_at",
"updated_at"
]
},
"custom_field_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the custom_field"
},
"type": {
"type": "string",
"enum": [
"custom_fields"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/custom_field"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"custom_field_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the custom_field"
},
"type": {
"type": "string",
"enum": [
"custom_fields"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/custom_field"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_custom_form": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"custom_forms"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the custom form."
},
"description": {
"type": "string",
"nullable": true
},
"enabled": {
"type": "boolean"
},
"command": {
"type": "string",
"description": "The Slack command used to trigger this form."
}
},
"additionalProperties": false,
"required": [
"name",
"command"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_custom_form": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"custom_forms"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the custom form."
},
"description": {
"type": "string",
"nullable": true
},
"enabled": {
"type": "boolean"
},
"command": {
"type": "string",
"description": "The Slack command used to trigger this form."
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"custom_form": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the custom form."
},
"slug": {
"type": "string",
"description": "The custom form slug. Add this to form_field.shown or form_field.required to associate form fields with custom forms."
},
"description": {
"type": "string",
"nullable": true
},
"enabled": {
"type": "boolean"
},
"command": {
"type": "string",
"description": "The Slack command used to trigger this form."
},
"created_at": {
"type": "string",
"description": "Date of creation."
},
"updated_at": {
"type": "string",
"description": "Date of last update."
}
},
"required": [
"name",
"command",
"enabled",
"created_at",
"updated_at"
]
},
"custom_form_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique id of the custom form."
},
"type": {
"type": "string",
"enum": [
"custom_forms"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/custom_form"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"custom_form_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique id of the custom form."
},
"type": {
"type": "string",
"enum": [
"custom_forms"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/custom_form"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_dashboard_panel": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"dashboard_panels"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the dashboard_panel",
"nullable": true
},
"params": {
"type": "object",
"properties": {
"display": {
"type": "string",
"enum": [
"line_chart",
"line_stepped_chart",
"column_chart",
"stacked_column_chart",
"monitoring_chart",
"pie_chart",
"table",
"aggregate_value"
]
},
"description": {
"type": "string"
},
"table_fields": {
"type": "array",
"items": {
"type": "string"
}
},
"legend": {
"type": "object",
"properties": {
"groups": {
"type": "string",
"enum": [
"all",
"charted"
],
"default": "all"
}
}
},
"datalabels": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
}
}
},
"datasets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"collection": {
"type": "string",
"enum": [
"alerts",
"incidents",
"incident_post_mortems",
"incident_action_items",
"users"
]
},
"filter": {
"type": "array",
"items": {
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": [
"and",
"or"
]
},
"condition": {
"type": "string",
"enum": [
"=",
"!=",
">=",
"<=",
"exists",
"not_exists",
"contains",
"not_contains",
"assigned",
"unassigned"
]
},
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
}
}
},
"group_by": {
"oneOf": [
{
"type": "string",
"nullable": true
},
{
"type": "object",
"properties": {
"key": {
"type": "string",
"enum": [
"custom_field",
"incident_role",
"alert_field"
]
},
"value": {
"type": "string"
}
},
"required": [
"key",
"value"
],
"nullable": true
}
]
},
"aggregate": {
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": [
"count",
"sum",
"average"
]
},
"key": {
"type": "string",
"nullable": true
},
"cumulative": {
"type": "boolean",
"nullable": true
}
},
"nullable": true
}
}
}
}
}
},
"position": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"w": {
"type": "number"
},
"h": {
"type": "number"
}
},
"required": [
"x",
"y",
"w",
"h"
],
"nullable": true
}
},
"additionalProperties": false,
"required": [
"params"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_dashboard_panel": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"dashboard_panels"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the dashboard_panel",
"nullable": true
},
"params": {
"type": "object",
"properties": {
"display": {
"type": "string",
"enum": [
"line_chart",
"line_stepped_chart",
"column_chart",
"stacked_column_chart",
"monitoring_chart",
"pie_chart",
"table",
"aggregate_value"
]
},
"description": {
"type": "string"
},
"table_fields": {
"type": "array",
"items": {
"type": "string"
}
},
"legend": {
"type": "object",
"properties": {
"groups": {
"type": "string",
"enum": [
"all",
"charted"
],
"default": "all"
}
}
},
"datalabels": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
}
}
},
"datasets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"collection": {
"type": "string",
"enum": [
"alerts",
"incidents",
"incident_post_mortems",
"incident_action_items",
"users"
]
},
"filter": {
"type": "array",
"items": {
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": [
"and",
"or"
]
},
"condition": {
"type": "string",
"enum": [
"=",
"!=",
">=",
"<=",
"exists",
"not_exists",
"contains",
"not_contains",
"assigned",
"unassigned"
]
},
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
}
}
},
"group_by": {
"oneOf": [
{
"type": "string",
"nullable": true
},
{
"type": "object",
"properties": {
"key": {
"type": "string",
"enum": [
"custom_field",
"incident_role",
"alert_field"
]
},
"value": {
"type": "string"
}
},
"required": [
"key",
"value"
],
"nullable": true
}
]
},
"aggregate": {
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": [
"count",
"sum",
"average"
]
},
"key": {
"type": "string",
"nullable": true
},
"cumulative": {
"type": "boolean",
"nullable": true
}
},
"nullable": true
}
}
}
}
}
},
"position": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"w": {
"type": "number"
},
"h": {
"type": "number"
}
},
"required": [
"x",
"y",
"w",
"h"
],
"nullable": true
}
},
"additionalProperties": false
}
}
}
},
"required": [
"data"
]
},
"dashboard_panel": {
"type": "object",
"properties": {
"dashboard_id": {
"type": "string",
"description": "The panel dashboard"
},
"name": {
"type": "string",
"description": "The name of the dashboard_panel",
"nullable": true
},
"params": {
"type": "object",
"properties": {
"display": {
"type": "string",
"enum": [
"line_chart",
"line_stepped_chart",
"column_chart",
"stacked_column_chart",
"monitoring_chart",
"pie_chart",
"table",
"aggregate_value"
]
},
"description": {
"type": "string"
},
"table_fields": {
"type": "array",
"items": {
"type": "string"
}
},
"legend": {
"type": "object",
"properties": {
"groups": {
"type": "string",
"enum": [
"all",
"charted"
],
"default": "all"
}
}
},
"datalabels": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
}
}
},
"datasets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"collection": {
"type": "string",
"enum": [
"alerts",
"incidents",
"incident_post_mortems",
"incident_action_items",
"users"
]
},
"filter": {
"type": "array",
"items": {
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": [
"and",
"or"
]
},
"rules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": [
"and",
"or"
]
},
"condition": {
"type": "string",
"enum": [
"=",
"!=",
">=",
"<=",
"exists",
"not_exists",
"contains",
"not_contains",
"assigned",
"unassigned"
]
},
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
}
}
},
"group_by": {
"oneOf": [
{
"type": "string",
"nullable": true
},
{
"type": "object",
"properties": {
"key": {
"type": "string",
"enum": [
"custom_field",
"incident_role",
"alert_field"
]
},
"value": {
"type": "string"
}
},
"required": [
"key",
"value"
],
"nullable": true
}
]
},
"aggregate": {
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": [
"count",
"sum",
"average"
]
},
"key": {
"type": "string",
"nullable": true
},
"cumulative": {
"type": "boolean",
"nullable": true
}
},
"nullable": true
}
}
}
}
}
},
"position": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"w": {
"type": "number"
},
"h": {
"type": "number"
}
},
"required": [
"x",
"y",
"w",
"h"
],
"nullable": true
},
"data": {
"type": "array",
"items": {
"type": "object"
}
}
},
"required": [
"params"
]
},
"dashboard_panel_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the dashboard_panel"
},
"type": {
"type": "string",
"enum": [
"dashboard_panels"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/dashboard_panel"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"dashboard_panel_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the dashboard_panel"
},
"type": {
"type": "string",
"enum": [
"dashboard_panels"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/dashboard_panel"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_dashboard": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"dashboards"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the dashboard"
},
"description": {
"type": "string",
"description": "The description of the dashboard",
"nullable": true
},
"owner": {
"type": "string",
"description": "The owner type of the dashboard",
"enum": [
"user",
"team"
]
},
"public": {
"type": "boolean",
"description": "Whether the dashboard is public"
},
"range": {
"type": "string",
"description": "The date range for dashboard panel data",
"nullable": true
},
"auto_refresh": {
"type": "boolean",
"description": "Whether the dashboard auto-updates the UI with new data."
},
"color": {
"type": "string",
"description": "The hex color of the dashboard",
"enum": [
"#FCF2CF",
"#D7F5E1",
"#E9E2FF",
"#FAE6E8",
"#FAEEE6"
],
"nullable": true
},
"icon": {
"type": "string",
"description": "The emoji icon of the dashboard"
},
"period": {
"type": "string",
"description": "The grouping period for dashboard panel data",
"enum": [
"day",
"week",
"month"
],
"nullable": true
}
},
"additionalProperties": false,
"required": [
"name",
"owner"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_dashboard": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"dashboards"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the dashboard"
},
"description": {
"type": "string",
"description": "The description of the dashboard",
"nullable": true
},
"owner": {
"type": "string",
"description": "The owner type of the dashboard",
"enum": [
"user",
"team"
]
},
"public": {
"type": "boolean",
"description": "Whether the dashboard is public"
},
"range": {
"type": "string",
"description": "The date range for dashboard panel data",
"nullable": true
},
"auto_refresh": {
"type": "boolean",
"description": "Whether the dashboard auto-updates the UI with new data."
},
"color": {
"type": "string",
"description": "The hex color of the dashboard",
"enum": [
"#FCF2CF",
"#D7F5E1",
"#E9E2FF",
"#FAE6E8",
"#FAEEE6"
],
"nullable": true
},
"icon": {
"type": "string",
"description": "The emoji icon of the dashboard"
},
"period": {
"type": "string",
"description": "The grouping period for dashboard panel data",
"enum": [
"day",
"week",
"month"
],
"nullable": true
}
},
"additionalProperties": false
}
}
}
},
"required": [
"data"
]
},
"dashboard": {
"type": "object",
"properties": {
"team_id": {
"type": "integer",
"description": "The dashboard team"
},
"user_id": {
"type": "integer",
"description": "The dashboard user owner if owner is of type user",
"nullable": true
},
"name": {
"type": "string",
"description": "The name of the dashboard"
},
"description": {
"type": "string",
"description": "The description of the dashboard",
"nullable": true
},
"owner": {
"type": "string",
"description": "The owner type of the dashboard",
"enum": [
"user",
"team"
]
},
"public": {
"type": "boolean",
"description": "Whether the dashboard is public"
},
"range": {
"type": "string",
"description": "The date range for dashboard panel data",
"nullable": true
},
"period": {
"type": "string",
"description": "The grouping period for dashboard panel data",
"nullable": true
},
"auto_refresh": {
"type": "boolean",
"description": "Whether the dashboard auto-updates the UI with new data."
},
"color": {
"type": "string",
"description": "The hex color of the dashboard",
"enum": [
"#FCF2CF",
"#D7F5E1",
"#E9E2FF",
"#FAE6E8",
"#FAEEE6"
],
"nullable": true
},
"icon": {
"type": "string",
"description": "The emoji icon of the dashboard"
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"name",
"owner",
"public"
]
},
"dashboard_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the dashboard"
},
"type": {
"type": "string",
"enum": [
"dashboards"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/dashboard"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"dashboard_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the dashboard"
},
"type": {
"type": "string",
"enum": [
"dashboards"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/dashboard"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"edge_connector": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"edge_connectors"
]
},
"id": {
"type": "string",
"format": "uuid"
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Connector name"
},
"description": {
"type": "string",
"description": "Connector description",
"nullable": true
},
"status": {
"type": "string",
"enum": [
"active",
"paused"
],
"description": "Connector status"
},
"subscriptions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of event types to subscribe to"
},
"last_poll_at": {
"type": "string",
"format": "date-time",
"description": "Last time connector polled",
"nullable": true
},
"online": {
"type": "boolean",
"description": "Whether connector is currently online"
},
"deliveries_count": {
"type": "integer",
"description": "Total number of deliveries"
},
"deliveries_queued_count": {
"type": "integer",
"description": "Number of queued deliveries"
},
"deliveries_running_count": {
"type": "integer",
"description": "Number of running deliveries"
},
"deliveries_completed_count": {
"type": "integer",
"description": "Number of completed deliveries"
},
"deliveries_failed_count": {
"type": "integer",
"description": "Number of failed deliveries"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
}
},
"required": [
"name",
"status"
]
}
},
"required": [
"type",
"id",
"attributes"
]
}
},
"required": [
"data"
]
},
"new_edge_connector": {
"type": "object",
"properties": {
"edge_connector": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Connector name"
},
"description": {
"type": "string",
"description": "Connector description",
"nullable": true
},
"status": {
"type": "string",
"enum": [
"active",
"paused"
],
"description": "Connector status"
},
"subscriptions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of event types to subscribe to"
}
},
"required": [
"name"
]
}
},
"required": [
"edge_connector"
]
},
"update_edge_connector": {
"type": "object",
"properties": {
"edge_connector": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"active",
"paused"
]
},
"subscriptions": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"required": [
"edge_connector"
]
},
"edge_connector_action": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"edge_connector_actions"
]
},
"id": {
"type": "string",
"format": "uuid"
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Action name"
},
"slug": {
"type": "string",
"description": "Action slug"
},
"action_type": {
"type": "string",
"enum": [
"script",
"http"
],
"description": "Action type"
},
"icon": {
"type": "string",
"description": "Action icon",
"nullable": true,
"enum": [
"bolt",
"bolt-slash",
"cog",
"command-line",
"code-bracket",
"server",
"server-stack",
"play",
"arrow-path",
"wrench-screwdriver",
"cube",
"rocket-launch"
]
},
"description": {
"type": "string",
"description": "Action description",
"nullable": true
},
"timeout": {
"type": "integer",
"description": "Timeout in seconds",
"nullable": true
},
"parameters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"boolean"
]
},
"required": {
"type": "boolean"
},
"description": {
"type": "string",
"nullable": true
},
"default": {
"type": "string",
"description": "Default value (any type)",
"nullable": true
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
}
},
"description": "Parameter definitions",
"nullable": true
},
"last_executed_at": {
"type": "string",
"format": "date-time",
"nullable": true
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
}
},
"required": [
"name",
"action_type"
]
}
},
"required": [
"type",
"id",
"attributes"
]
}
},
"required": [
"data"
]
},
"new_edge_connector_action": {
"type": "object",
"properties": {
"action": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Action name"
},
"action_type": {
"type": "string",
"enum": [
"script",
"http"
],
"description": "Action type"
},
"metadata": {
"type": "object",
"properties": {
"description": {
"type": "string",
"nullable": true
},
"timeout": {
"type": "integer",
"nullable": true
},
"icon": {
"type": "string",
"enum": [
"bolt",
"bolt-slash",
"cog",
"command-line",
"code-bracket",
"server",
"server-stack",
"play",
"arrow-path",
"wrench-screwdriver",
"cube",
"rocket-launch"
],
"nullable": true
},
"parameters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"boolean"
]
},
"required": {
"type": "boolean"
},
"description": {
"type": "string",
"nullable": true
},
"default": {
"type": "string",
"description": "Default value (any type)",
"nullable": true
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
}
},
"nullable": true
}
}
}
},
"required": [
"name",
"action_type"
]
}
},
"required": [
"action"
]
},
"update_edge_connector_action": {
"type": "object",
"properties": {
"action": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"action_type": {
"type": "string",
"enum": [
"script",
"http"
]
},
"metadata": {
"type": "object"
}
}
}
},
"required": [
"action"
]
},
"new_environment": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"environments"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the environment"
},
"description": {
"type": "string",
"description": "The description of the environment",
"nullable": true
},
"color": {
"type": "string",
"description": "The hex color of the environment",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the environment",
"nullable": true
},
"notify_emails": {
"type": "array",
"description": "Emails to attach to the environment",
"items": {
"type": "string"
},
"nullable": true
},
"slack_channels": {
"type": "array",
"description": "Slack Channels associated with this environment",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack channel ID"
},
"name": {
"type": "string",
"description": "Slack channel name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
},
"slack_aliases": {
"type": "array",
"description": "Slack Aliases associated with this environment",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack alias ID"
},
"name": {
"type": "string",
"description": "Slack alias name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
},
"properties": {
"type": "array",
"items": {
"type": "object",
"description": "Set a value for a catalog property",
"properties": {
"catalog_property_id": {
"type": "string",
"description": "Catalog property ID"
},
"value": {
"type": "string",
"description": "The property value"
}
},
"required": [
"catalog_property_id",
"value"
]
},
"description": "Array of property values for this environment."
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_environment": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"environments"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the environment"
},
"description": {
"type": "string",
"description": "The description of the environment",
"nullable": true
},
"color": {
"type": "string",
"description": "The hex color of the environment",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the environment",
"nullable": true
},
"notify_emails": {
"type": "array",
"description": "Emails to attach to the environment",
"items": {
"type": "string"
},
"nullable": true
},
"slack_channels": {
"type": "array",
"description": "Slack Channels associated with this environment",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack channel ID"
},
"name": {
"type": "string",
"description": "Slack channel name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
},
"slack_aliases": {
"type": "array",
"description": "Slack Aliases associated with this environment",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack alias ID"
},
"name": {
"type": "string",
"description": "Slack alias name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
},
"properties": {
"type": "array",
"items": {
"type": "object",
"description": "Set a value for a catalog property",
"properties": {
"catalog_property_id": {
"type": "string",
"description": "Catalog property ID"
},
"value": {
"type": "string",
"description": "The property value"
}
},
"required": [
"catalog_property_id",
"value"
]
},
"description": "Array of property values for this environment."
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"environment": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the environment"
},
"slug": {
"type": "string",
"description": "The slug of the environment"
},
"description": {
"type": "string",
"description": "The description of the environment",
"nullable": true
},
"notify_emails": {
"type": "array",
"description": "Emails attached to the environment",
"items": {
"type": "string"
},
"nullable": true
},
"color": {
"type": "string",
"description": "The hex color of the environment",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the environment",
"nullable": true
},
"slack_channels": {
"type": "array",
"description": "Slack Channels associated with this environment",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack channel ID"
},
"name": {
"type": "string",
"description": "Slack channel name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
},
"slack_aliases": {
"type": "array",
"description": "Slack Aliases associated with this environment",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack alias ID"
},
"name": {
"type": "string",
"description": "Slack alias name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
},
"properties": {
"type": "array",
"items": {
"type": "object",
"description": "Set a value for a catalog property",
"properties": {
"catalog_property_id": {
"type": "string",
"description": "Catalog property ID"
},
"value": {
"type": "string",
"description": "The property value"
}
},
"required": [
"catalog_property_id",
"value"
]
},
"description": "Array of property values for this environment.",
"nullable": true
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"name",
"created_at",
"updated_at"
]
},
"environment_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the environment"
},
"type": {
"type": "string",
"enum": [
"environments"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/environment"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"environment_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the environment"
},
"type": {
"type": "string",
"enum": [
"environments"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/environment"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"errors_list": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"status": {
"type": "string"
},
"code": {
"type": "string",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
}
},
"required": [
"title",
"status"
]
}
}
}
},
"new_escalation_policy": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"escalation_policies"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the escalation policy"
},
"description": {
"type": "string",
"description": "The description of the escalation policy",
"nullable": true
},
"repeat_count": {
"type": "integer",
"description": "The number of times this policy will be executed until someone acknowledges the alert"
},
"group_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Associated groups (alerting the group will trigger escalation policy)"
},
"service_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Associated services (alerting the service will trigger escalation policy)"
},
"business_hours": {
"type": "object",
"properties": {
"time_zone": {
"type": "string",
"description": "Time zone for business hours",
"enum": [
"International Date Line West",
"Etc/GMT+12",
"American Samoa",
"Pacific/Pago_Pago",
"Midway Island",
"Pacific/Midway",
"Hawaii",
"Pacific/Honolulu",
"Alaska",
"America/Juneau",
"Pacific Time (US & Canada)",
"America/Los_Angeles",
"Tijuana",
"America/Tijuana",
"Arizona",
"America/Phoenix",
"Mazatlan",
"America/Mazatlan",
"Mountain Time (US & Canada)",
"America/Denver",
"Central America",
"America/Guatemala",
"Central Time (US & Canada)",
"America/Chicago",
"Chihuahua",
"America/Chihuahua",
"Guadalajara",
"America/Mexico_City",
"Mexico City",
"Monterrey",
"America/Monterrey",
"Saskatchewan",
"America/Regina",
"Bogota",
"America/Bogota",
"Eastern Time (US & Canada)",
"America/New_York",
"Indiana (East)",
"America/Indiana/Indianapolis",
"Lima",
"America/Lima",
"Quito",
"Atlantic Time (Canada)",
"America/Halifax",
"Caracas",
"America/Caracas",
"Georgetown",
"America/Guyana",
"La Paz",
"America/La_Paz",
"Puerto Rico",
"America/Puerto_Rico",
"Santiago",
"America/Santiago",
"Newfoundland",
"America/St_Johns",
"Asuncion",
"America/Asuncion",
"Brasilia",
"America/Sao_Paulo",
"Buenos Aires",
"America/Argentina/Buenos_Aires",
"Montevideo",
"America/Montevideo",
"Greenland",
"America/Nuuk",
"Mid-Atlantic",
"Atlantic/South_Georgia",
"Azores",
"Atlantic/Azores",
"Cape Verde Is.",
"Atlantic/Cape_Verde",
"Edinburgh",
"Europe/London",
"Lisbon",
"Europe/Lisbon",
"London",
"Monrovia",
"Africa/Monrovia",
"UTC",
"Etc/UTC",
"Amsterdam",
"Europe/Amsterdam",
"Belgrade",
"Europe/Belgrade",
"Berlin",
"Europe/Berlin",
"Bern",
"Europe/Zurich",
"Bratislava",
"Europe/Bratislava",
"Brussels",
"Europe/Brussels",
"Budapest",
"Europe/Budapest",
"Casablanca",
"Africa/Casablanca",
"Copenhagen",
"Europe/Copenhagen",
"Dublin",
"Europe/Dublin",
"Ljubljana",
"Europe/Ljubljana",
"Madrid",
"Europe/Madrid",
"Paris",
"Europe/Paris",
"Prague",
"Europe/Prague",
"Rome",
"Europe/Rome",
"Sarajevo",
"Europe/Sarajevo",
"Skopje",
"Europe/Skopje",
"Stockholm",
"Europe/Stockholm",
"Vienna",
"Europe/Vienna",
"Warsaw",
"Europe/Warsaw",
"West Central Africa",
"Africa/Algiers",
"Zagreb",
"Europe/Zagreb",
"Zurich",
"Athens",
"Europe/Athens",
"Bucharest",
"Europe/Bucharest",
"Cairo",
"Africa/Cairo",
"Harare",
"Africa/Harare",
"Helsinki",
"Europe/Helsinki",
"Jerusalem",
"Asia/Jerusalem",
"Kaliningrad",
"Europe/Kaliningrad",
"Kyiv",
"Europe/Kiev",
"Pretoria",
"Africa/Johannesburg",
"Riga",
"Europe/Riga",
"Sofia",
"Europe/Sofia",
"Tallinn",
"Europe/Tallinn",
"Vilnius",
"Europe/Vilnius",
"Baghdad",
"Asia/Baghdad",
"Istanbul",
"Europe/Istanbul",
"Kuwait",
"Asia/Kuwait",
"Minsk",
"Europe/Minsk",
"Moscow",
"Europe/Moscow",
"Nairobi",
"Africa/Nairobi",
"Riyadh",
"Asia/Riyadh",
"St. Petersburg",
"Volgograd",
"Europe/Volgograd",
"Tehran",
"Asia/Tehran",
"Abu Dhabi",
"Asia/Muscat",
"Baku",
"Asia/Baku",
"Muscat",
"Samara",
"Europe/Samara",
"Tbilisi",
"Asia/Tbilisi",
"Yerevan",
"Asia/Yerevan",
"Kabul",
"Asia/Kabul",
"Almaty",
"Asia/Almaty",
"Astana",
"Ekaterinburg",
"Asia/Yekaterinburg",
"Islamabad",
"Asia/Karachi",
"Karachi",
"Tashkent",
"Asia/Tashkent",
"Chennai",
"Asia/Kolkata",
"Kolkata",
"Mumbai",
"New Delhi",
"Sri Jayawardenepura",
"Asia/Colombo",
"Kathmandu",
"Asia/Kathmandu",
"Dhaka",
"Asia/Dhaka",
"Urumqi",
"Asia/Urumqi",
"Rangoon",
"Asia/Rangoon",
"Bangkok",
"Asia/Bangkok",
"Hanoi",
"Jakarta",
"Asia/Jakarta",
"Krasnoyarsk",
"Asia/Krasnoyarsk",
"Novosibirsk",
"Asia/Novosibirsk",
"Beijing",
"Asia/Shanghai",
"Chongqing",
"Asia/Chongqing",
"Hong Kong",
"Asia/Hong_Kong",
"Irkutsk",
"Asia/Irkutsk",
"Kuala Lumpur",
"Asia/Kuala_Lumpur",
"Perth",
"Australia/Perth",
"Singapore",
"Asia/Singapore",
"Taipei",
"Asia/Taipei",
"Ulaanbaatar",
"Asia/Ulaanbaatar",
"Osaka",
"Asia/Tokyo",
"Sapporo",
"Seoul",
"Asia/Seoul",
"Tokyo",
"Yakutsk",
"Asia/Yakutsk",
"Adelaide",
"Australia/Adelaide",
"Darwin",
"Australia/Darwin",
"Brisbane",
"Australia/Brisbane",
"Canberra",
"Australia/Canberra",
"Guam",
"Pacific/Guam",
"Hobart",
"Australia/Hobart",
"Melbourne",
"Australia/Melbourne",
"Port Moresby",
"Pacific/Port_Moresby",
"Sydney",
"Australia/Sydney",
"Vladivostok",
"Asia/Vladivostok",
"Magadan",
"Asia/Magadan",
"New Caledonia",
"Pacific/Noumea",
"Solomon Is.",
"Pacific/Guadalcanal",
"Srednekolymsk",
"Asia/Srednekolymsk",
"Auckland",
"Pacific/Auckland",
"Fiji",
"Pacific/Fiji",
"Kamchatka",
"Asia/Kamchatka",
"Marshall Is.",
"Pacific/Majuro",
"Wellington",
"Chatham Is.",
"Pacific/Chatham",
"Nuku'alofa",
"Pacific/Tongatapu",
"Samoa",
"Pacific/Apia",
"Tokelau Is.",
"Pacific/Fakaofo",
"America/Adak",
"America/Atka",
"US/Aleutian",
"America/Vancouver",
"Canada/Pacific",
"America/Miquelon",
"Australia/Eucla",
"Australia/LHI",
"Australia/Lord_Howe",
"Chile/EasterIsland",
"Pacific/Easter",
"Pacific/Gambier",
"Pacific/Pitcairn",
"Pacific/Marquesas",
"Pacific/Kiritimati",
"Pacific/Norfolk"
],
"nullable": true
},
"days": {
"type": "array",
"items": {
"type": "string",
"enum": [
"M",
"T",
"W",
"R",
"F",
"U",
"S"
]
},
"description": "Business days",
"nullable": true
},
"start_time": {
"type": "string",
"description": "Start time for business hours (HH:MM)",
"nullable": true
},
"end_time": {
"type": "string",
"description": "End time for business hours (HH:MM)",
"nullable": true
}
},
"nullable": true
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_escalation_policy": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"escalation_policies"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the escalation policy"
},
"description": {
"type": "string",
"description": "The description of the escalation policy",
"nullable": true
},
"repeat_count": {
"type": "integer",
"description": "The number of times this policy will be executed until someone acknowledges the alert"
},
"group_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Associated groups (alerting the group will trigger escalation policy)"
},
"service_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Associated services (alerting the service will trigger escalation policy)"
},
"business_hours": {
"type": "object",
"properties": {
"time_zone": {
"type": "string",
"description": "Time zone for business hours",
"enum": [
"International Date Line West",
"Etc/GMT+12",
"American Samoa",
"Pacific/Pago_Pago",
"Midway Island",
"Pacific/Midway",
"Hawaii",
"Pacific/Honolulu",
"Alaska",
"America/Juneau",
"Pacific Time (US & Canada)",
"America/Los_Angeles",
"Tijuana",
"America/Tijuana",
"Arizona",
"America/Phoenix",
"Mazatlan",
"America/Mazatlan",
"Mountain Time (US & Canada)",
"America/Denver",
"Central America",
"America/Guatemala",
"Central Time (US & Canada)",
"America/Chicago",
"Chihuahua",
"America/Chihuahua",
"Guadalajara",
"America/Mexico_City",
"Mexico City",
"Monterrey",
"America/Monterrey",
"Saskatchewan",
"America/Regina",
"Bogota",
"America/Bogota",
"Eastern Time (US & Canada)",
"America/New_York",
"Indiana (East)",
"America/Indiana/Indianapolis",
"Lima",
"America/Lima",
"Quito",
"Atlantic Time (Canada)",
"America/Halifax",
"Caracas",
"America/Caracas",
"Georgetown",
"America/Guyana",
"La Paz",
"America/La_Paz",
"Puerto Rico",
"America/Puerto_Rico",
"Santiago",
"America/Santiago",
"Newfoundland",
"America/St_Johns",
"Asuncion",
"America/Asuncion",
"Brasilia",
"America/Sao_Paulo",
"Buenos Aires",
"America/Argentina/Buenos_Aires",
"Montevideo",
"America/Montevideo",
"Greenland",
"America/Nuuk",
"Mid-Atlantic",
"Atlantic/South_Georgia",
"Azores",
"Atlantic/Azores",
"Cape Verde Is.",
"Atlantic/Cape_Verde",
"Edinburgh",
"Europe/London",
"Lisbon",
"Europe/Lisbon",
"London",
"Monrovia",
"Africa/Monrovia",
"UTC",
"Etc/UTC",
"Amsterdam",
"Europe/Amsterdam",
"Belgrade",
"Europe/Belgrade",
"Berlin",
"Europe/Berlin",
"Bern",
"Europe/Zurich",
"Bratislava",
"Europe/Bratislava",
"Brussels",
"Europe/Brussels",
"Budapest",
"Europe/Budapest",
"Casablanca",
"Africa/Casablanca",
"Copenhagen",
"Europe/Copenhagen",
"Dublin",
"Europe/Dublin",
"Ljubljana",
"Europe/Ljubljana",
"Madrid",
"Europe/Madrid",
"Paris",
"Europe/Paris",
"Prague",
"Europe/Prague",
"Rome",
"Europe/Rome",
"Sarajevo",
"Europe/Sarajevo",
"Skopje",
"Europe/Skopje",
"Stockholm",
"Europe/Stockholm",
"Vienna",
"Europe/Vienna",
"Warsaw",
"Europe/Warsaw",
"West Central Africa",
"Africa/Algiers",
"Zagreb",
"Europe/Zagreb",
"Zurich",
"Athens",
"Europe/Athens",
"Bucharest",
"Europe/Bucharest",
"Cairo",
"Africa/Cairo",
"Harare",
"Africa/Harare",
"Helsinki",
"Europe/Helsinki",
"Jerusalem",
"Asia/Jerusalem",
"Kaliningrad",
"Europe/Kaliningrad",
"Kyiv",
"Europe/Kiev",
"Pretoria",
"Africa/Johannesburg",
"Riga",
"Europe/Riga",
"Sofia",
"Europe/Sofia",
"Tallinn",
"Europe/Tallinn",
"Vilnius",
"Europe/Vilnius",
"Baghdad",
"Asia/Baghdad",
"Istanbul",
"Europe/Istanbul",
"Kuwait",
"Asia/Kuwait",
"Minsk",
"Europe/Minsk",
"Moscow",
"Europe/Moscow",
"Nairobi",
"Africa/Nairobi",
"Riyadh",
"Asia/Riyadh",
"St. Petersburg",
"Volgograd",
"Europe/Volgograd",
"Tehran",
"Asia/Tehran",
"Abu Dhabi",
"Asia/Muscat",
"Baku",
"Asia/Baku",
"Muscat",
"Samara",
"Europe/Samara",
"Tbilisi",
"Asia/Tbilisi",
"Yerevan",
"Asia/Yerevan",
"Kabul",
"Asia/Kabul",
"Almaty",
"Asia/Almaty",
"Astana",
"Ekaterinburg",
"Asia/Yekaterinburg",
"Islamabad",
"Asia/Karachi",
"Karachi",
"Tashkent",
"Asia/Tashkent",
"Chennai",
"Asia/Kolkata",
"Kolkata",
"Mumbai",
"New Delhi",
"Sri Jayawardenepura",
"Asia/Colombo",
"Kathmandu",
"Asia/Kathmandu",
"Dhaka",
"Asia/Dhaka",
"Urumqi",
"Asia/Urumqi",
"Rangoon",
"Asia/Rangoon",
"Bangkok",
"Asia/Bangkok",
"Hanoi",
"Jakarta",
"Asia/Jakarta",
"Krasnoyarsk",
"Asia/Krasnoyarsk",
"Novosibirsk",
"Asia/Novosibirsk",
"Beijing",
"Asia/Shanghai",
"Chongqing",
"Asia/Chongqing",
"Hong Kong",
"Asia/Hong_Kong",
"Irkutsk",
"Asia/Irkutsk",
"Kuala Lumpur",
"Asia/Kuala_Lumpur",
"Perth",
"Australia/Perth",
"Singapore",
"Asia/Singapore",
"Taipei",
"Asia/Taipei",
"Ulaanbaatar",
"Asia/Ulaanbaatar",
"Osaka",
"Asia/Tokyo",
"Sapporo",
"Seoul",
"Asia/Seoul",
"Tokyo",
"Yakutsk",
"Asia/Yakutsk",
"Adelaide",
"Australia/Adelaide",
"Darwin",
"Australia/Darwin",
"Brisbane",
"Australia/Brisbane",
"Canberra",
"Australia/Canberra",
"Guam",
"Pacific/Guam",
"Hobart",
"Australia/Hobart",
"Melbourne",
"Australia/Melbourne",
"Port Moresby",
"Pacific/Port_Moresby",
"Sydney",
"Australia/Sydney",
"Vladivostok",
"Asia/Vladivostok",
"Magadan",
"Asia/Magadan",
"New Caledonia",
"Pacific/Noumea",
"Solomon Is.",
"Pacific/Guadalcanal",
"Srednekolymsk",
"Asia/Srednekolymsk",
"Auckland",
"Pacific/Auckland",
"Fiji",
"Pacific/Fiji",
"Kamchatka",
"Asia/Kamchatka",
"Marshall Is.",
"Pacific/Majuro",
"Wellington",
"Chatham Is.",
"Pacific/Chatham",
"Nuku'alofa",
"Pacific/Tongatapu",
"Samoa",
"Pacific/Apia",
"Tokelau Is.",
"Pacific/Fakaofo",
"America/Adak",
"America/Atka",
"US/Aleutian",
"America/Vancouver",
"Canada/Pacific",
"America/Miquelon",
"Australia/Eucla",
"Australia/LHI",
"Australia/Lord_Howe",
"Chile/EasterIsland",
"Pacific/Easter",
"Pacific/Gambier",
"Pacific/Pitcairn",
"Pacific/Marquesas",
"Pacific/Kiritimati",
"Pacific/Norfolk"
],
"nullable": true
},
"days": {
"type": "array",
"items": {
"type": "string",
"enum": [
"M",
"T",
"W",
"R",
"F",
"U",
"S"
]
},
"description": "Business days",
"nullable": true
},
"start_time": {
"type": "string",
"description": "Start time for business hours (HH:MM)",
"nullable": true
},
"end_time": {
"type": "string",
"description": "End time for business hours (HH:MM)",
"nullable": true
}
},
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"escalation_policy": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the escalation policy"
},
"description": {
"type": "string",
"description": "The description of the escalation policy",
"nullable": true
},
"repeat_count": {
"type": "integer",
"description": "The number of times this policy will be executed until someone acknowledges the alert"
},
"created_by_user_id": {
"type": "integer",
"description": "User who created the escalation policy"
},
"last_updated_by_user_id": {
"type": "integer",
"description": "User who updated the escalation policy"
},
"group_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Associated groups (alerting the group will trigger escalation policy)"
},
"service_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Associated services (alerting the service will trigger escalation policy)"
},
"business_hours": {
"type": "object",
"properties": {
"time_zone": {
"type": "string",
"description": "Time zone for business hours",
"enum": [
"International Date Line West",
"Etc/GMT+12",
"American Samoa",
"Pacific/Pago_Pago",
"Midway Island",
"Pacific/Midway",
"Hawaii",
"Pacific/Honolulu",
"Alaska",
"America/Juneau",
"Pacific Time (US & Canada)",
"America/Los_Angeles",
"Tijuana",
"America/Tijuana",
"Arizona",
"America/Phoenix",
"Mazatlan",
"America/Mazatlan",
"Mountain Time (US & Canada)",
"America/Denver",
"Central America",
"America/Guatemala",
"Central Time (US & Canada)",
"America/Chicago",
"Chihuahua",
"America/Chihuahua",
"Guadalajara",
"America/Mexico_City",
"Mexico City",
"Monterrey",
"America/Monterrey",
"Saskatchewan",
"America/Regina",
"Bogota",
"America/Bogota",
"Eastern Time (US & Canada)",
"America/New_York",
"Indiana (East)",
"America/Indiana/Indianapolis",
"Lima",
"America/Lima",
"Quito",
"Atlantic Time (Canada)",
"America/Halifax",
"Caracas",
"America/Caracas",
"Georgetown",
"America/Guyana",
"La Paz",
"America/La_Paz",
"Puerto Rico",
"America/Puerto_Rico",
"Santiago",
"America/Santiago",
"Newfoundland",
"America/St_Johns",
"Asuncion",
"America/Asuncion",
"Brasilia",
"America/Sao_Paulo",
"Buenos Aires",
"America/Argentina/Buenos_Aires",
"Montevideo",
"America/Montevideo",
"Greenland",
"America/Nuuk",
"Mid-Atlantic",
"Atlantic/South_Georgia",
"Azores",
"Atlantic/Azores",
"Cape Verde Is.",
"Atlantic/Cape_Verde",
"Edinburgh",
"Europe/London",
"Lisbon",
"Europe/Lisbon",
"London",
"Monrovia",
"Africa/Monrovia",
"UTC",
"Etc/UTC",
"Amsterdam",
"Europe/Amsterdam",
"Belgrade",
"Europe/Belgrade",
"Berlin",
"Europe/Berlin",
"Bern",
"Europe/Zurich",
"Bratislava",
"Europe/Bratislava",
"Brussels",
"Europe/Brussels",
"Budapest",
"Europe/Budapest",
"Casablanca",
"Africa/Casablanca",
"Copenhagen",
"Europe/Copenhagen",
"Dublin",
"Europe/Dublin",
"Ljubljana",
"Europe/Ljubljana",
"Madrid",
"Europe/Madrid",
"Paris",
"Europe/Paris",
"Prague",
"Europe/Prague",
"Rome",
"Europe/Rome",
"Sarajevo",
"Europe/Sarajevo",
"Skopje",
"Europe/Skopje",
"Stockholm",
"Europe/Stockholm",
"Vienna",
"Europe/Vienna",
"Warsaw",
"Europe/Warsaw",
"West Central Africa",
"Africa/Algiers",
"Zagreb",
"Europe/Zagreb",
"Zurich",
"Athens",
"Europe/Athens",
"Bucharest",
"Europe/Bucharest",
"Cairo",
"Africa/Cairo",
"Harare",
"Africa/Harare",
"Helsinki",
"Europe/Helsinki",
"Jerusalem",
"Asia/Jerusalem",
"Kaliningrad",
"Europe/Kaliningrad",
"Kyiv",
"Europe/Kiev",
"Pretoria",
"Africa/Johannesburg",
"Riga",
"Europe/Riga",
"Sofia",
"Europe/Sofia",
"Tallinn",
"Europe/Tallinn",
"Vilnius",
"Europe/Vilnius",
"Baghdad",
"Asia/Baghdad",
"Istanbul",
"Europe/Istanbul",
"Kuwait",
"Asia/Kuwait",
"Minsk",
"Europe/Minsk",
"Moscow",
"Europe/Moscow",
"Nairobi",
"Africa/Nairobi",
"Riyadh",
"Asia/Riyadh",
"St. Petersburg",
"Volgograd",
"Europe/Volgograd",
"Tehran",
"Asia/Tehran",
"Abu Dhabi",
"Asia/Muscat",
"Baku",
"Asia/Baku",
"Muscat",
"Samara",
"Europe/Samara",
"Tbilisi",
"Asia/Tbilisi",
"Yerevan",
"Asia/Yerevan",
"Kabul",
"Asia/Kabul",
"Almaty",
"Asia/Almaty",
"Astana",
"Ekaterinburg",
"Asia/Yekaterinburg",
"Islamabad",
"Asia/Karachi",
"Karachi",
"Tashkent",
"Asia/Tashkent",
"Chennai",
"Asia/Kolkata",
"Kolkata",
"Mumbai",
"New Delhi",
"Sri Jayawardenepura",
"Asia/Colombo",
"Kathmandu",
"Asia/Kathmandu",
"Dhaka",
"Asia/Dhaka",
"Urumqi",
"Asia/Urumqi",
"Rangoon",
"Asia/Rangoon",
"Bangkok",
"Asia/Bangkok",
"Hanoi",
"Jakarta",
"Asia/Jakarta",
"Krasnoyarsk",
"Asia/Krasnoyarsk",
"Novosibirsk",
"Asia/Novosibirsk",
"Beijing",
"Asia/Shanghai",
"Chongqing",
"Asia/Chongqing",
"Hong Kong",
"Asia/Hong_Kong",
"Irkutsk",
"Asia/Irkutsk",
"Kuala Lumpur",
"Asia/Kuala_Lumpur",
"Perth",
"Australia/Perth",
"Singapore",
"Asia/Singapore",
"Taipei",
"Asia/Taipei",
"Ulaanbaatar",
"Asia/Ulaanbaatar",
"Osaka",
"Asia/Tokyo",
"Sapporo",
"Seoul",
"Asia/Seoul",
"Tokyo",
"Yakutsk",
"Asia/Yakutsk",
"Adelaide",
"Australia/Adelaide",
"Darwin",
"Australia/Darwin",
"Brisbane",
"Australia/Brisbane",
"Canberra",
"Australia/Canberra",
"Guam",
"Pacific/Guam",
"Hobart",
"Australia/Hobart",
"Melbourne",
"Australia/Melbourne",
"Port Moresby",
"Pacific/Port_Moresby",
"Sydney",
"Australia/Sydney",
"Vladivostok",
"Asia/Vladivostok",
"Magadan",
"Asia/Magadan",
"New Caledonia",
"Pacific/Noumea",
"Solomon Is.",
"Pacific/Guadalcanal",
"Srednekolymsk",
"Asia/Srednekolymsk",
"Auckland",
"Pacific/Auckland",
"Fiji",
"Pacific/Fiji",
"Kamchatka",
"Asia/Kamchatka",
"Marshall Is.",
"Pacific/Majuro",
"Wellington",
"Chatham Is.",
"Pacific/Chatham",
"Nuku'alofa",
"Pacific/Tongatapu",
"Samoa",
"Pacific/Apia",
"Tokelau Is.",
"Pacific/Fakaofo",
"America/Adak",
"America/Atka",
"US/Aleutian",
"America/Vancouver",
"Canada/Pacific",
"America/Miquelon",
"Australia/Eucla",
"Australia/LHI",
"Australia/Lord_Howe",
"Chile/EasterIsland",
"Pacific/Easter",
"Pacific/Gambier",
"Pacific/Pitcairn",
"Pacific/Marquesas",
"Pacific/Kiritimati",
"Pacific/Norfolk"
],
"nullable": true
},
"days": {
"type": "array",
"items": {
"type": "string",
"enum": [
"M",
"T",
"W",
"R",
"F",
"U",
"S"
]
},
"description": "Business days",
"nullable": true
},
"start_time": {
"type": "string",
"description": "Start time for business hours (HH:MM)",
"nullable": true
},
"end_time": {
"type": "string",
"description": "End time for business hours (HH:MM)",
"nullable": true
}
},
"nullable": true
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"name",
"repeat_count",
"created_by_user_id"
]
},
"escalation_policy_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the escalation policy"
},
"type": {
"type": "string",
"enum": [
"escalation_policies"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/escalation_policy"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"escalation_policy_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the escalation policy"
},
"type": {
"type": "string",
"enum": [
"escalation_policies"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/escalation_policy"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_escalation_policy_path": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"escalation_paths"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the escalation path"
},
"notification_type": {
"type": "string",
"description": "Notification rule type to be used",
"enum": [
"audible",
"quiet"
],
"default": "audible"
},
"path_type": {
"type": "string",
"description": "The type of escalation path to create",
"enum": [
"escalation",
"deferral"
],
"default": "escalation"
},
"after_deferral_behavior": {
"type": "string",
"description": "What happens after a deferral path finishes. Required for deferral paths.",
"enum": [
"re_evaluate",
"execute_path"
],
"nullable": true
},
"after_deferral_path_id": {
"type": "string",
"description": "The escalation path to execute after this deferral path when after_deferral_behavior is execute_path.",
"nullable": true
},
"default": {
"type": "boolean",
"description": "Whether this escalation path is the default path",
"nullable": true
},
"match_mode": {
"type": "string",
"description": "How path rules are matched.",
"enum": [
"match-all-rules",
"match-any-rule"
],
"default": "match-all-rules"
},
"position": {
"type": "integer",
"description": "The position of this path in the paths for this EP."
},
"repeat": {
"type": "boolean",
"description": "Whether this path should be repeated until someone acknowledges the alert",
"nullable": true
},
"repeat_count": {
"type": "integer",
"description": "The number of times this path will be executed until someone acknowledges the alert",
"nullable": true
},
"initial_delay": {
"type": "integer",
"description": "Initial delay for escalation path in minutes. Maximum 1 week (10080)."
},
"rules": {
"type": "array",
"description": "Escalation path conditions",
"items": {
"type": "object",
"oneOf": [
{
"properties": {
"rule_type": {
"type": "string",
"description": "The type of the escalation path rule",
"enum": [
"alert_urgency"
]
},
"urgency_ids": {
"type": "array",
"description": "Alert urgency ids for which this escalation path should be used",
"items": {
"type": "string"
}
}
},
"required": [
"rule_type",
"urgency_ids"
]
},
{
"properties": {
"rule_type": {
"type": "string",
"description": "The type of the escalation path rule",
"enum": [
"working_hour"
]
},
"within_working_hour": {
"type": "boolean",
"description": "Whether the escalation path should be used within working hours"
}
},
"required": [
"rule_type",
"within_working_hour"
]
},
{
"properties": {
"rule_type": {
"type": "string",
"description": "The type of the escalation path rule",
"enum": [
"json_path"
]
},
"json_path": {
"type": "string",
"description": "JSON path to extract value from payload"
},
"operator": {
"type": "string",
"description": "How JSON path value should be matched",
"enum": [
"is",
"is_not",
"contains",
"does_not_contain",
"is_one_of",
"is_not_one_of",
"is_set",
"is_not_set"
]
},
"value": {
"type": "string",
"description": "Value with which JSON path value should be matched",
"nullable": true
},
"values": {
"type": "array",
"description": "Values to match against (for is_one_of / is_not_one_of operators)",
"items": {
"type": "string"
}
}
},
"required": [
"rule_type",
"json_path",
"operator"
]
},
{
"properties": {
"rule_type": {
"type": "string",
"description": "The type of the escalation path rule",
"enum": [
"field"
]
},
"fieldable_type": {
"type": "string",
"description": "The type of the fieldable (e.g., AlertField)"
},
"fieldable_id": {
"type": "string",
"description": "The ID of the alert field"
},
"operator": {
"type": "string",
"description": "How the alert field value should be matched",
"enum": [
"is",
"is_not",
"is_one_of",
"is_not_one_of",
"contains",
"does_not_contain",
"is_empty",
"is_not_empty",
"contains_key",
"does_not_contain_key",
"starts_with",
"does_not_start_with",
"matches",
"does_not_match"
]
},
"values": {
"type": "array",
"description": "Values to match against",
"items": {
"type": "string"
}
}
},
"required": [
"rule_type",
"fieldable_type",
"fieldable_id",
"operator"
]
},
{
"properties": {
"rule_type": {
"type": "string",
"description": "The type of the escalation path rule",
"enum": [
"service"
]
},
"service_ids": {
"type": "array",
"description": "Service ids for which this escalation path should be used",
"items": {
"type": "string"
}
}
},
"required": [
"rule_type",
"service_ids"
]
},
{
"properties": {
"rule_type": {
"type": "string",
"description": "The type of the escalation path rule",
"enum": [
"deferral_window"
]
},
"time_zone": {
"type": "string",
"description": "Time zone for the deferral window",
"enum": [
"International Date Line West",
"Etc/GMT+12",
"American Samoa",
"Pacific/Pago_Pago",
"Midway Island",
"Pacific/Midway",
"Hawaii",
"Pacific/Honolulu",
"Alaska",
"America/Juneau",
"Pacific Time (US & Canada)",
"America/Los_Angeles",
"Tijuana",
"America/Tijuana",
"Arizona",
"America/Phoenix",
"Mazatlan",
"America/Mazatlan",
"Mountain Time (US & Canada)",
"America/Denver",
"Central America",
"America/Guatemala",
"Central Time (US & Canada)",
"America/Chicago",
"Chihuahua",
"America/Chihuahua",
"Guadalajara",
"America/Mexico_City",
"Mexico City",
"Monterrey",
"America/Monterrey",
"Saskatchewan",
"America/Regina",
"Bogota",
"America/Bogota",
"Eastern Time (US & Canada)",
"America/New_York",
"Indiana (East)",
"America/Indiana/Indianapolis",
"Lima",
"America/Lima",
"Quito",
"Atlantic Time (Canada)",
"America/Halifax",
"Caracas",
"America/Caracas",
"Georgetown",
"America/Guyana",
"La Paz",
"America/La_Paz",
"Puerto Rico",
"America/Puerto_Rico",
"Santiago",
"America/Santiago",
"Newfoundland",
"America/St_Johns",
"Asuncion",
"America/Asuncion",
"Brasilia",
"America/Sao_Paulo",
"Buenos Aires",
"America/Argentina/Buenos_Aires",
"Montevideo",
"America/Montevideo",
"Greenland",
"America/Nuuk",
"Mid-Atlantic",
"Atlantic/South_Georgia",
"Azores",
"Atlantic/Azores",
"Cape Verde Is.",
"Atlantic/Cape_Verde",
"Edinburgh",
"Europe/London",
"Lisbon",
"Europe/Lisbon",
"London",
"Monrovia",
"Africa/Monrovia",
"UTC",
"Etc/UTC",
"Amsterdam",
"Europe/Amsterdam",
"Belgrade",
"Europe/Belgrade",
"Berlin",
"Europe/Berlin",
"Bern",
"Europe/Zurich",
"Bratislava",
"Europe/Bratislava",
"Brussels",
"Europe/Brussels",
"Budapest",
"Europe/Budapest",
"Casablanca",
"Africa/Casablanca",
"Copenhagen",
"Europe/Copenhagen",
"Dublin",
"Europe/Dublin",
"Ljubljana",
"Europe/Ljubljana",
"Madrid",
"Europe/Madrid",
"Paris",
"Europe/Paris",
"Prague",
"Europe/Prague",
"Rome",
"Europe/Rome",
"Sarajevo",
"Europe/Sarajevo",
"Skopje",
"Europe/Skopje",
"Stockholm",
"Europe/Stockholm",
"Vienna",
"Europe/Vienna",
"Warsaw",
"Europe/Warsaw",
"West Central Africa",
"Africa/Algiers",
"Zagreb",
"Europe/Zagreb",
"Zurich",
"Athens",
"Europe/Athens",
"Bucharest",
"Europe/Bucharest",
"Cairo",
"Africa/Cairo",
"Harare",
"Africa/Harare",
"Helsinki",
"Europe/Helsinki",
"Jerusalem",
"Asia/Jerusalem",
"Kaliningrad",
"Europe/Kaliningrad",
"Kyiv",
"Europe/Kiev",
"Pretoria",
"Africa/Johannesburg",
"Riga",
"Europe/Riga",
"Sofia",
"Europe/Sofia",
"Tallinn",
"Europe/Tallinn",
"Vilnius",
"Europe/Vilnius",
"Baghdad",
"Asia/Baghdad",
"Istanbul",
"Europe/Istanbul",
"Kuwait",
"Asia/Kuwait",
"Minsk",
"Europe/Minsk",
"Moscow",
"Europe/Moscow",
"Nairobi",
"Africa/Nairobi",
"Riyadh",
"Asia/Riyadh",
"St. Petersburg",
"Volgograd",
"Europe/Volgograd",
"Tehran",
"Asia/Tehran",
"Abu Dhabi",
"Asia/Muscat",
"Baku",
"Asia/Baku",
"Muscat",
"Samara",
"Europe/Samara",
"Tbilisi",
"Asia/Tbilisi",
"Yerevan",
"Asia/Yerevan",
"Kabul",
"Asia/Kabul",
"Almaty",
"Asia/Almaty",
"Astana",
"Ekaterinburg",
"Asia/Yekaterinburg",
"Islamabad",
"Asia/Karachi",
"Karachi",
"Tashkent",
"Asia/Tashkent",
"Chennai",
"Asia/Kolkata",
"Kolkata",
"Mumbai",
"New Delhi",
"Sri Jayawardenepura",
"Asia/Colombo",
"Kathmandu",
"Asia/Kathmandu",
"Dhaka",
"Asia/Dhaka",
"Urumqi",
"Asia/Urumqi",
"Rangoon",
"Asia/Rangoon",
"Bangkok",
"Asia/Bangkok",
"Hanoi",
"Jakarta",
"Asia/Jakarta",
"Krasnoyarsk",
"Asia/Krasnoyarsk",
"Novosibirsk",
"Asia/Novosibirsk",
"Beijing",
"Asia/Shanghai",
"Chongqing",
"Asia/Chongqing",
"Hong Kong",
"Asia/Hong_Kong",
"Irkutsk",
"Asia/Irkutsk",
"Kuala Lumpur",
"Asia/Kuala_Lumpur",
"Perth",
"Australia/Perth",
"Singapore",
"Asia/Singapore",
"Taipei",
"Asia/Taipei",
"Ulaanbaatar",
"Asia/Ulaanbaatar",
"Osaka",
"Asia/Tokyo",
"Sapporo",
"Seoul",
"Asia/Seoul",
"Tokyo",
"Yakutsk",
"Asia/Yakutsk",
"Adelaide",
"Australia/Adelaide",
"Darwin",
"Australia/Darwin",
"Brisbane",
"Australia/Brisbane",
"Canberra",
"Australia/Canberra",
"Guam",
"Pacific/Guam",
"Hobart",
"Australia/Hobart",
"Melbourne",
"Australia/Melbourne",
"Port Moresby",
"Pacific/Port_Moresby",
"Sydney",
"Australia/Sydney",
"Vladivostok",
"Asia/Vladivostok",
"Magadan",
"Asia/Magadan",
"New Caledonia",
"Pacific/Noumea",
"Solomon Is.",
"Pacific/Guadalcanal",
"Srednekolymsk",
"Asia/Srednekolymsk",
"Auckland",
"Pacific/Auckland",
"Fiji",
"Pacific/Fiji",
"Kamchatka",
"Asia/Kamchatka",
"Marshall Is.",
"Pacific/Majuro",
"Wellington",
"Chatham Is.",
"Pacific/Chatham",
"Nuku'alofa",
"Pacific/Tongatapu",
"Samoa",
"Pacific/Apia",
"Tokelau Is.",
"Pacific/Fakaofo",
"America/Adak",
"America/Atka",
"US/Aleutian",
"America/Vancouver",
"Canada/Pacific",
"America/Miquelon",
"Australia/Eucla",
"Australia/LHI",
"Australia/Lord_Howe",
"Chile/EasterIsland",
"Pacific/Easter",
"Pacific/Gambier",
"Pacific/Pitcairn",
"Pacific/Marquesas",
"Pacific/Kiritimati",
"Pacific/Norfolk"
]
},
"time_blocks": {
"type": "array",
"description": "Time windows during which alerts are deferred",
"items": {
"type": "object",
"properties": {
"monday": {
"type": "boolean",
"default": false
},
"tuesday": {
"type": "boolean",
"default": false
},
"wednesday": {
"type": "boolean",
"default": false
},
"thursday": {
"type": "boolean",
"default": false
},
"friday": {
"type": "boolean",
"default": false
},
"saturday": {
"type": "boolean",
"default": false
},
"sunday": {
"type": "boolean",
"default": false
},
"start_time": {
"type": "string",
"description": "Formatted as HH:MM"
},
"end_time": {
"type": "string",
"description": "Formatted as HH:MM"
},
"all_day": {
"type": "boolean",
"default": false
},
"position": {
"type": "integer",
"nullable": true
}
}
}
}
},
"required": [
"rule_type",
"time_zone",
"time_blocks"
]
},
{
"properties": {
"rule_type": {
"type": "string",
"description": "The type of the escalation path rule",
"enum": [
"source"
]
},
"operator": {
"type": "string",
"description": "How the alert source should be matched",
"enum": [
"is",
"is_not",
"is_one_of",
"is_not_one_of"
]
},
"values": {
"type": "array",
"description": "Alert source values to match against (e.g., manual, datadog)",
"items": {
"type": "string"
}
}
},
"required": [
"rule_type",
"operator",
"values"
]
},
{
"properties": {
"rule_type": {
"type": "string",
"description": "The type of the escalation path rule",
"enum": [
"related_incidents"
]
},
"operator": {
"type": "string",
"description": "Whether the alert must (or must not) have related incidents",
"enum": [
"is_set",
"is_not_set"
]
}
},
"required": [
"rule_type",
"operator"
]
}
]
}
},
"time_restriction_time_zone": {
"type": "string",
"description": "Time zone used for time restrictions.",
"enum": [
"International Date Line West",
"Etc/GMT+12",
"American Samoa",
"Pacific/Pago_Pago",
"Midway Island",
"Pacific/Midway",
"Hawaii",
"Pacific/Honolulu",
"Alaska",
"America/Juneau",
"Pacific Time (US & Canada)",
"America/Los_Angeles",
"Tijuana",
"America/Tijuana",
"Arizona",
"America/Phoenix",
"Mazatlan",
"America/Mazatlan",
"Mountain Time (US & Canada)",
"America/Denver",
"Central America",
"America/Guatemala",
"Central Time (US & Canada)",
"America/Chicago",
"Chihuahua",
"America/Chihuahua",
"Guadalajara",
"America/Mexico_City",
"Mexico City",
"Monterrey",
"America/Monterrey",
"Saskatchewan",
"America/Regina",
"Bogota",
"America/Bogota",
"Eastern Time (US & Canada)",
"America/New_York",
"Indiana (East)",
"America/Indiana/Indianapolis",
"Lima",
"America/Lima",
"Quito",
"Atlantic Time (Canada)",
"America/Halifax",
"Caracas",
"America/Caracas",
"Georgetown",
"America/Guyana",
"La Paz",
"America/La_Paz",
"Puerto Rico",
"America/Puerto_Rico",
"Santiago",
"America/Santiago",
"Newfoundland",
"America/St_Johns",
"Asuncion",
"America/Asuncion",
"Brasilia",
"America/Sao_Paulo",
"Buenos Aires",
"America/Argentina/Buenos_Aires",
"Montevideo",
"America/Montevideo",
"Greenland",
"America/Nuuk",
"Mid-Atlantic",
"Atlantic/South_Georgia",
"Azores",
"Atlantic/Azores",
"Cape Verde Is.",
"Atlantic/Cape_Verde",
"Edinburgh",
"Europe/London",
"Lisbon",
"Europe/Lisbon",
"London",
"Monrovia",
"Africa/Monrovia",
"UTC",
"Etc/UTC",
"Amsterdam",
"Europe/Amsterdam",
"Belgrade",
"Europe/Belgrade",
"Berlin",
"Europe/Berlin",
"Bern",
"Europe/Zurich",
"Bratislava",
"Europe/Bratislava",
"Brussels",
"Europe/Brussels",
"Budapest",
"Europe/Budapest",
"Casablanca",
"Africa/Casablanca",
"Copenhagen",
"Europe/Copenhagen",
"Dublin",
"Europe/Dublin",
"Ljubljana",
"Europe/Ljubljana",
"Madrid",
"Europe/Madrid",
"Paris",
"Europe/Paris",
"Prague",
"Europe/Prague",
"Rome",
"Europe/Rome",
"Sarajevo",
"Europe/Sarajevo",
"Skopje",
"Europe/Skopje",
"Stockholm",
"Europe/Stockholm",
"Vienna",
"Europe/Vienna",
"Warsaw",
"Europe/Warsaw",
"West Central Africa",
"Africa/Algiers",
"Zagreb",
"Europe/Zagreb",
"Zurich",
"Athens",
"Europe/Athens",
"Bucharest",
"Europe/Bucharest",
"Cairo",
"Africa/Cairo",
"Harare",
"Africa/Harare",
"Helsinki",
"Europe/Helsinki",
"Jerusalem",
"Asia/Jerusalem",
"Kaliningrad",
"Europe/Kaliningrad",
"Kyiv",
"Europe/Kiev",
"Pretoria",
"Africa/Johannesburg",
"Riga",
"Europe/Riga",
"Sofia",
"Europe/Sofia",
"Tallinn",
"Europe/Tallinn",
"Vilnius",
"Europe/Vilnius",
"Baghdad",
"Asia/Baghdad",
"Istanbul",
"Europe/Istanbul",
"Kuwait",
"Asia/Kuwait",
"Minsk",
"Europe/Minsk",
"Moscow",
"Europe/Moscow",
"Nairobi",
"Africa/Nairobi",
"Riyadh",
"Asia/Riyadh",
"St. Petersburg",
"Volgograd",
"Europe/Volgograd",
"Tehran",
"Asia/Tehran",
"Abu Dhabi",
"Asia/Muscat",
"Baku",
"Asia/Baku",
"Muscat",
"Samara",
"Europe/Samara",
"Tbilisi",
"Asia/Tbilisi",
"Yerevan",
"Asia/Yerevan",
"Kabul",
"Asia/Kabul",
"Almaty",
"Asia/Almaty",
"Astana",
"Ekaterinburg",
"Asia/Yekaterinburg",
"Islamabad",
"Asia/Karachi",
"Karachi",
"Tashkent",
"Asia/Tashkent",
"Chennai",
"Asia/Kolkata",
"Kolkata",
"Mumbai",
"New Delhi",
"Sri Jayawardenepura",
"Asia/Colombo",
"Kathmandu",
"Asia/Kathmandu",
"Dhaka",
"Asia/Dhaka",
"Urumqi",
"Asia/Urumqi",
"Rangoon",
"Asia/Rangoon",
"Bangkok",
"Asia/Bangkok",
"Hanoi",
"Jakarta",
"Asia/Jakarta",
"Krasnoyarsk",
"Asia/Krasnoyarsk",
"Novosibirsk",
"Asia/Novosibirsk",
"Beijing",
"Asia/Shanghai",
"Chongqing",
"Asia/Chongqing",
"Hong Kong",
"Asia/Hong_Kong",
"Irkutsk",
"Asia/Irkutsk",
"Kuala Lumpur",
"Asia/Kuala_Lumpur",
"Perth",
"Australia/Perth",
"Singapore",
"Asia/Singapore",
"Taipei",
"Asia/Taipei",
"Ulaanbaatar",
"Asia/Ulaanbaatar",
"Osaka",
"Asia/Tokyo",
"Sapporo",
"Seoul",
"Asia/Seoul",
"Tokyo",
"Yakutsk",
"Asia/Yakutsk",
"Adelaide",
"Australia/Adelaide",
"Darwin",
"Australia/Darwin",
"Brisbane",
"Australia/Brisbane",
"Canberra",
"Australia/Canberra",
"Guam",
"Pacific/Guam",
"Hobart",
"Australia/Hobart",
"Melbourne",
"Australia/Melbourne",
"Port Moresby",
"Pacific/Port_Moresby",
"Sydney",
"Australia/Sydney",
"Vladivostok",
"Asia/Vladivostok",
"Magadan",
"Asia/Magadan",
"New Caledonia",
"Pacific/Noumea",
"Solomon Is.",
"Pacific/Guadalcanal",
"Srednekolymsk",
"Asia/Srednekolymsk",
"Auckland",
"Pacific/Auckland",
"Fiji",
"Pacific/Fiji",
"Kamchatka",
"Asia/Kamchatka",
"Marshall Is.",
"Pacific/Majuro",
"Wellington",
"Chatham Is.",
"Pacific/Chatham",
"Nuku'alofa",
"Pacific/Tongatapu",
"Samoa",
"Pacific/Apia",
"Tokelau Is.",
"Pacific/Fakaofo",
"America/Adak",
"America/Atka",
"US/Aleutian",
"America/Vancouver",
"Canada/Pacific",
"America/Miquelon",
"Australia/Eucla",
"Australia/LHI",
"Australia/Lord_Howe",
"Chile/EasterIsland",
"Pacific/Easter",
"Pacific/Gambier",
"Pacific/Pitcairn",
"Pacific/Marquesas",
"Pacific/Kiritimati",
"Pacific/Norfolk"
],
"nullable": true
},
"time_restrictions": {
"type": "array",
"description": "If time restrictions are set, alerts will follow this path when they arrive within the specified time ranges and meet the rules.",
"items": {
"type": "object",
"properties": {
"start_day": {
"type": "string",
"enum": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday",
"sunday"
]
},
"start_time": {
"type": "string",
"description": "Formatted as HH:MM"
},
"end_day": {
"type": "string",
"enum": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday",
"sunday"
]
},
"end_time": {
"type": "string",
"description": "Formatted as HH:MM"
}
},
"required": [
"start_day",
"start_time",
"end_day",
"end_time"
]
}
}
},
"required": [
"name"
],
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_escalation_policy_path": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"escalation_paths"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the escalation path"
},
"notification_type": {
"type": "string",
"description": "Position of the escalation policy level",
"enum": [
"audible",
"quiet"
],
"default": "audible"
},
"path_type": {
"type": "string",
"description": "The type of escalation path. Cannot be changed after creation.",
"enum": [
"escalation",
"deferral"
]
},
"after_deferral_behavior": {
"type": "string",
"description": "What happens after a deferral path finishes.",
"enum": [
"re_evaluate",
"execute_path"
],
"nullable": true
},
"after_deferral_path_id": {
"type": "string",
"description": "The escalation path to execute after this deferral path when after_deferral_behavior is execute_path.",
"nullable": true
},
"default": {
"type": "boolean",
"description": "Whether this escalation path is the default path",
"nullable": true
},
"match_mode": {
"type": "string",
"description": "How path rules are matched.",
"enum": [
"match-all-rules",
"match-any-rule"
],
"default": "match-all-rules"
},
"position": {
"type": "integer",
"description": "The position of this path in the paths for this EP."
},
"repeat": {
"type": "boolean",
"description": "Whether this path should be repeated until someone acknowledges the alert",
"nullable": true
},
"repeat_count": {
"type": "integer",
"description": "The number of times this path will be executed until someone acknowledges the alert",
"nullable": true
},
"initial_delay": {
"type": "integer",
"description": "Initial delay for escalation path in minutes. Maximum 1 week (10080)."
},
"rules": {
"type": "array",
"description": "Escalation path conditions",
"items": {
"type": "object",
"oneOf": [
{
"properties": {
"rule_type": {
"type": "string",
"description": "The type of the escalation path rule",
"enum": [
"alert_urgency"
]
},
"urgency_ids": {
"type": "array",
"description": "Alert urgency ids for which this escalation path should be used",
"items": {
"type": "string"
}
}
},
"required": [
"rule_type",
"urgency_ids"
]
},
{
"properties": {
"rule_type": {
"type": "string",
"description": "The type of the escalation path rule",
"enum": [
"working_hour"
]
},
"within_working_hour": {
"type": "boolean",
"description": "Whether the escalation path should be used within working hours"
}
},
"required": [
"rule_type",
"within_working_hour"
]
},
{
"properties": {
"rule_type": {
"type": "string",
"description": "The type of the escalation path rule",
"enum": [
"json_path"
]
},
"json_path": {
"type": "string",
"description": "JSON path to extract value from payload"
},
"operator": {
"type": "string",
"description": "How JSON path value should be matched",
"enum": [
"is",
"is_not",
"contains",
"does_not_contain",
"is_one_of",
"is_not_one_of",
"is_set",
"is_not_set"
]
},
"value": {
"type": "string",
"description": "Value with which JSON path value should be matched",
"nullable": true
},
"values": {
"type": "array",
"description": "Values to match against (for is_one_of / is_not_one_of operators)",
"items": {
"type": "string"
}
}
},
"required": [
"rule_type",
"json_path",
"operator"
]
},
{
"properties": {
"rule_type": {
"type": "string",
"description": "The type of the escalation path rule",
"enum": [
"field"
]
},
"fieldable_type": {
"type": "string",
"description": "The type of the fieldable (e.g., AlertField)"
},
"fieldable_id": {
"type": "string",
"description": "The ID of the alert field"
},
"operator": {
"type": "string",
"description": "How the alert field value should be matched",
"enum": [
"is",
"is_not",
"is_one_of",
"is_not_one_of",
"contains",
"does_not_contain",
"is_empty",
"is_not_empty",
"contains_key",
"does_not_contain_key",
"starts_with",
"does_not_start_with",
"matches",
"does_not_match"
]
},
"values": {
"type": "array",
"description": "Values to match against",
"items": {
"type": "string"
}
}
},
"required": [
"rule_type",
"fieldable_type",
"fieldable_id",
"operator"
]
},
{
"properties": {
"rule_type": {
"type": "string",
"description": "The type of the escalation path rule",
"enum": [
"service"
]
},
"service_ids": {
"type": "array",
"description": "Service ids for which this escalation path should be used",
"items": {
"type": "string"
}
}
},
"required": [
"rule_type",
"service_ids"
]
},
{
"properties": {
"rule_type": {
"type": "string",
"description": "The type of the escalation path rule",
"enum": [
"deferral_window"
]
},
"time_zone": {
"type": "string",
"description": "Time zone for the deferral window",
"enum": [
"International Date Line West",
"Etc/GMT+12",
"American Samoa",
"Pacific/Pago_Pago",
"Midway Island",
"Pacific/Midway",
"Hawaii",
"Pacific/Honolulu",
"Alaska",
"America/Juneau",
"Pacific Time (US & Canada)",
"America/Los_Angeles",
"Tijuana",
"America/Tijuana",
"Arizona",
"America/Phoenix",
"Mazatlan",
"America/Mazatlan",
"Mountain Time (US & Canada)",
"America/Denver",
"Central America",
"America/Guatemala",
"Central Time (US & Canada)",
"America/Chicago",
"Chihuahua",
"America/Chihuahua",
"Guadalajara",
"America/Mexico_City",
"Mexico City",
"Monterrey",
"America/Monterrey",
"Saskatchewan",
"America/Regina",
"Bogota",
"America/Bogota",
"Eastern Time (US & Canada)",
"America/New_York",
"Indiana (East)",
"America/Indiana/Indianapolis",
"Lima",
"America/Lima",
"Quito",
"Atlantic Time (Canada)",
"America/Halifax",
"Caracas",
"America/Caracas",
"Georgetown",
"America/Guyana",
"La Paz",
"America/La_Paz",
"Puerto Rico",
"America/Puerto_Rico",
"Santiago",
"America/Santiago",
"Newfoundland",
"America/St_Johns",
"Asuncion",
"America/Asuncion",
"Brasilia",
"America/Sao_Paulo",
"Buenos Aires",
"America/Argentina/Buenos_Aires",
"Montevideo",
"America/Montevideo",
"Greenland",
"America/Nuuk",
"Mid-Atlantic",
"Atlantic/South_Georgia",
"Azores",
"Atlantic/Azores",
"Cape Verde Is.",
"Atlantic/Cape_Verde",
"Edinburgh",
"Europe/London",
"Lisbon",
"Europe/Lisbon",
"London",
"Monrovia",
"Africa/Monrovia",
"UTC",
"Etc/UTC",
"Amsterdam",
"Europe/Amsterdam",
"Belgrade",
"Europe/Belgrade",
"Berlin",
"Europe/Berlin",
"Bern",
"Europe/Zurich",
"Bratislava",
"Europe/Bratislava",
"Brussels",
"Europe/Brussels",
"Budapest",
"Europe/Budapest",
"Casablanca",
"Africa/Casablanca",
"Copenhagen",
"Europe/Copenhagen",
"Dublin",
"Europe/Dublin",
"Ljubljana",
"Europe/Ljubljana",
"Madrid",
"Europe/Madrid",
"Paris",
"Europe/Paris",
"Prague",
"Europe/Prague",
"Rome",
"Europe/Rome",
"Sarajevo",
"Europe/Sarajevo",
"Skopje",
"Europe/Skopje",
"Stockholm",
"Europe/Stockholm",
"Vienna",
"Europe/Vienna",
"Warsaw",
"Europe/Warsaw",
"West Central Africa",
"Africa/Algiers",
"Zagreb",
"Europe/Zagreb",
"Zurich",
"Athens",
"Europe/Athens",
"Bucharest",
"Europe/Bucharest",
"Cairo",
"Africa/Cairo",
"Harare",
"Africa/Harare",
"Helsinki",
"Europe/Helsinki",
"Jerusalem",
"Asia/Jerusalem",
"Kaliningrad",
"Europe/Kaliningrad",
"Kyiv",
"Europe/Kiev",
"Pretoria",
"Africa/Johannesburg",
"Riga",
"Europe/Riga",
"Sofia",
"Europe/Sofia",
"Tallinn",
"Europe/Tallinn",
"Vilnius",
"Europe/Vilnius",
"Baghdad",
"Asia/Baghdad",
"Istanbul",
"Europe/Istanbul",
"Kuwait",
"Asia/Kuwait",
"Minsk",
"Europe/Minsk",
"Moscow",
"Europe/Moscow",
"Nairobi",
"Africa/Nairobi",
"Riyadh",
"Asia/Riyadh",
"St. Petersburg",
"Volgograd",
"Europe/Volgograd",
"Tehran",
"Asia/Tehran",
"Abu Dhabi",
"Asia/Muscat",
"Baku",
"Asia/Baku",
"Muscat",
"Samara",
"Europe/Samara",
"Tbilisi",
"Asia/Tbilisi",
"Yerevan",
"Asia/Yerevan",
"Kabul",
"Asia/Kabul",
"Almaty",
"Asia/Almaty",
"Astana",
"Ekaterinburg",
"Asia/Yekaterinburg",
"Islamabad",
"Asia/Karachi",
"Karachi",
"Tashkent",
"Asia/Tashkent",
"Chennai",
"Asia/Kolkata",
"Kolkata",
"Mumbai",
"New Delhi",
"Sri Jayawardenepura",
"Asia/Colombo",
"Kathmandu",
"Asia/Kathmandu",
"Dhaka",
"Asia/Dhaka",
"Urumqi",
"Asia/Urumqi",
"Rangoon",
"Asia/Rangoon",
"Bangkok",
"Asia/Bangkok",
"Hanoi",
"Jakarta",
"Asia/Jakarta",
"Krasnoyarsk",
"Asia/Krasnoyarsk",
"Novosibirsk",
"Asia/Novosibirsk",
"Beijing",
"Asia/Shanghai",
"Chongqing",
"Asia/Chongqing",
"Hong Kong",
"Asia/Hong_Kong",
"Irkutsk",
"Asia/Irkutsk",
"Kuala Lumpur",
"Asia/Kuala_Lumpur",
"Perth",
"Australia/Perth",
"Singapore",
"Asia/Singapore",
"Taipei",
"Asia/Taipei",
"Ulaanbaatar",
"Asia/Ulaanbaatar",
"Osaka",
"Asia/Tokyo",
"Sapporo",
"Seoul",
"Asia/Seoul",
"Tokyo",
"Yakutsk",
"Asia/Yakutsk",
"Adelaide",
"Australia/Adelaide",
"Darwin",
"Australia/Darwin",
"Brisbane",
"Australia/Brisbane",
"Canberra",
"Australia/Canberra",
"Guam",
"Pacific/Guam",
"Hobart",
"Australia/Hobart",
"Melbourne",
"Australia/Melbourne",
"Port Moresby",
"Pacific/Port_Moresby",
"Sydney",
"Australia/Sydney",
"Vladivostok",
"Asia/Vladivostok",
"Magadan",
"Asia/Magadan",
"New Caledonia",
"Pacific/Noumea",
"Solomon Is.",
"Pacific/Guadalcanal",
"Srednekolymsk",
"Asia/Srednekolymsk",
"Auckland",
"Pacific/Auckland",
"Fiji",
"Pacific/Fiji",
"Kamchatka",
"Asia/Kamchatka",
"Marshall Is.",
"Pacific/Majuro",
"Wellington",
"Chatham Is.",
"Pacific/Chatham",
"Nuku'alofa",
"Pacific/Tongatapu",
"Samoa",
"Pacific/Apia",
"Tokelau Is.",
"Pacific/Fakaofo",
"America/Adak",
"America/Atka",
"US/Aleutian",
"America/Vancouver",
"Canada/Pacific",
"America/Miquelon",
"Australia/Eucla",
"Australia/LHI",
"Australia/Lord_Howe",
"Chile/EasterIsland",
"Pacific/Easter",
"Pacific/Gambier",
"Pacific/Pitcairn",
"Pacific/Marquesas",
"Pacific/Kiritimati",
"Pacific/Norfolk"
]
},
"time_blocks": {
"type": "array",
"description": "Time windows during which alerts are deferred",
"items": {
"type": "object",
"properties": {
"monday": {
"type": "boolean",
"default": false
},
"tuesday": {
"type": "boolean",
"default": false
},
"wednesday": {
"type": "boolean",
"default": false
},
"thursday": {
"type": "boolean",
"default": false
},
"friday": {
"type": "boolean",
"default": false
},
"saturday": {
"type": "boolean",
"default": false
},
"sunday": {
"type": "boolean",
"default": false
},
"start_time": {
"type": "string",
"description": "Formatted as HH:MM"
},
"end_time": {
"type": "string",
"description": "Formatted as HH:MM"
},
"all_day": {
"type": "boolean",
"default": false
},
"position": {
"type": "integer",
"nullable": true
}
}
}
}
},
"required": [
"rule_type",
"time_zone",
"time_blocks"
]
},
{
"properties": {
"rule_type": {
"type": "string",
"description": "The type of the escalation path rule",
"enum": [
"source"
]
},
"operator": {
"type": "string",
"description": "How the alert source should be matched",
"enum": [
"is",
"is_not",
"is_one_of",
"is_not_one_of"
]
},
"values": {
"type": "array",
"description": "Alert source values to match against (e.g., manual, datadog)",
"items": {
"type": "string"
}
}
},
"required": [
"rule_type",
"operator",
"values"
]
},
{
"properties": {
"rule_type": {
"type": "string",
"description": "The type of the escalation path rule",
"enum": [
"related_incidents"
]
},
"operator": {
"type": "string",
"description": "Whether the alert must (or must not) have related incidents",
"enum": [
"is_set",
"is_not_set"
]
}
},
"required": [
"rule_type",
"operator"
]
}
],
"nullable": true
}
},
"time_restriction_time_zone": {
"type": "string",
"description": "Time zone used for time restrictions.",
"enum": [
"International Date Line West",
"Etc/GMT+12",
"American Samoa",
"Pacific/Pago_Pago",
"Midway Island",
"Pacific/Midway",
"Hawaii",
"Pacific/Honolulu",
"Alaska",
"America/Juneau",
"Pacific Time (US & Canada)",
"America/Los_Angeles",
"Tijuana",
"America/Tijuana",
"Arizona",
"America/Phoenix",
"Mazatlan",
"America/Mazatlan",
"Mountain Time (US & Canada)",
"America/Denver",
"Central America",
"America/Guatemala",
"Central Time (US & Canada)",
"America/Chicago",
"Chihuahua",
"America/Chihuahua",
"Guadalajara",
"America/Mexico_City",
"Mexico City",
"Monterrey",
"America/Monterrey",
"Saskatchewan",
"America/Regina",
"Bogota",
"America/Bogota",
"Eastern Time (US & Canada)",
"America/New_York",
"Indiana (East)",
"America/Indiana/Indianapolis",
"Lima",
"America/Lima",
"Quito",
"Atlantic Time (Canada)",
"America/Halifax",
"Caracas",
"America/Caracas",
"Georgetown",
"America/Guyana",
"La Paz",
"America/La_Paz",
"Puerto Rico",
"America/Puerto_Rico",
"Santiago",
"America/Santiago",
"Newfoundland",
"America/St_Johns",
"Asuncion",
"America/Asuncion",
"Brasilia",
"America/Sao_Paulo",
"Buenos Aires",
"America/Argentina/Buenos_Aires",
"Montevideo",
"America/Montevideo",
"Greenland",
"America/Nuuk",
"Mid-Atlantic",
"Atlantic/South_Georgia",
"Azores",
"Atlantic/Azores",
"Cape Verde Is.",
"Atlantic/Cape_Verde",
"Edinburgh",
"Europe/London",
"Lisbon",
"Europe/Lisbon",
"London",
"Monrovia",
"Africa/Monrovia",
"UTC",
"Etc/UTC",
"Amsterdam",
"Europe/Amsterdam",
"Belgrade",
"Europe/Belgrade",
"Berlin",
"Europe/Berlin",
"Bern",
"Europe/Zurich",
"Bratislava",
"Europe/Bratislava",
"Brussels",
"Europe/Brussels",
"Budapest",
"Europe/Budapest",
"Casablanca",
"Africa/Casablanca",
"Copenhagen",
"Europe/Copenhagen",
"Dublin",
"Europe/Dublin",
"Ljubljana",
"Europe/Ljubljana",
"Madrid",
"Europe/Madrid",
"Paris",
"Europe/Paris",
"Prague",
"Europe/Prague",
"Rome",
"Europe/Rome",
"Sarajevo",
"Europe/Sarajevo",
"Skopje",
"Europe/Skopje",
"Stockholm",
"Europe/Stockholm",
"Vienna",
"Europe/Vienna",
"Warsaw",
"Europe/Warsaw",
"West Central Africa",
"Africa/Algiers",
"Zagreb",
"Europe/Zagreb",
"Zurich",
"Athens",
"Europe/Athens",
"Bucharest",
"Europe/Bucharest",
"Cairo",
"Africa/Cairo",
"Harare",
"Africa/Harare",
"Helsinki",
"Europe/Helsinki",
"Jerusalem",
"Asia/Jerusalem",
"Kaliningrad",
"Europe/Kaliningrad",
"Kyiv",
"Europe/Kiev",
"Pretoria",
"Africa/Johannesburg",
"Riga",
"Europe/Riga",
"Sofia",
"Europe/Sofia",
"Tallinn",
"Europe/Tallinn",
"Vilnius",
"Europe/Vilnius",
"Baghdad",
"Asia/Baghdad",
"Istanbul",
"Europe/Istanbul",
"Kuwait",
"Asia/Kuwait",
"Minsk",
"Europe/Minsk",
"Moscow",
"Europe/Moscow",
"Nairobi",
"Africa/Nairobi",
"Riyadh",
"Asia/Riyadh",
"St. Petersburg",
"Volgograd",
"Europe/Volgograd",
"Tehran",
"Asia/Tehran",
"Abu Dhabi",
"Asia/Muscat",
"Baku",
"Asia/Baku",
"Muscat",
"Samara",
"Europe/Samara",
"Tbilisi",
"Asia/Tbilisi",
"Yerevan",
"Asia/Yerevan",
"Kabul",
"Asia/Kabul",
"Almaty",
"Asia/Almaty",
"Astana",
"Ekaterinburg",
"Asia/Yekaterinburg",
"Islamabad",
"Asia/Karachi",
"Karachi",
"Tashkent",
"Asia/Tashkent",
"Chennai",
"Asia/Kolkata",
"Kolkata",
"Mumbai",
"New Delhi",
"Sri Jayawardenepura",
"Asia/Colombo",
"Kathmandu",
"Asia/Kathmandu",
"Dhaka",
"Asia/Dhaka",
"Urumqi",
"Asia/Urumqi",
"Rangoon",
"Asia/Rangoon",
"Bangkok",
"Asia/Bangkok",
"Hanoi",
"Jakarta",
"Asia/Jakarta",
"Krasnoyarsk",
"Asia/Krasnoyarsk",
"Novosibirsk",
"Asia/Novosibirsk",
"Beijing",
"Asia/Shanghai",
"Chongqing",
"Asia/Chongqing",
"Hong Kong",
"Asia/Hong_Kong",
"Irkutsk",
"Asia/Irkutsk",
"Kuala Lumpur",
"Asia/Kuala_Lumpur",
"Perth",
"Australia/Perth",
"Singapore",
"Asia/Singapore",
"Taipei",
"Asia/Taipei",
"Ulaanbaatar",
"Asia/Ulaanbaatar",
"Osaka",
"Asia/Tokyo",
"Sapporo",
"Seoul",
"Asia/Seoul",
"Tokyo",
"Yakutsk",
"Asia/Yakutsk",
"Adelaide",
"Australia/Adelaide",
"Darwin",
"Australia/Darwin",
"Brisbane",
"Australia/Brisbane",
"Canberra",
"Australia/Canberra",
"Guam",
"Pacific/Guam",
"Hobart",
"Australia/Hobart",
"Melbourne",
"Australia/Melbourne",
"Port Moresby",
"Pacific/Port_Moresby",
"Sydney",
"Australia/Sydney",
"Vladivostok",
"Asia/Vladivostok",
"Magadan",
"Asia/Magadan",
"New Caledonia",
"Pacific/Noumea",
"Solomon Is.",
"Pacific/Guadalcanal",
"Srednekolymsk",
"Asia/Srednekolymsk",
"Auckland",
"Pacific/Auckland",
"Fiji",
"Pacific/Fiji",
"Kamchatka",
"Asia/Kamchatka",
"Marshall Is.",
"Pacific/Majuro",
"Wellington",
"Chatham Is.",
"Pacific/Chatham",
"Nuku'alofa",
"Pacific/Tongatapu",
"Samoa",
"Pacific/Apia",
"Tokelau Is.",
"Pacific/Fakaofo",
"America/Adak",
"America/Atka",
"US/Aleutian",
"America/Vancouver",
"Canada/Pacific",
"America/Miquelon",
"Australia/Eucla",
"Australia/LHI",
"Australia/Lord_Howe",
"Chile/EasterIsland",
"Pacific/Easter",
"Pacific/Gambier",
"Pacific/Pitcairn",
"Pacific/Marquesas",
"Pacific/Kiritimati",
"Pacific/Norfolk"
],
"nullable": true
},
"time_restrictions": {
"type": "array",
"description": "If time restrictions are set, alerts will follow this path when they arrive within the specified time ranges and meet the rules.",
"items": {
"type": "object",
"properties": {
"start_day": {
"type": "string",
"enum": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday",
"sunday"
]
},
"start_time": {
"type": "string",
"description": "Formatted as HH:MM"
},
"end_day": {
"type": "string",
"enum": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday",
"sunday"
]
},
"end_time": {
"type": "string",
"description": "Formatted as HH:MM"
}
}
}
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"escalation_policy_path": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the escalation path"
},
"default": {
"type": "boolean",
"description": "Whether this escalation path is the default path"
},
"notification_type": {
"type": "string",
"description": "Notification rule type"
},
"path_type": {
"type": "string",
"description": "The type of escalation path",
"enum": [
"escalation",
"deferral"
]
},
"escalation_policy_id": {
"type": "string",
"description": "The ID of the escalation policy"
},
"after_deferral_behavior": {
"type": "string",
"description": "What happens after a deferral path finishes",
"enum": [
"re_evaluate",
"execute_path"
],
"nullable": true
},
"after_deferral_path_id": {
"type": "string",
"description": "The escalation path to execute after this deferral path when after_deferral_behavior is execute_path",
"nullable": true
},
"match_mode": {
"type": "string",
"description": "How path rules are matched.",
"enum": [
"match-all-rules",
"match-any-rule"
]
},
"position": {
"type": "integer",
"description": "The position of this path in the paths for this EP."
},
"repeat": {
"type": "boolean",
"description": "Whether this path should be repeated until someone acknowledges the alert",
"nullable": true
},
"repeat_count": {
"type": "integer",
"description": "The number of times this path will be executed until someone acknowledges the alert",
"nullable": true
},
"initial_delay": {
"type": "integer",
"description": "Initial delay for escalation path in minutes. Maximum 1 week (10080)."
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
},
"rules": {
"type": "array",
"description": "Escalation path rules",
"items": {
"type": "object",
"oneOf": [
{
"properties": {
"rule_type": {
"type": "string",
"description": "The type of the escalation path rule",
"enum": [
"alert_urgency"
]
},
"urgency_ids": {
"type": "array",
"description": "Alert urgency ids for which this escalation path should be used",
"items": {
"type": "string"
}
}
},
"required": [
"rule_type",
"urgency_ids"
]
},
{
"properties": {
"rule_type": {
"type": "string",
"description": "The type of the escalation path rule",
"enum": [
"working_hour"
]
},
"within_working_hour": {
"type": "boolean",
"description": "Whether the escalation path should be used within working hours"
}
},
"required": [
"rule_type",
"within_working_hour"
]
},
{
"properties": {
"rule_type": {
"type": "string",
"description": "The type of the escalation path rule",
"enum": [
"json_path"
]
},
"json_path": {
"type": "string",
"description": "JSON path to extract value from payload"
},
"operator": {
"type": "string",
"description": "How JSON path value should be matched",
"enum": [
"is",
"is_not",
"contains",
"does_not_contain",
"is_one_of",
"is_not_one_of",
"is_set",
"is_not_set"
]
},
"value": {
"type": "string",
"description": "Value with which JSON path value should be matched",
"nullable": true
},
"values": {
"type": "array",
"description": "Values to match against (for is_one_of / is_not_one_of operators)",
"items": {
"type": "string"
}
}
},
"required": [
"rule_type",
"json_path",
"operator"
]
},
{
"properties": {
"rule_type": {
"type": "string",
"description": "The type of the escalation path rule",
"enum": [
"field"
]
},
"fieldable_type": {
"type": "string",
"description": "The type of the fieldable (e.g., AlertField)"
},
"fieldable_id": {
"type": "string",
"description": "The ID of the alert field"
},
"operator": {
"type": "string",
"description": "How the alert field value should be matched",
"enum": [
"is",
"is_not",
"is_one_of",
"is_not_one_of",
"contains",
"does_not_contain",
"is_empty",
"is_not_empty",
"contains_key",
"does_not_contain_key",
"starts_with",
"does_not_start_with",
"matches",
"does_not_match"
]
},
"values": {
"type": "array",
"description": "Values to match against",
"items": {
"type": "string"
}
}
},
"required": [
"rule_type",
"fieldable_type",
"fieldable_id",
"operator"
]
},
{
"properties": {
"rule_type": {
"type": "string",
"description": "The type of the escalation path rule",
"enum": [
"service"
]
},
"service_ids": {
"type": "array",
"description": "Service ids for which this escalation path should be used",
"items": {
"type": "string"
}
}
},
"required": [
"rule_type",
"service_ids"
]
},
{
"properties": {
"rule_type": {
"type": "string",
"description": "The type of the escalation path rule",
"enum": [
"deferral_window"
]
},
"time_zone": {
"type": "string",
"description": "Time zone for the deferral window",
"enum": [
"International Date Line West",
"Etc/GMT+12",
"American Samoa",
"Pacific/Pago_Pago",
"Midway Island",
"Pacific/Midway",
"Hawaii",
"Pacific/Honolulu",
"Alaska",
"America/Juneau",
"Pacific Time (US & Canada)",
"America/Los_Angeles",
"Tijuana",
"America/Tijuana",
"Arizona",
"America/Phoenix",
"Mazatlan",
"America/Mazatlan",
"Mountain Time (US & Canada)",
"America/Denver",
"Central America",
"America/Guatemala",
"Central Time (US & Canada)",
"America/Chicago",
"Chihuahua",
"America/Chihuahua",
"Guadalajara",
"America/Mexico_City",
"Mexico City",
"Monterrey",
"America/Monterrey",
"Saskatchewan",
"America/Regina",
"Bogota",
"America/Bogota",
"Eastern Time (US & Canada)",
"America/New_York",
"Indiana (East)",
"America/Indiana/Indianapolis",
"Lima",
"America/Lima",
"Quito",
"Atlantic Time (Canada)",
"America/Halifax",
"Caracas",
"America/Caracas",
"Georgetown",
"America/Guyana",
"La Paz",
"America/La_Paz",
"Puerto Rico",
"America/Puerto_Rico",
"Santiago",
"America/Santiago",
"Newfoundland",
"America/St_Johns",
"Asuncion",
"America/Asuncion",
"Brasilia",
"America/Sao_Paulo",
"Buenos Aires",
"America/Argentina/Buenos_Aires",
"Montevideo",
"America/Montevideo",
"Greenland",
"America/Nuuk",
"Mid-Atlantic",
"Atlantic/South_Georgia",
"Azores",
"Atlantic/Azores",
"Cape Verde Is.",
"Atlantic/Cape_Verde",
"Edinburgh",
"Europe/London",
"Lisbon",
"Europe/Lisbon",
"London",
"Monrovia",
"Africa/Monrovia",
"UTC",
"Etc/UTC",
"Amsterdam",
"Europe/Amsterdam",
"Belgrade",
"Europe/Belgrade",
"Berlin",
"Europe/Berlin",
"Bern",
"Europe/Zurich",
"Bratislava",
"Europe/Bratislava",
"Brussels",
"Europe/Brussels",
"Budapest",
"Europe/Budapest",
"Casablanca",
"Africa/Casablanca",
"Copenhagen",
"Europe/Copenhagen",
"Dublin",
"Europe/Dublin",
"Ljubljana",
"Europe/Ljubljana",
"Madrid",
"Europe/Madrid",
"Paris",
"Europe/Paris",
"Prague",
"Europe/Prague",
"Rome",
"Europe/Rome",
"Sarajevo",
"Europe/Sarajevo",
"Skopje",
"Europe/Skopje",
"Stockholm",
"Europe/Stockholm",
"Vienna",
"Europe/Vienna",
"Warsaw",
"Europe/Warsaw",
"West Central Africa",
"Africa/Algiers",
"Zagreb",
"Europe/Zagreb",
"Zurich",
"Athens",
"Europe/Athens",
"Bucharest",
"Europe/Bucharest",
"Cairo",
"Africa/Cairo",
"Harare",
"Africa/Harare",
"Helsinki",
"Europe/Helsinki",
"Jerusalem",
"Asia/Jerusalem",
"Kaliningrad",
"Europe/Kaliningrad",
"Kyiv",
"Europe/Kiev",
"Pretoria",
"Africa/Johannesburg",
"Riga",
"Europe/Riga",
"Sofia",
"Europe/Sofia",
"Tallinn",
"Europe/Tallinn",
"Vilnius",
"Europe/Vilnius",
"Baghdad",
"Asia/Baghdad",
"Istanbul",
"Europe/Istanbul",
"Kuwait",
"Asia/Kuwait",
"Minsk",
"Europe/Minsk",
"Moscow",
"Europe/Moscow",
"Nairobi",
"Africa/Nairobi",
"Riyadh",
"Asia/Riyadh",
"St. Petersburg",
"Volgograd",
"Europe/Volgograd",
"Tehran",
"Asia/Tehran",
"Abu Dhabi",
"Asia/Muscat",
"Baku",
"Asia/Baku",
"Muscat",
"Samara",
"Europe/Samara",
"Tbilisi",
"Asia/Tbilisi",
"Yerevan",
"Asia/Yerevan",
"Kabul",
"Asia/Kabul",
"Almaty",
"Asia/Almaty",
"Astana",
"Ekaterinburg",
"Asia/Yekaterinburg",
"Islamabad",
"Asia/Karachi",
"Karachi",
"Tashkent",
"Asia/Tashkent",
"Chennai",
"Asia/Kolkata",
"Kolkata",
"Mumbai",
"New Delhi",
"Sri Jayawardenepura",
"Asia/Colombo",
"Kathmandu",
"Asia/Kathmandu",
"Dhaka",
"Asia/Dhaka",
"Urumqi",
"Asia/Urumqi",
"Rangoon",
"Asia/Rangoon",
"Bangkok",
"Asia/Bangkok",
"Hanoi",
"Jakarta",
"Asia/Jakarta",
"Krasnoyarsk",
"Asia/Krasnoyarsk",
"Novosibirsk",
"Asia/Novosibirsk",
"Beijing",
"Asia/Shanghai",
"Chongqing",
"Asia/Chongqing",
"Hong Kong",
"Asia/Hong_Kong",
"Irkutsk",
"Asia/Irkutsk",
"Kuala Lumpur",
"Asia/Kuala_Lumpur",
"Perth",
"Australia/Perth",
"Singapore",
"Asia/Singapore",
"Taipei",
"Asia/Taipei",
"Ulaanbaatar",
"Asia/Ulaanbaatar",
"Osaka",
"Asia/Tokyo",
"Sapporo",
"Seoul",
"Asia/Seoul",
"Tokyo",
"Yakutsk",
"Asia/Yakutsk",
"Adelaide",
"Australia/Adelaide",
"Darwin",
"Australia/Darwin",
"Brisbane",
"Australia/Brisbane",
"Canberra",
"Australia/Canberra",
"Guam",
"Pacific/Guam",
"Hobart",
"Australia/Hobart",
"Melbourne",
"Australia/Melbourne",
"Port Moresby",
"Pacific/Port_Moresby",
"Sydney",
"Australia/Sydney",
"Vladivostok",
"Asia/Vladivostok",
"Magadan",
"Asia/Magadan",
"New Caledonia",
"Pacific/Noumea",
"Solomon Is.",
"Pacific/Guadalcanal",
"Srednekolymsk",
"Asia/Srednekolymsk",
"Auckland",
"Pacific/Auckland",
"Fiji",
"Pacific/Fiji",
"Kamchatka",
"Asia/Kamchatka",
"Marshall Is.",
"Pacific/Majuro",
"Wellington",
"Chatham Is.",
"Pacific/Chatham",
"Nuku'alofa",
"Pacific/Tongatapu",
"Samoa",
"Pacific/Apia",
"Tokelau Is.",
"Pacific/Fakaofo",
"America/Adak",
"America/Atka",
"US/Aleutian",
"America/Vancouver",
"Canada/Pacific",
"America/Miquelon",
"Australia/Eucla",
"Australia/LHI",
"Australia/Lord_Howe",
"Chile/EasterIsland",
"Pacific/Easter",
"Pacific/Gambier",
"Pacific/Pitcairn",
"Pacific/Marquesas",
"Pacific/Kiritimati",
"Pacific/Norfolk"
]
},
"time_blocks": {
"type": "array",
"description": "Time windows during which alerts are deferred",
"items": {
"type": "object",
"properties": {
"monday": {
"type": "boolean",
"default": false
},
"tuesday": {
"type": "boolean",
"default": false
},
"wednesday": {
"type": "boolean",
"default": false
},
"thursday": {
"type": "boolean",
"default": false
},
"friday": {
"type": "boolean",
"default": false
},
"saturday": {
"type": "boolean",
"default": false
},
"sunday": {
"type": "boolean",
"default": false
},
"start_time": {
"type": "string",
"description": "Formatted as HH:MM"
},
"end_time": {
"type": "string",
"description": "Formatted as HH:MM"
},
"all_day": {
"type": "boolean",
"default": false
},
"position": {
"type": "integer",
"nullable": true
}
}
}
}
},
"required": [
"rule_type",
"time_zone",
"time_blocks"
]
},
{
"properties": {
"rule_type": {
"type": "string",
"description": "The type of the escalation path rule",
"enum": [
"source"
]
},
"operator": {
"type": "string",
"description": "How the alert source should be matched",
"enum": [
"is",
"is_not",
"is_one_of",
"is_not_one_of"
]
},
"values": {
"type": "array",
"description": "Alert source values to match against (e.g., manual, datadog)",
"items": {
"type": "string"
}
}
},
"required": [
"rule_type",
"operator",
"values"
]
},
{
"properties": {
"rule_type": {
"type": "string",
"description": "The type of the escalation path rule",
"enum": [
"related_incidents"
]
},
"operator": {
"type": "string",
"description": "Whether the alert must (or must not) have related incidents",
"enum": [
"is_set",
"is_not_set"
]
}
},
"required": [
"rule_type",
"operator"
]
}
],
"nullable": true
}
},
"time_restriction_time_zone": {
"type": "string",
"description": "Time zone used for time restrictions.",
"enum": [
"International Date Line West",
"Etc/GMT+12",
"American Samoa",
"Pacific/Pago_Pago",
"Midway Island",
"Pacific/Midway",
"Hawaii",
"Pacific/Honolulu",
"Alaska",
"America/Juneau",
"Pacific Time (US & Canada)",
"America/Los_Angeles",
"Tijuana",
"America/Tijuana",
"Arizona",
"America/Phoenix",
"Mazatlan",
"America/Mazatlan",
"Mountain Time (US & Canada)",
"America/Denver",
"Central America",
"America/Guatemala",
"Central Time (US & Canada)",
"America/Chicago",
"Chihuahua",
"America/Chihuahua",
"Guadalajara",
"America/Mexico_City",
"Mexico City",
"Monterrey",
"America/Monterrey",
"Saskatchewan",
"America/Regina",
"Bogota",
"America/Bogota",
"Eastern Time (US & Canada)",
"America/New_York",
"Indiana (East)",
"America/Indiana/Indianapolis",
"Lima",
"America/Lima",
"Quito",
"Atlantic Time (Canada)",
"America/Halifax",
"Caracas",
"America/Caracas",
"Georgetown",
"America/Guyana",
"La Paz",
"America/La_Paz",
"Puerto Rico",
"America/Puerto_Rico",
"Santiago",
"America/Santiago",
"Newfoundland",
"America/St_Johns",
"Asuncion",
"America/Asuncion",
"Brasilia",
"America/Sao_Paulo",
"Buenos Aires",
"America/Argentina/Buenos_Aires",
"Montevideo",
"America/Montevideo",
"Greenland",
"America/Nuuk",
"Mid-Atlantic",
"Atlantic/South_Georgia",
"Azores",
"Atlantic/Azores",
"Cape Verde Is.",
"Atlantic/Cape_Verde",
"Edinburgh",
"Europe/London",
"Lisbon",
"Europe/Lisbon",
"London",
"Monrovia",
"Africa/Monrovia",
"UTC",
"Etc/UTC",
"Amsterdam",
"Europe/Amsterdam",
"Belgrade",
"Europe/Belgrade",
"Berlin",
"Europe/Berlin",
"Bern",
"Europe/Zurich",
"Bratislava",
"Europe/Bratislava",
"Brussels",
"Europe/Brussels",
"Budapest",
"Europe/Budapest",
"Casablanca",
"Africa/Casablanca",
"Copenhagen",
"Europe/Copenhagen",
"Dublin",
"Europe/Dublin",
"Ljubljana",
"Europe/Ljubljana",
"Madrid",
"Europe/Madrid",
"Paris",
"Europe/Paris",
"Prague",
"Europe/Prague",
"Rome",
"Europe/Rome",
"Sarajevo",
"Europe/Sarajevo",
"Skopje",
"Europe/Skopje",
"Stockholm",
"Europe/Stockholm",
"Vienna",
"Europe/Vienna",
"Warsaw",
"Europe/Warsaw",
"West Central Africa",
"Africa/Algiers",
"Zagreb",
"Europe/Zagreb",
"Zurich",
"Athens",
"Europe/Athens",
"Bucharest",
"Europe/Bucharest",
"Cairo",
"Africa/Cairo",
"Harare",
"Africa/Harare",
"Helsinki",
"Europe/Helsinki",
"Jerusalem",
"Asia/Jerusalem",
"Kaliningrad",
"Europe/Kaliningrad",
"Kyiv",
"Europe/Kiev",
"Pretoria",
"Africa/Johannesburg",
"Riga",
"Europe/Riga",
"Sofia",
"Europe/Sofia",
"Tallinn",
"Europe/Tallinn",
"Vilnius",
"Europe/Vilnius",
"Baghdad",
"Asia/Baghdad",
"Istanbul",
"Europe/Istanbul",
"Kuwait",
"Asia/Kuwait",
"Minsk",
"Europe/Minsk",
"Moscow",
"Europe/Moscow",
"Nairobi",
"Africa/Nairobi",
"Riyadh",
"Asia/Riyadh",
"St. Petersburg",
"Volgograd",
"Europe/Volgograd",
"Tehran",
"Asia/Tehran",
"Abu Dhabi",
"Asia/Muscat",
"Baku",
"Asia/Baku",
"Muscat",
"Samara",
"Europe/Samara",
"Tbilisi",
"Asia/Tbilisi",
"Yerevan",
"Asia/Yerevan",
"Kabul",
"Asia/Kabul",
"Almaty",
"Asia/Almaty",
"Astana",
"Ekaterinburg",
"Asia/Yekaterinburg",
"Islamabad",
"Asia/Karachi",
"Karachi",
"Tashkent",
"Asia/Tashkent",
"Chennai",
"Asia/Kolkata",
"Kolkata",
"Mumbai",
"New Delhi",
"Sri Jayawardenepura",
"Asia/Colombo",
"Kathmandu",
"Asia/Kathmandu",
"Dhaka",
"Asia/Dhaka",
"Urumqi",
"Asia/Urumqi",
"Rangoon",
"Asia/Rangoon",
"Bangkok",
"Asia/Bangkok",
"Hanoi",
"Jakarta",
"Asia/Jakarta",
"Krasnoyarsk",
"Asia/Krasnoyarsk",
"Novosibirsk",
"Asia/Novosibirsk",
"Beijing",
"Asia/Shanghai",
"Chongqing",
"Asia/Chongqing",
"Hong Kong",
"Asia/Hong_Kong",
"Irkutsk",
"Asia/Irkutsk",
"Kuala Lumpur",
"Asia/Kuala_Lumpur",
"Perth",
"Australia/Perth",
"Singapore",
"Asia/Singapore",
"Taipei",
"Asia/Taipei",
"Ulaanbaatar",
"Asia/Ulaanbaatar",
"Osaka",
"Asia/Tokyo",
"Sapporo",
"Seoul",
"Asia/Seoul",
"Tokyo",
"Yakutsk",
"Asia/Yakutsk",
"Adelaide",
"Australia/Adelaide",
"Darwin",
"Australia/Darwin",
"Brisbane",
"Australia/Brisbane",
"Canberra",
"Australia/Canberra",
"Guam",
"Pacific/Guam",
"Hobart",
"Australia/Hobart",
"Melbourne",
"Australia/Melbourne",
"Port Moresby",
"Pacific/Port_Moresby",
"Sydney",
"Australia/Sydney",
"Vladivostok",
"Asia/Vladivostok",
"Magadan",
"Asia/Magadan",
"New Caledonia",
"Pacific/Noumea",
"Solomon Is.",
"Pacific/Guadalcanal",
"Srednekolymsk",
"Asia/Srednekolymsk",
"Auckland",
"Pacific/Auckland",
"Fiji",
"Pacific/Fiji",
"Kamchatka",
"Asia/Kamchatka",
"Marshall Is.",
"Pacific/Majuro",
"Wellington",
"Chatham Is.",
"Pacific/Chatham",
"Nuku'alofa",
"Pacific/Tongatapu",
"Samoa",
"Pacific/Apia",
"Tokelau Is.",
"Pacific/Fakaofo",
"America/Adak",
"America/Atka",
"US/Aleutian",
"America/Vancouver",
"Canada/Pacific",
"America/Miquelon",
"Australia/Eucla",
"Australia/LHI",
"Australia/Lord_Howe",
"Chile/EasterIsland",
"Pacific/Easter",
"Pacific/Gambier",
"Pacific/Pitcairn",
"Pacific/Marquesas",
"Pacific/Kiritimati",
"Pacific/Norfolk"
],
"nullable": true
},
"time_restrictions": {
"type": "array",
"description": "If time restrictions are set, alerts will follow this path when they arrive within the specified time ranges and meet the rules.",
"items": {
"type": "object",
"properties": {
"start_day": {
"type": "string",
"enum": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday",
"sunday"
]
},
"start_time": {
"type": "string",
"description": "Formatted as HH:MM"
},
"end_day": {
"type": "string",
"enum": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday",
"sunday"
]
},
"end_time": {
"type": "string",
"description": "Formatted as HH:MM"
}
}
}
}
},
"required": [
"name",
"default",
"notification_type",
"escalation_policy_id",
"repeat",
"repeat_count"
]
},
"escalation_policy_path_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the escalation policy path"
},
"type": {
"type": "string",
"enum": [
"escalation_paths"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/escalation_policy_path"
}
]
}
},
"required": [
"id",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"escalation_policy_path_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the escalation policy path"
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/escalation_policy_path"
}
]
}
},
"required": [
"id",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_escalation_policy_level": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"escalation_levels"
]
},
"attributes": {
"type": "object",
"properties": {
"delay": {
"type": "integer",
"description": "Delay before notifying targets in the next Escalation Level."
},
"position": {
"type": "integer",
"description": "Position of the escalation policy level"
},
"paging_strategy_configuration_strategy": {
"type": "string",
"enum": [
"default",
"random",
"cycle",
"alert"
],
"nullable": true,
"default": "default"
},
"paging_strategy_configuration_schedule_strategy": {
"type": "string",
"enum": [
"on_call_only",
"everyone"
],
"nullable": true,
"default": "on_call_only"
},
"escalation_policy_path_id": {
"type": "string",
"description": "The ID of the dynamic escalation policy path the level will belong to. If nothing is specified it will add the level to your default path.",
"nullable": true
},
"notification_target_params": {
"type": "array",
"description": "Escalation level's notification targets",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of notification target. If Slack channel, then id of the slack channel (eg. C06Q2JK7RQW)"
},
"type": {
"type": "string",
"description": "The type of the notification target",
"enum": [
"team",
"user",
"schedule",
"slack_channel",
"service"
]
},
"team_members": {
"type": "string",
"enum": [
"all",
"admins",
"escalate"
],
"nullable": true,
"description": "For targets with type=team, controls whether to notify admins, all team members, or escalate to team EP."
}
},
"required": [
"id",
"type"
],
"nullable": true
}
}
},
"required": [
"position",
"notification_target_params"
],
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_escalation_policy_level": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"escalation_levels"
]
},
"attributes": {
"type": "object",
"properties": {
"delay": {
"type": "integer",
"description": "Delay before notifying targets in the next Escalation Level."
},
"position": {
"type": "integer",
"description": "Position of the escalation policy level"
},
"escalation_policy_path_id": {
"type": "string",
"description": "The ID of the dynamic escalation policy path the level will belong to. If nothing is specified it will add the level to your default path.",
"nullable": true
},
"paging_strategy_configuration_strategy": {
"type": "string",
"enum": [
"default",
"random",
"cycle",
"alert"
],
"nullable": true,
"default": "default"
},
"paging_strategy_configuration_schedule_strategy": {
"type": "string",
"enum": [
"on_call_only",
"everyone"
],
"nullable": true,
"default": "on_call_only"
},
"notification_target_params": {
"type": "array",
"description": "Escalation level's notification targets",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of notification target"
},
"type": {
"type": "string",
"description": "The type of the notification target",
"enum": [
"team",
"user",
"schedule",
"slack_channel",
"service"
]
},
"team_members": {
"type": "string",
"enum": [
"all",
"admins",
"escalate"
],
"nullable": true,
"description": "For targets with type=team, controls whether to notify admins, all team members, or escalate to team EP."
}
},
"required": [
"id",
"type"
],
"nullable": true
}
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"escalation_policy_level": {
"type": "object",
"properties": {
"escalation_policy_id": {
"type": "string",
"description": "The ID of the escalation policy"
},
"escalation_policy_path_id": {
"type": "string",
"description": "The ID of the dynamic escalation policy path the level will belong to. If nothing is specified it will add the level to your default path.",
"nullable": true
},
"paging_strategy_configuration_strategy": {
"type": "string",
"enum": [
"default",
"random",
"cycle",
"alert"
],
"nullable": true,
"default": "default"
},
"paging_strategy_configuration_schedule_strategy": {
"type": "string",
"enum": [
"on_call_only",
"everyone"
],
"nullable": true,
"default": "on_call_only"
},
"delay": {
"type": "integer",
"description": "Delay before notifying targets in the next Escalation Level."
},
"position": {
"type": "integer",
"description": "Position of the escalation policy level"
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
},
"notification_target_params": {
"type": "array",
"description": "Escalation level's notification targets",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of notification target"
},
"type": {
"type": "string",
"description": "The type of the notification target",
"enum": [
"team",
"user",
"schedule",
"slack_channel",
"service"
]
},
"team_members": {
"type": "string",
"enum": [
"all",
"admins",
"escalate"
],
"nullable": true,
"description": "For targets with type=team, controls whether to notify admins, all team members, or escalate to team EP."
}
},
"required": [
"id",
"type"
],
"nullable": true
}
}
},
"required": [
"escalation_policy_id",
"position",
"delay",
"notification_target_params"
]
},
"escalation_policy_level_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the escalation policy level"
},
"type": {
"type": "string",
"enum": [
"escalation_levels"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/escalation_policy_level"
}
]
}
},
"required": [
"id",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"escalation_policy_level_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the escalation policy level"
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/escalation_policy_level"
}
]
}
},
"required": [
"id",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_form_field_option": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"form_field_options"
]
},
"attributes": {
"type": "object",
"properties": {
"form_field_id": {
"type": "string",
"description": "The ID of the form field"
},
"value": {
"type": "string",
"description": "The value of the form field option"
},
"color": {
"type": "string",
"description": "The hex color of the form field option"
},
"default": {
"type": "boolean"
},
"position": {
"type": "integer",
"description": "The position of the form field option"
}
},
"additionalProperties": false,
"required": [
"form_field_id",
"value"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_form_field_option": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"form_field_options"
]
},
"attributes": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The value of the form field option"
},
"color": {
"type": "string",
"description": "The hex color of the form field option"
},
"default": {
"type": "boolean"
},
"position": {
"type": "integer",
"description": "The position of the form field option"
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"form_field_option": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the form field option"
},
"form_field_id": {
"type": "string",
"description": "The ID of the parent custom field"
},
"value": {
"type": "string",
"description": "The value of the form field option"
},
"color": {
"type": "string",
"description": "The hex color of the form field option"
},
"default": {
"type": "boolean"
},
"position": {
"type": "integer",
"description": "The position of the form field option"
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"value",
"color",
"position",
"created_at",
"updated_at"
]
},
"form_field_option_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the form field option"
},
"type": {
"type": "string",
"enum": [
"form_field_options"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/form_field_option"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"form_field_option_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the form field option"
},
"type": {
"type": "string",
"enum": [
"form_field_options"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/form_field_option"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_form_field_placement_condition": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"form_field_placement_conditions"
]
},
"attributes": {
"type": "object",
"properties": {
"conditioned": {
"type": "string",
"description": "The resource or attribute the condition applies.",
"enum": [
"placement",
"required"
]
},
"position": {
"type": "integer",
"description": "The condition position."
},
"form_field_id": {
"type": "string",
"description": "The condition field."
},
"comparison": {
"type": "string",
"description": "The condition comparison.",
"enum": [
"equal",
"not_equal",
"is_set",
"is_not_set"
]
},
"values": {
"type": "array",
"description": "The values for comparison.",
"items": {
"type": "string",
"description": "The value for comparison."
}
}
},
"required": [
"conditioned",
"form_field_id",
"comparison",
"values"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_form_field_placement_condition": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"form_field_placement_conditions"
]
},
"attributes": {
"type": "object",
"properties": {
"conditioned": {
"type": "string",
"description": "The resource or attribute the condition applies.",
"enum": [
"placement",
"required"
]
},
"position": {
"type": "integer",
"description": "The condition position."
},
"form_field_id": {
"type": "string",
"description": "The condition field."
},
"comparison": {
"type": "string",
"description": "The condition comparison.",
"enum": [
"equal",
"not_equal",
"is_set",
"is_not_set"
]
},
"values": {
"type": "array",
"description": "The values for comparison.",
"items": {
"type": "string",
"description": "The value for comparison."
}
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"form_field_placement_condition": {
"type": "object",
"properties": {
"form_field_placement_id": {
"type": "string",
"description": "The form field placement this condition applies."
},
"conditioned": {
"type": "string",
"description": "The resource or attribute the condition applies.",
"enum": [
"placement",
"required"
]
},
"position": {
"type": "integer",
"description": "The condition position."
},
"form_field_id": {
"type": "string",
"description": "The condition field."
},
"comparison": {
"type": "string",
"description": "The condition comparison.",
"enum": [
"equal",
"not_equal",
"is_set",
"is_not_set"
]
},
"values": {
"type": "array",
"description": "The values for comparison.",
"items": {
"type": "string",
"description": "The value for comparison."
}
}
},
"required": [
"form_field_placement_id",
"conditioned",
"position",
"form_field_id",
"comparison",
"values"
]
},
"form_field_placement_condition_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the form set condition"
},
"type": {
"type": "string",
"enum": [
"form_field_placement_conditions"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/form_field_placement_condition"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"form_field_placement_condition_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the form set condition"
},
"type": {
"type": "string",
"enum": [
"form_field_placement_conditions"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/form_field_placement_condition"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_form_field_placement": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"form_field_placements"
]
},
"attributes": {
"type": "object",
"properties": {
"form_set_id": {
"type": "string",
"description": "The form set this field is placed in."
},
"form": {
"type": "string",
"description": "The form this field is placed on."
},
"position": {
"type": "integer",
"description": "The position of the field placement."
},
"required": {
"type": "boolean",
"description": "Whether the field is unconditionally required on this form."
},
"required_operator": {
"type": "string",
"description": "Logical operator when evaluating multiple form_field_placement_conditions with conditioned=required",
"enum": [
"and",
"or"
]
},
"placement_operator": {
"type": "string",
"description": "Logical operator when evaluating multiple form_field_placement_conditions with conditioned=placement",
"enum": [
"and",
"or"
]
},
"non_editable": {
"type": "boolean",
"description": "Whether the field is read-only and cannot be edited by users."
}
},
"required": [
"form_set_id",
"form"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_form_field_placement": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"form_field_placements"
]
},
"attributes": {
"type": "object",
"properties": {
"form_set_id": {
"type": "string",
"description": "The form set this field is placed in."
},
"form": {
"type": "string",
"description": "The form this field is placed on."
},
"position": {
"type": "integer",
"description": "The position of the field placement."
},
"required": {
"type": "boolean",
"description": "Whether the field is unconditionally required on this form."
},
"required_operator": {
"type": "string",
"description": "Logical operator when evaluating multiple form_field_placement_conditions with conditioned=required",
"enum": [
"and",
"or"
]
},
"placement_operator": {
"type": "string",
"description": "Logical operator when evaluating multiple form_field_placement_conditions with conditioned=placement",
"enum": [
"and",
"or"
]
},
"non_editable": {
"type": "boolean",
"description": "Whether the field is read-only and cannot be edited by users."
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"form_field_placement": {
"type": "object",
"properties": {
"form_field_id": {
"type": "string",
"description": "The form field that is placed."
},
"form_set_id": {
"type": "string",
"description": "The form set this field is placed in."
},
"form": {
"type": "string",
"description": "The form this field is placed on."
},
"position": {
"type": "integer",
"description": "The position of the field placement."
},
"required": {
"type": "boolean",
"description": "Whether the field is unconditionally required on this form."
},
"required_operator": {
"type": "string",
"description": "Logical operator when evaluating multiple form_field_placement_conditions with conditioned=required",
"enum": [
"and",
"or"
]
},
"placement_operator": {
"type": "string",
"description": "Logical operator when evaluating multiple form_field_placement_conditions with conditioned=placement",
"enum": [
"and",
"or"
]
},
"non_editable": {
"type": "boolean",
"description": "Whether the field is read-only and cannot be edited by users."
}
},
"required": [
"form_field_id",
"form_set_id",
"form",
"position",
"required"
]
},
"form_field_placement_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the form field placement"
},
"type": {
"type": "string",
"enum": [
"form_field_placements"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/form_field_placement"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"form_field_placement_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the form field placement"
},
"type": {
"type": "string",
"enum": [
"form_field_placements"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/form_field_placement"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_form_field_position": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"form_field_positions"
]
},
"attributes": {
"type": "object",
"properties": {
"form_field_id": {
"type": "string",
"description": "The ID of the form field."
},
"form": {
"type": "string",
"description": "The form for the position",
"enum": [
"web_new_incident_form",
"web_update_incident_form",
"web_incident_post_mortem_form",
"web_incident_mitigation_form",
"web_incident_resolution_form",
"web_incident_cancellation_form",
"web_scheduled_incident_form",
"web_update_scheduled_incident_form",
"incident_post_mortem",
"slack_new_incident_form",
"slack_update_incident_form",
"slack_update_incident_status_form",
"slack_incident_mitigation_form",
"slack_incident_resolution_form",
"slack_incident_cancellation_form",
"slack_scheduled_incident_form",
"slack_update_scheduled_incident_form"
]
},
"position": {
"type": "integer",
"description": "The position of the form_field_position"
}
},
"additionalProperties": false,
"required": [
"form_field_id",
"position",
"form"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_form_field_position": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"form_field_positions"
]
},
"attributes": {
"type": "object",
"properties": {
"form_field_id": {
"type": "string",
"description": "The ID of the form field."
},
"form": {
"type": "string",
"description": "The form for the position",
"enum": [
"web_new_incident_form",
"web_update_incident_form",
"web_incident_post_mortem_form",
"web_incident_mitigation_form",
"web_incident_resolution_form",
"web_incident_cancellation_form",
"web_scheduled_incident_form",
"web_update_scheduled_incident_form",
"incident_post_mortem",
"slack_new_incident_form",
"slack_update_incident_form",
"slack_update_incident_status_form",
"slack_incident_mitigation_form",
"slack_incident_resolution_form",
"slack_incident_cancellation_form",
"slack_scheduled_incident_form",
"slack_update_scheduled_incident_form"
]
},
"position": {
"type": "integer",
"description": "The position of the form_field_position"
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"form_field_position": {
"type": "object",
"properties": {
"form_field_id": {
"type": "string",
"description": "The ID of the form field."
},
"form": {
"type": "string",
"description": "The form for the position",
"enum": [
"web_new_incident_form",
"web_update_incident_form",
"web_incident_post_mortem_form",
"web_incident_mitigation_form",
"web_incident_resolution_form",
"web_incident_cancellation_form",
"web_scheduled_incident_form",
"web_update_scheduled_incident_form",
"incident_post_mortem",
"slack_new_incident_form",
"slack_update_incident_form",
"slack_update_incident_status_form",
"slack_incident_mitigation_form",
"slack_incident_resolution_form",
"slack_incident_cancellation_form",
"slack_scheduled_incident_form",
"slack_update_scheduled_incident_form"
]
},
"position": {
"type": "integer",
"description": "The position of the form_field_position"
}
},
"required": [
"form_field_id",
"position",
"form"
]
},
"form_field_position_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the form_field_position"
},
"type": {
"type": "string",
"enum": [
"form_field_positions"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/form_field_position"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"form_field_position_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the form_field_position"
},
"type": {
"type": "string",
"enum": [
"form_field_positions"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/form_field_position"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_form_field": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"form_fields"
]
},
"attributes": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "The kind of the form field",
"enum": [
"custom",
"title",
"summary",
"mitigation_message",
"resolution_message",
"severity",
"environments",
"types",
"services",
"causes",
"functionalities",
"teams",
"visibility",
"mark_as_test",
"mark_as_backfilled",
"labels",
"notify_emails",
"trigger_manual_workflows",
"show_ongoing_incidents",
"attach_alerts",
"mark_as_in_triage",
"in_triage_at",
"started_at",
"detected_at",
"acknowledged_at",
"mitigated_at",
"resolved_at",
"closed_at",
"custom_sub_status",
"manual_starting_datetime_field"
]
},
"input_kind": {
"type": "string",
"description": "The input kind of the form field",
"enum": [
"text",
"textarea",
"select",
"multi_select",
"date",
"datetime",
"number",
"checkbox",
"tags",
"rich_text"
]
},
"value_kind": {
"type": "string",
"description": "The value kind of the form field",
"enum": [
"inherit",
"group",
"service",
"functionality",
"user",
"catalog_entity",
"environment",
"cause",
"incident_type"
]
},
"value_kind_catalog_id": {
"type": "string",
"description": "The ID of the catalog used when value_kind is `catalog_entity`",
"nullable": true
},
"name": {
"type": "string",
"description": "The name of the form field"
},
"description": {
"type": "string",
"description": "The description of the form field",
"nullable": true
},
"shown": {
"type": "array",
"items": {
"type": "string",
"description": "Where the form field is shown. Add custom forms using the custom form's `slug` field. Or choose a built-in form: `web_new_incident_form`, `web_update_incident_form`, `web_incident_post_mortem_form`, `web_incident_mitigation_form`, `web_incident_resolution_form`, `web_incident_cancellation_form`, `web_scheduled_incident_form`, `web_update_scheduled_incident_form`, `incident_post_mortem`, `slack_new_incident_form`, `slack_update_incident_form`, `slack_update_incident_status_form`, `slack_incident_mitigation_form`, `slack_incident_resolution_form`, `slack_incident_cancellation_form`, `slack_scheduled_incident_form`, `slack_update_scheduled_incident_form`"
}
},
"required": {
"type": "array",
"items": {
"type": "string",
"description": "Where the form field is required. Add custom forms using the custom form's `slug` field. Or choose a built-in form: `web_new_incident_form`, `web_update_incident_form`, `web_incident_post_mortem_form`, `web_incident_mitigation_form`, `web_incident_resolution_form`, `web_incident_cancellation_form`, `web_scheduled_incident_form`, `web_update_scheduled_incident_form`, `slack_new_incident_form`, `slack_update_incident_form`, `slack_update_incident_status_form`, `slack_incident_mitigation_form`, `slack_incident_resolution_form`, `slack_incident_cancellation_form`, `slack_scheduled_incident_form`, `slack_update_scheduled_incident_form`"
}
},
"show_on_incident_details": {
"type": "boolean",
"description": "Whether the form field is shown on the incident details panel"
},
"enabled": {
"type": "boolean",
"description": "Whether the form field is enabled"
},
"default_values": {
"type": "array",
"items": {
"type": "string",
"description": "The default values."
}
},
"auto_set_by_catalog_property_id": {
"type": "string",
"description": "Catalog property ID to auto-set this form field. Only reference-kind catalog properties are supported.",
"nullable": true
}
},
"additionalProperties": false,
"required": [
"kind",
"name"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_form_field": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"form_fields"
]
},
"attributes": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "The kind of the form field",
"enum": [
"custom",
"title",
"summary",
"mitigation_message",
"resolution_message",
"severity",
"environments",
"types",
"services",
"causes",
"functionalities",
"teams",
"visibility",
"mark_as_test",
"mark_as_backfilled",
"labels",
"notify_emails",
"trigger_manual_workflows",
"show_ongoing_incidents",
"attach_alerts",
"mark_as_in_triage",
"in_triage_at",
"started_at",
"detected_at",
"acknowledged_at",
"mitigated_at",
"resolved_at",
"closed_at",
"custom_sub_status",
"manual_starting_datetime_field"
]
},
"input_kind": {
"type": "string",
"description": "The input kind of the form field",
"enum": [
"text",
"textarea",
"select",
"multi_select",
"date",
"datetime",
"number",
"checkbox",
"tags",
"rich_text"
]
},
"value_kind": {
"type": "string",
"description": "The value kind of the form field",
"enum": [
"inherit",
"group",
"service",
"functionality",
"user",
"catalog_entity",
"environment",
"cause",
"incident_type"
]
},
"value_kind_catalog_id": {
"type": "string",
"description": "The ID of the catalog used when value_kind is `catalog_entity`",
"nullable": true
},
"name": {
"type": "string",
"description": "The name of the form field"
},
"description": {
"type": "string",
"description": "The description of the form field",
"nullable": true
},
"shown": {
"type": "array",
"items": {
"type": "string",
"description": "Where the form field is shown. Add custom forms using the custom form's `slug` field. Or choose a built-in form: `web_new_incident_form`, `web_update_incident_form`, `web_incident_post_mortem_form`, `web_incident_mitigation_form`, `web_incident_resolution_form`, `web_incident_cancellation_form`, `web_scheduled_incident_form`, `web_update_scheduled_incident_form`, `incident_post_mortem`, `slack_new_incident_form`, `slack_update_incident_form`, `slack_update_incident_status_form`, `slack_incident_mitigation_form`, `slack_incident_resolution_form`, `slack_incident_cancellation_form`, `slack_scheduled_incident_form`, `slack_update_scheduled_incident_form`"
}
},
"required": {
"type": "array",
"items": {
"type": "string",
"description": "Where the form field is required. Add custom forms using the custom form's `slug` field. Or choose a built-in form: `web_new_incident_form`, `web_update_incident_form`, `web_incident_post_mortem_form`, `web_incident_mitigation_form`, `web_incident_resolution_form`, `web_incident_cancellation_form`, `web_scheduled_incident_form`, `web_update_scheduled_incident_form`, `slack_new_incident_form`, `slack_update_incident_form`, `slack_update_incident_status_form`, `slack_incident_mitigation_form`, `slack_incident_resolution_form`, `slack_incident_cancellation_form`, `slack_scheduled_incident_form`, `slack_update_scheduled_incident_form`"
}
},
"show_on_incident_details": {
"type": "boolean",
"description": "Whether the form field is shown on the incident details panel"
},
"enabled": {
"type": "boolean",
"description": "Whether the form field is enabled"
},
"default_values": {
"type": "array",
"items": {
"type": "string",
"description": "The default values."
}
},
"auto_set_by_catalog_property_id": {
"type": "string",
"description": "Catalog property ID to auto-set this form field. Only reference-kind catalog properties are supported.",
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"form_field": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "The kind of the form field",
"enum": [
"custom",
"title",
"summary",
"mitigation_message",
"resolution_message",
"severity",
"environments",
"types",
"services",
"causes",
"functionalities",
"teams",
"visibility",
"mark_as_test",
"mark_as_backfilled",
"labels",
"notify_emails",
"trigger_manual_workflows",
"show_ongoing_incidents",
"attach_alerts",
"mark_as_in_triage",
"in_triage_at",
"started_at",
"detected_at",
"acknowledged_at",
"mitigated_at",
"resolved_at",
"closed_at",
"custom_sub_status",
"manual_starting_datetime_field"
]
},
"input_kind": {
"type": "string",
"description": "The input kind of the form field",
"enum": [
"text",
"textarea",
"select",
"multi_select",
"date",
"datetime",
"number",
"checkbox",
"tags",
"rich_text"
]
},
"value_kind": {
"type": "string",
"description": "The value kind of the form field",
"enum": [
"inherit",
"group",
"service",
"functionality",
"user",
"catalog_entity",
"environment",
"cause",
"incident_type"
]
},
"value_kind_catalog_id": {
"type": "string",
"description": "The ID of the catalog used when value_kind is `catalog_entity`",
"nullable": true
},
"name": {
"type": "string",
"description": "The name of the form field"
},
"slug": {
"type": "string",
"description": "The slug of the form field"
},
"description": {
"type": "string",
"description": "The description of the form field",
"nullable": true
},
"shown": {
"type": "array",
"items": {
"type": "string",
"description": "Where the form field is shown. Add custom forms using the custom form's `slug` field. Or choose a built-in form: `web_new_incident_form`, `web_update_incident_form`, `web_incident_post_mortem_form`, `web_incident_mitigation_form`, `web_incident_resolution_form`, `web_incident_cancellation_form`, `web_scheduled_incident_form`, `web_update_scheduled_incident_form`, `incident_post_mortem`, `slack_new_incident_form`, `slack_update_incident_form`, `slack_update_incident_status_form`, `slack_incident_mitigation_form`, `slack_incident_resolution_form`, `slack_incident_cancellation_form`, `slack_scheduled_incident_form`, `slack_update_scheduled_incident_form`"
}
},
"required": {
"type": "array",
"items": {
"type": "string",
"description": "Where the form field is required. Add custom forms using the custom form's `slug` field. Or choose a built-in form: `web_new_incident_form`, `web_update_incident_form`, `web_incident_post_mortem_form`, `web_incident_mitigation_form`, `web_incident_resolution_form`, `web_incident_cancellation_form`, `web_scheduled_incident_form`, `web_update_scheduled_incident_form`, `slack_new_incident_form`, `slack_update_incident_form`, `slack_update_incident_status_form`, `slack_incident_mitigation_form`, `slack_incident_resolution_form`, `slack_incident_cancellation_form`, `slack_scheduled_incident_form`, `slack_update_scheduled_incident_form`"
}
},
"show_on_incident_details": {
"type": "boolean",
"description": "Whether the form field is shown on the incident details panel"
},
"enabled": {
"type": "boolean",
"description": "Whether the form field is enabled"
},
"default_values": {
"type": "array",
"items": {
"type": "string",
"description": "The default values."
}
},
"auto_set_by_catalog_property_id": {
"type": "string",
"description": "Catalog property ID to auto-set this form field. Only reference-kind catalog properties are supported.",
"nullable": true
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"kind",
"input_kind",
"value_kind",
"name",
"shown",
"required",
"default_values",
"created_at",
"updated_at"
]
},
"form_field_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the form field"
},
"type": {
"type": "string",
"enum": [
"form_fields"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/form_field"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"form_field_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the form field"
},
"type": {
"type": "string",
"enum": [
"form_fields"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/form_field"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_form_set_condition": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"form_set_conditions"
]
},
"attributes": {
"type": "object",
"properties": {
"form_field_id": {
"type": "string",
"description": "The form field this condition applies."
},
"comparison": {
"type": "string",
"description": "The condition comparison.",
"enum": [
"equal"
]
},
"values": {
"type": "array",
"description": "The values for comparison.",
"items": {
"type": "string",
"description": "The value for comparison."
}
}
},
"required": [
"form_field_id",
"comparison",
"values"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_form_set_condition": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"form_set_conditions"
]
},
"attributes": {
"type": "object",
"properties": {
"form_field_id": {
"type": "string",
"description": "The form field this condition applies."
},
"comparison": {
"type": "string",
"description": "The condition comparison.",
"enum": [
"equal"
]
},
"values": {
"type": "array",
"description": "The values for comparison.",
"items": {
"type": "string",
"description": "The value for comparison."
}
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"form_set_condition": {
"type": "object",
"properties": {
"form_set_id": {
"type": "string",
"description": "The form set this condition applies."
},
"form_field_id": {
"type": "string",
"description": "The form field this condition applies."
},
"comparison": {
"type": "string",
"description": "The condition comparison.",
"enum": [
"equal"
]
},
"values": {
"type": "array",
"description": "The values for comparison.",
"items": {
"type": "string",
"description": "The value for comparison."
}
}
},
"required": [
"form_set_id",
"form_field_id",
"comparison",
"values"
]
},
"form_set_condition_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the form set condition"
},
"type": {
"type": "string",
"enum": [
"form_set_conditions"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/form_set_condition"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"form_set_condition_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the form set condition"
},
"type": {
"type": "string",
"enum": [
"form_set_conditions"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/form_set_condition"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_form_set": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"form_sets"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the form set"
},
"forms": {
"type": "array",
"description": "The forms included in the form set. Add custom forms using the custom form's `slug` field. Or choose a built-in form: `web_new_incident_form`, `web_update_incident_form`, `web_incident_post_mortem_form`, `web_incident_mitigation_form`, `web_incident_resolution_form`, `web_incident_cancellation_form`, `web_scheduled_incident_form`, `web_update_scheduled_incident_form`, `slack_new_incident_form`, `slack_update_incident_form`, `slack_update_incident_status_form`, `slack_incident_mitigation_form`, `slack_incident_resolution_form`, `slack_incident_cancellation_form`, `slack_scheduled_incident_form`, `slack_update_scheduled_incident_form`, `google_chat_new_incident_form`, `google_chat_update_incident_form`",
"items": {
"type": "string",
"description": "The form included in the form set. Add custom forms using the custom form's `slug` field. Or choose a built-in form: `web_new_incident_form`, `web_update_incident_form`, `web_incident_post_mortem_form`, `web_incident_mitigation_form`, `web_incident_resolution_form`, `web_incident_cancellation_form`, `web_scheduled_incident_form`, `web_update_scheduled_incident_form`, `slack_new_incident_form`, `slack_update_incident_form`, `slack_update_incident_status_form`, `slack_incident_mitigation_form`, `slack_incident_resolution_form`, `slack_incident_cancellation_form`, `slack_scheduled_incident_form`, `slack_update_scheduled_incident_form`, `google_chat_new_incident_form`, `google_chat_update_incident_form`"
}
}
},
"additionalProperties": false,
"required": [
"name",
"forms"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_form_set": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"form_sets"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the form set"
},
"forms": {
"type": "array",
"description": "The forms included in the form set. Add custom forms using the custom form's `slug` field. Or choose a built-in form: `web_new_incident_form`, `web_update_incident_form`, `web_incident_post_mortem_form`, `web_incident_mitigation_form`, `web_incident_resolution_form`, `web_incident_cancellation_form`, `web_scheduled_incident_form`, `web_update_scheduled_incident_form`, `slack_new_incident_form`, `slack_update_incident_form`, `slack_update_incident_status_form`, `slack_incident_mitigation_form`, `slack_incident_resolution_form`, `slack_incident_cancellation_form`, `slack_scheduled_incident_form`, `slack_update_scheduled_incident_form`, `google_chat_new_incident_form`, `google_chat_update_incident_form`",
"items": {
"type": "string",
"description": "The form included in the form set. Add custom forms using the custom form's `slug` field. Or choose a built-in form: `web_new_incident_form`, `web_update_incident_form`, `web_incident_post_mortem_form`, `web_incident_mitigation_form`, `web_incident_resolution_form`, `web_incident_cancellation_form`, `web_scheduled_incident_form`, `web_update_scheduled_incident_form`, `slack_new_incident_form`, `slack_update_incident_form`, `slack_update_incident_status_form`, `slack_incident_mitigation_form`, `slack_incident_resolution_form`, `slack_incident_cancellation_form`, `slack_scheduled_incident_form`, `slack_update_scheduled_incident_form`, `google_chat_new_incident_form`, `google_chat_update_incident_form`"
}
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"form_set": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the form set"
},
"slug": {
"type": "string",
"description": "The slug of the form set"
},
"is_default": {
"type": "boolean",
"description": "Whether the form set is default"
},
"forms": {
"type": "array",
"description": "The forms included in the form set. Add custom forms using the custom form's `slug` field. Or choose a built-in form: `web_new_incident_form`, `web_update_incident_form`, `web_incident_post_mortem_form`, `web_incident_mitigation_form`, `web_incident_resolution_form`, `web_incident_cancellation_form`, `web_scheduled_incident_form`, `web_update_scheduled_incident_form`, `slack_new_incident_form`, `slack_update_incident_form`, `slack_update_incident_status_form`, `slack_incident_mitigation_form`, `slack_incident_resolution_form`, `slack_incident_cancellation_form`, `slack_scheduled_incident_form`, `slack_update_scheduled_incident_form`, `google_chat_new_incident_form`, `google_chat_update_incident_form`",
"items": {
"type": "string",
"description": "The form included in the form set. Add custom forms using the custom form's `slug` field. Or choose a built-in form: `web_new_incident_form`, `web_update_incident_form`, `web_incident_post_mortem_form`, `web_incident_mitigation_form`, `web_incident_resolution_form`, `web_incident_cancellation_form`, `web_scheduled_incident_form`, `web_update_scheduled_incident_form`, `slack_new_incident_form`, `slack_update_incident_form`, `slack_update_incident_status_form`, `slack_incident_mitigation_form`, `slack_incident_resolution_form`, `slack_incident_cancellation_form`, `slack_scheduled_incident_form`, `slack_update_scheduled_incident_form`, `google_chat_new_incident_form`, `google_chat_update_incident_form`"
}
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"name",
"is_default",
"forms",
"created_at",
"updated_at"
]
},
"form_set_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the form set"
},
"type": {
"type": "string",
"enum": [
"form_sets"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/form_set"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"form_set_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the form set"
},
"type": {
"type": "string",
"enum": [
"form_sets"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/form_set"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_functionality": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"functionalities"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the functionality"
},
"description": {
"type": "string",
"description": "The description of the functionality",
"nullable": true
},
"public_description": {
"type": "string",
"description": "The public description of the functionality",
"nullable": true
},
"notify_emails": {
"type": "array",
"description": "Emails to attach to the functionality",
"items": {
"type": "string"
},
"nullable": true
},
"color": {
"type": "string",
"description": "The hex color of the functionality",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the functionality",
"nullable": true
},
"backstage_id": {
"type": "string",
"description": "The Backstage entity id associated to this functionality. eg: :namespace/:kind/:entity_name",
"nullable": true
},
"external_id": {
"type": "string",
"description": "The external id associated to this functionality",
"nullable": true
},
"pagerduty_id": {
"type": "string",
"description": "The PagerDuty service id associated to this functionality",
"nullable": true
},
"opsgenie_id": {
"type": "string",
"description": "The Opsgenie service id associated to this functionality",
"nullable": true
},
"opsgenie_team_id": {
"type": "string",
"description": "The Opsgenie team id associated to this functionality",
"nullable": true
},
"cortex_id": {
"type": "string",
"description": "The Cortex group id associated to this functionality",
"nullable": true
},
"service_now_ci_sys_id": {
"type": "string",
"description": "The Service Now CI sys id associated to this functionality",
"nullable": true
},
"show_uptime": {
"type": "boolean",
"description": "Show uptime",
"nullable": true
},
"show_uptime_last_days": {
"type": "integer",
"description": "Show uptime over x days",
"enum": [
30,
60,
90
],
"nullable": true,
"default": 60
},
"environment_ids": {
"type": "array",
"description": "Environments associated with this functionality",
"items": {
"type": "string"
},
"nullable": true
},
"service_ids": {
"type": "array",
"description": "Services associated with this functionality",
"items": {
"type": "string"
},
"nullable": true
},
"owner_group_ids": {
"type": "array",
"description": "Owner Teams associated with this functionality",
"items": {
"type": "string"
},
"nullable": true
},
"owner_user_ids": {
"type": "array",
"description": "Owner Users associated with this functionality",
"items": {
"type": "integer"
},
"nullable": true
},
"escalation_policy_id": {
"type": "string",
"description": "The escalation policy id of the functionality",
"nullable": true
},
"slack_channels": {
"type": "array",
"description": "Slack Channels associated with this functionality",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack channel ID"
},
"name": {
"type": "string",
"description": "Slack channel name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
},
"slack_aliases": {
"type": "array",
"description": "Slack Aliases associated with this functionality",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack alias ID"
},
"name": {
"type": "string",
"description": "Slack alias name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
},
"properties": {
"type": "array",
"items": {
"type": "object",
"description": "Set a value for a catalog property",
"properties": {
"catalog_property_id": {
"type": "string",
"description": "Catalog property ID"
},
"value": {
"type": "string",
"description": "The property value"
}
},
"required": [
"catalog_property_id",
"value"
]
},
"description": "Array of property values for this functionality."
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_functionality": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"functionalities"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the functionality"
},
"description": {
"type": "string",
"description": "The description of the functionality",
"nullable": true
},
"public_description": {
"type": "string",
"description": "The public description of the functionality",
"nullable": true
},
"notify_emails": {
"type": "array",
"description": "Emails to attach to the functionality",
"items": {
"type": "string"
},
"nullable": true
},
"color": {
"type": "string",
"description": "The hex color of the functionality",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the functionality",
"nullable": true
},
"backstage_id": {
"type": "string",
"description": "The Backstage entity id associated to this functionality. eg: :namespace/:kind/:entity_name",
"nullable": true
},
"external_id": {
"type": "string",
"description": "The external id associated to this functionality",
"nullable": true
},
"pagerduty_id": {
"type": "string",
"description": "The PagerDuty service id associated to this functionality",
"nullable": true
},
"opsgenie_id": {
"type": "string",
"description": "The Opsgenie service id associated to this functionality",
"nullable": true
},
"opsgenie_team_id": {
"type": "string",
"description": "The Opsgenie team id associated to this functionality",
"nullable": true
},
"cortex_id": {
"type": "string",
"description": "The Cortex group id associated to this functionality",
"nullable": true
},
"service_now_ci_sys_id": {
"type": "string",
"description": "The Service Now CI sys id associated to this functionality",
"nullable": true
},
"environment_ids": {
"type": "array",
"description": "Environments associated with this functionality",
"items": {
"type": "string"
},
"nullable": true
},
"service_ids": {
"type": "array",
"description": "Services associated with this functionality",
"items": {
"type": "string"
},
"nullable": true
},
"owner_group_ids": {
"type": "array",
"description": "Owner Teams associated with this functionality",
"items": {
"type": "string"
},
"nullable": true
},
"owner_user_ids": {
"type": "array",
"description": "Owner Users associated with this functionality",
"items": {
"type": "integer"
},
"nullable": true
},
"escalation_policy_id": {
"type": "string",
"description": "The escalation policy id of the functionality",
"nullable": true
},
"slack_channels": {
"type": "array",
"description": "Slack Channels associated with this functionality",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack channel ID"
},
"name": {
"type": "string",
"description": "Slack channel name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
},
"slack_aliases": {
"type": "array",
"description": "Slack Aliases associated with this functionality",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack alias ID"
},
"name": {
"type": "string",
"description": "Slack alias name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
},
"properties": {
"type": "array",
"items": {
"type": "object",
"description": "Set a value for a catalog property",
"properties": {
"catalog_property_id": {
"type": "string",
"description": "Catalog property ID"
},
"value": {
"type": "string",
"description": "The property value"
}
},
"required": [
"catalog_property_id",
"value"
]
},
"description": "Array of property values for this functionality."
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"functionality": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the functionality"
},
"slug": {
"type": "string",
"description": "The slug of the functionality"
},
"description": {
"type": "string",
"description": "The description of the functionality",
"nullable": true
},
"public_description": {
"type": "string",
"description": "The public description of the functionality",
"nullable": true
},
"notify_emails": {
"type": "array",
"description": "Emails attached to the functionality",
"items": {
"type": "string"
},
"nullable": true
},
"color": {
"type": "string",
"description": "The hex color of the functionality",
"nullable": true
},
"backstage_id": {
"type": "string",
"description": "The Backstage entity id associated to this functionality. eg: :namespace/:kind/:entity_name",
"nullable": true
},
"external_id": {
"type": "string",
"description": "The external id associated to this functionality",
"nullable": true
},
"pagerduty_id": {
"type": "string",
"description": "The PagerDuty service id associated to this functionality",
"nullable": true
},
"opsgenie_id": {
"type": "string",
"description": "The Opsgenie service id associated to this functionality",
"nullable": true
},
"opsgenie_team_id": {
"type": "string",
"description": "The Opsgenie team id associated to this functionality",
"nullable": true
},
"cortex_id": {
"type": "string",
"description": "The Cortex group id associated to this functionality",
"nullable": true
},
"service_now_ci_sys_id": {
"type": "string",
"description": "The Service Now CI sys id associated to this functionality",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the functionality",
"nullable": true
},
"environment_ids": {
"type": "array",
"description": "Environments associated with this functionality",
"items": {
"type": "string"
},
"nullable": true
},
"service_ids": {
"type": "array",
"description": "Services associated with this functionality",
"items": {
"type": "string"
},
"nullable": true
},
"owner_group_ids": {
"type": "array",
"description": "Owner Teams associated with this functionality",
"items": {
"type": "string"
},
"nullable": true
},
"owner_user_ids": {
"type": "array",
"description": "Owner Users associated with this functionality",
"items": {
"type": "integer"
},
"nullable": true
},
"escalation_policy_id": {
"type": "string",
"description": "The escalation policy id of the functionality",
"nullable": true
},
"slack_channels": {
"type": "array",
"description": "Slack Channels associated with this functionality",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack channel ID"
},
"name": {
"type": "string",
"description": "Slack channel name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
},
"slack_aliases": {
"type": "array",
"description": "Slack Aliases associated with this functionality",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack alias ID"
},
"name": {
"type": "string",
"description": "Slack alias name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
},
"properties": {
"type": "array",
"items": {
"type": "object",
"description": "Set a value for a catalog property",
"properties": {
"catalog_property_id": {
"type": "string",
"description": "Catalog property ID"
},
"value": {
"type": "string",
"description": "The property value"
}
},
"required": [
"catalog_property_id",
"value"
]
},
"description": "Array of property values for this functionality.",
"nullable": true
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"name",
"created_at",
"updated_at"
]
},
"functionality_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the functionality"
},
"type": {
"type": "string",
"enum": [
"functionalities"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/functionality"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"functionality_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the functionality"
},
"type": {
"type": "string",
"enum": [
"functionalities"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/functionality"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"add_action_item_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"add_action_item"
]
},
"attribute_to_query_by": {
"type": "string",
"description": "Attribute of the Incident to match against",
"enum": [
"jira_issue_id"
],
"nullable": true
},
"query_value": {
"type": "string",
"description": "Value that attribute_to_query_by to uses to match against",
"nullable": true
},
"incident_role_id": {
"type": "string",
"description": "The role id this action item is associated with"
},
"assigned_to_user_id": {
"type": "string",
"description": "[DEPRECATED] Use assigned_to_user attribute instead. The user id this action item is assigned to"
},
"assigned_to_user": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": " The user this action item is assigned to"
},
"priority": {
"type": "string",
"description": "The action item priority",
"enum": [
"high",
"medium",
"low"
]
},
"kind": {
"type": "string",
"description": "The action item kind"
},
"summary": {
"type": "string",
"description": "The action item summary"
},
"description": {
"type": "string",
"description": "The action item description"
},
"status": {
"type": "string",
"description": "The action item status",
"enum": [
"open",
"in_progress",
"cancelled",
"done"
]
},
"post_to_incident_timeline": {
"type": "boolean"
},
"custom_fields_mapping": {
"type": "string",
"description": "Custom field mappings. Can contain liquid markup and need to be valid JSON",
"nullable": true
},
"post_to_slack_channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
},
"required": [
"summary",
"status",
"priority"
]
},
"update_action_item_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"update_action_item"
]
},
"query_value": {
"type": "string",
"description": "Value that attribute_to_query_by to uses to match against"
},
"attribute_to_query_by": {
"type": "string",
"description": "Attribute of the action item to match against",
"enum": [
"id",
"jira_issue_id",
"asana_task_id",
"shortcut_task_id",
"linear_issue_id",
"zendesk_ticket_id",
"motion_task_id",
"trello_card_id",
"airtable_record_id",
"shortcut_story_id",
"github_issue_id",
"gitlab_issue_id",
"freshservice_ticket_id",
"freshservice_task_id",
"clickup_task_id"
],
"default": "id"
},
"summary": {
"type": "string",
"description": "Brief description of the action item"
},
"assigned_to_user_id": {
"type": "string",
"description": "[DEPRECATED] Use assigned_to_user attribute instead. The user id this action item is assigned to"
},
"assigned_to_user": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": " The user this action item is assigned to"
},
"group_ids": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": {
"type": "string",
"description": "The action item description"
},
"priority": {
"type": "string",
"description": "The action item priority",
"enum": [
"high",
"medium",
"low"
]
},
"status": {
"type": "string",
"description": "The action item status",
"enum": [
"open",
"in_progress",
"cancelled",
"done"
]
},
"custom_fields_mapping": {
"type": "string",
"description": "Custom field mappings. Can contain liquid markup and need to be valid JSON",
"nullable": true
},
"post_to_incident_timeline": {
"type": "boolean"
}
},
"required": [
"query_value",
"attribute_to_query_by"
]
},
"add_role_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"add_role"
]
},
"incident_role_id": {
"type": "string",
"description": "The role id to add to the incident"
},
"assigned_to_user_id": {
"type": "string",
"description": "[DEPRECATED] Use assigned_to_user attribute instead. The user id this role is assigned to"
},
"assigned_to_user": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": " The user this role is assigned to"
}
},
"required": [
"incident_role_id"
]
},
"add_slack_bookmark_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"add_slack_bookmark"
]
},
"playbook_id": {
"type": "string",
"description": "The playbook id if bookmark is of an incident playbook"
},
"channel": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"title": {
"type": "string",
"description": "The bookmark title. Required if not a playbook bookmark",
"nullable": true
},
"link": {
"type": "string",
"description": "The bookmark link. Required if not a playbook bookmark",
"nullable": true
},
"emoji": {
"type": "string",
"description": "The bookmark emoji"
}
},
"required": [
"channel"
],
"anyOf": [
{
"required": [
"title",
"link"
],
"properties": {
"title": {
"type": "string"
},
"link": {
"type": "string"
}
}
},
{
"required": [
"playbook_id"
],
"properties": {
"playbook_id": {
"type": "string"
}
}
}
]
},
"add_team_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"add_team"
]
},
"group_id": {
"type": "string",
"description": "The team id"
}
},
"required": [
"group_id"
]
},
"add_to_timeline_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"add_to_timeline"
]
},
"event": {
"type": "string",
"description": "The timeline event description"
},
"url": {
"type": "string",
"description": "A URL for the timeline event"
},
"post_to_slack_channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
},
"required": [
"event"
]
},
"archive_slack_channels_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"archive_slack_channels"
]
},
"channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
},
"required": [
"channels"
]
},
"attach_datadog_dashboards_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"attach_datadog_dashboards"
]
},
"dashboards": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"post_to_incident_timeline": {
"type": "boolean"
},
"post_to_slack_channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
},
"required": [
"dashboards"
]
},
"auto_assign_role_opsgenie_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"auto_assign_role_opsgenie"
]
},
"incident_role_id": {
"type": "string",
"description": "The role id"
},
"schedule": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"required": [
"incident_role_id",
"schedule"
]
},
"auto_assign_role_rootly_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"auto_assign_role_rootly"
]
},
"incident_role_id": {
"type": "string",
"description": "The role id"
},
"escalation_policy_target": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"service_target": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"user_target": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"group_target": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"schedule_target": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"required": [
"incident_role_id"
]
},
"auto_assign_role_pagerduty_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"auto_assign_role_pagerduty"
]
},
"incident_role_id": {
"type": "string",
"description": "The role id"
},
"service": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"schedule": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"escalation_policy": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"required": [
"incident_role_id"
],
"anyOf": [
{
"required": [
"schedule"
],
"properties": {
"schedule": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
},
{
"required": [
"escalation_policy"
],
"properties": {
"escalation_policy": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
}
]
},
"update_pagerduty_incident_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"update_pagerduty_incident"
]
},
"pagerduty_incident_id": {
"type": "string",
"description": "Pagerduty incident id"
},
"title": {
"type": "string",
"description": "Title to update to"
},
"status": {
"type": "string",
"enum": [
"resolved",
"acknowledged",
"auto"
]
},
"resolution": {
"type": "string",
"description": "A message outlining the incident's resolution in PagerDuty"
},
"escalation_level": {
"type": "integer",
"description": "Escalation level of policy attached to incident",
"minimum": 1,
"maximum": 20,
"example": 1
},
"urgency": {
"type": "string",
"description": "PagerDuty incident urgency, selecting auto will let Rootly auto map our incident severity",
"enum": [
"high",
"low",
"auto"
]
},
"priority": {
"type": "string",
"description": "PagerDuty incident priority, selecting auto will let Rootly auto map our incident severity"
}
},
"required": [
"pagerduty_incident_id"
]
},
"create_pagerduty_status_update_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_pagerduty_status_update"
]
},
"pagerduty_incident_id": {
"type": "string",
"description": "PagerDuty incident id"
},
"message": {
"type": "string",
"description": "A message outlining the incident's resolution in PagerDuty"
}
},
"required": [
"pagerduty_incident_id",
"message"
]
},
"create_pagertree_alert_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_pagertree_alert"
]
},
"title": {
"type": "string",
"description": "Title of alert as text"
},
"description": {
"type": "string",
"description": "Description of alert as text"
},
"urgency": {
"type": "string",
"enum": [
"auto",
"critical",
"high",
"medium",
"low"
]
},
"severity": {
"type": "string",
"enum": [
"auto",
"SEV-1",
"SEV-2",
"SEV-3",
"SEV-4"
]
},
"teams": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"users": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"incident": {
"type": "boolean",
"description": "Setting to true makes an alert a Pagertree incident"
}
}
},
"update_pagertree_alert_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"update_pagertree_alert"
]
},
"pagertree_alert_id": {
"type": "string",
"description": "The prefix ID of the Pagertree alert"
},
"title": {
"type": "string",
"description": "Title of alert as text"
},
"description": {
"type": "string",
"description": "Description of alert as text"
},
"urgency": {
"type": "string",
"enum": [
"auto",
"critical",
"high",
"medium",
"low"
]
},
"severity": {
"type": "string",
"enum": [
"auto",
"SEV-1",
"SEV-2",
"SEV-3",
"SEV-4"
]
},
"teams": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"users": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"incident": {
"type": "boolean",
"description": "Setting to true makes an alert a Pagertree incident"
}
}
},
"auto_assign_role_victor_ops_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"auto_assign_role_victor_ops"
]
},
"incident_role_id": {
"type": "string",
"description": "The role id"
},
"team": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"required": [
"incident_role_id",
"team"
]
},
"call_people_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"call_people"
]
},
"phone_numbers": {
"type": "array",
"items": {
"type": "string",
"description": "A recipient phone number",
"example": [
"14150001111"
]
}
},
"name": {
"type": "string",
"description": "The name"
},
"content": {
"type": "string",
"description": "The message to be read by text-to-voice"
}
},
"required": [
"phone_numbers",
"name",
"content"
]
},
"create_airtable_table_record_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_airtable_table_record"
]
},
"base": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"table": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"custom_fields_mapping": {
"type": "string",
"description": "Custom field mappings. Can contain liquid markup and need to be valid JSON",
"nullable": true
}
},
"required": [
"base",
"table"
]
},
"create_asana_subtask_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_asana_subtask"
]
},
"parent_task_id": {
"type": "string",
"description": "The parent task id"
},
"title": {
"type": "string",
"description": "The subtask title"
},
"notes": {
"type": "string"
},
"assign_user_email": {
"type": "string",
"description": "The assigned user's email"
},
"completion": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"due_date": {
"type": "string",
"description": "The due date"
},
"custom_fields_mapping": {
"type": "string",
"description": "Custom field mappings. Can contain liquid markup and need to be valid JSON",
"nullable": true
},
"dependency_direction": {
"type": "string",
"enum": [
"blocking",
"blocked_by"
],
"default": "blocking"
},
"dependent_task_ids": {
"type": "array",
"description": "Dependent task ids. Supports liquid syntax",
"items": {
"type": "string"
},
"nullable": true
}
},
"required": [
"parent_task_id",
"title",
"completion"
]
},
"create_asana_task_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_asana_task"
]
},
"workspace": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"projects": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"title": {
"type": "string",
"description": "The task title"
},
"notes": {
"type": "string"
},
"assign_user_email": {
"type": "string",
"description": "The assigned user's email"
},
"completion": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"due_date": {
"type": "string",
"description": "The due date"
},
"custom_fields_mapping": {
"type": "string",
"description": "Custom field mappings. Can contain liquid markup and need to be valid JSON",
"nullable": true
},
"dependency_direction": {
"type": "string",
"enum": [
"blocking",
"blocked_by"
],
"default": "blocking"
},
"dependent_task_ids": {
"type": "array",
"description": "Dependent task ids. Supports liquid syntax",
"items": {
"type": "string"
},
"nullable": true
}
},
"required": [
"workspace",
"projects",
"title",
"completion"
]
},
"create_confluence_page_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_confluence_page"
]
},
"integration": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "Specify integration id if you have more than one Confluence instance"
},
"space": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"ancestor": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"template": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"title": {
"type": "string",
"description": "The page title"
},
"content": {
"type": "string",
"description": "The page content"
},
"post_mortem_template_id": {
"type": "string",
"description": "The Retrospective template to use"
},
"mark_post_mortem_as_published": {
"type": "boolean",
"default": true
},
"include_overview": {
"type": "boolean",
"default": true
},
"include_timeline": {
"type": "boolean",
"default": true
},
"create_as_live_doc": {
"type": "boolean",
"default": false
}
},
"required": [
"space",
"title"
]
},
"create_datadog_notebook_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_datadog_notebook"
]
},
"post_mortem_template_id": {
"type": "string",
"description": "Retrospective template to use when creating notebook, if desired"
},
"mark_post_mortem_as_published": {
"type": "boolean",
"default": true
},
"template": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"title": {
"type": "string",
"description": "The notebook title"
},
"kind": {
"type": "string",
"description": "The notebook kind",
"enum": [
"postmortem",
"runbook",
"investigation",
"documentation",
"report"
]
},
"content": {
"type": "string",
"description": "The notebook content"
}
},
"required": [
"title",
"kind"
]
},
"create_coda_page_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_coda_page"
]
},
"post_mortem_template_id": {
"type": "string",
"description": "Retrospective template to use when creating page, if desired"
},
"mark_post_mortem_as_published": {
"type": "boolean",
"default": true
},
"title": {
"type": "string",
"description": "The Coda page title"
},
"subtitle": {
"type": "string",
"description": "The Coda page subtitle"
},
"content": {
"type": "string",
"description": "The Coda page content"
},
"template": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Combined doc_id/page_id in format 'doc_id/page_id'"
},
"name": {
"type": "string"
}
}
},
"folder_id": {
"type": "string",
"description": "The Coda folder id"
},
"doc": {
"type": "object",
"description": "The Coda doc object with id and name",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"required": [
"title"
]
},
"create_dropbox_paper_page_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_dropbox_paper_page"
]
},
"post_mortem_template_id": {
"type": "string",
"description": "Retrospective template to use when creating page task, if desired"
},
"mark_post_mortem_as_published": {
"type": "boolean",
"default": true
},
"title": {
"type": "string",
"description": "The page task title"
},
"content": {
"type": "string",
"description": "The page content"
},
"namespace": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"parent_folder": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"required": [
"title"
]
},
"create_github_issue_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_github_issue"
]
},
"title": {
"type": "string",
"description": "The issue title"
},
"body": {
"type": "string",
"description": "The issue body"
},
"repository": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"labels": {
"type": "array",
"description": "The issue labels",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"issue_type": {
"type": "object",
"description": "The issue type",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"parent_issue_number": {
"type": "string",
"description": "The parent issue number for sub-issue linking",
"nullable": true
},
"custom_fields_mapping": {
"type": "string",
"description": "Custom field mappings. Can contain liquid markup and need to be valid JSON",
"nullable": true
}
},
"required": [
"repository",
"title"
]
},
"create_gitlab_issue_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_gitlab_issue"
]
},
"issue_type": {
"type": "string",
"description": "The issue type",
"enum": [
"issue",
"incident",
"test_case",
"task"
]
},
"title": {
"type": "string",
"description": "The issue title"
},
"description": {
"type": "string",
"description": "The issue description"
},
"repository": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"labels": {
"type": "string",
"description": "The issue labels"
},
"due_date": {
"type": "string",
"description": "The due date"
}
},
"required": [
"repository",
"title"
]
},
"create_outlook_event_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_outlook_event"
]
},
"calendar": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"attendees": {
"type": "array",
"description": "Emails of attendees",
"items": {
"type": "string"
}
},
"time_zone": {
"type": "string",
"description": "A valid IANA time zone name.",
"nullable": true
},
"days_until_meeting": {
"type": "integer",
"description": "The days until meeting",
"minimum": 0,
"maximum": 31
},
"time_of_meeting": {
"type": "string",
"description": "Time of meeting in format HH:MM",
"example": "14:30"
},
"meeting_duration": {
"type": "string",
"description": "Meeting duration in format like '1 hour', '30 minutes'",
"example": "1 hour"
},
"summary": {
"type": "string",
"description": "The event summary"
},
"description": {
"type": "string",
"description": "The event description"
},
"exclude_weekends": {
"type": "boolean"
},
"enable_online_meeting": {
"type": "boolean",
"description": "Enable Microsoft Teams online meeting"
},
"post_to_incident_timeline": {
"type": "boolean"
},
"post_to_slack_channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
},
"required": [
"calendar",
"days_until_meeting",
"time_of_meeting",
"meeting_duration",
"summary",
"description"
]
},
"create_google_calendar_event_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_google_calendar_event"
]
},
"attendees": {
"type": "array",
"description": "Emails of attendees",
"items": {
"type": "string"
}
},
"time_zone": {
"type": "string",
"description": "A valid IANA time zone name.",
"nullable": true
},
"calendar_id": {
"type": "string",
"nullable": true,
"default": "primary"
},
"days_until_meeting": {
"type": "integer",
"description": "The days until meeting",
"minimum": 0,
"maximum": 31
},
"time_of_meeting": {
"type": "string",
"description": "Time of meeting in format HH:MM",
"example": "14:30"
},
"meeting_duration": {
"type": "string",
"description": "Meeting duration in format like '1 hour', '30 minutes'",
"example": "1 hour"
},
"send_updates": {
"type": "boolean",
"description": "Send an email to the attendees notifying them of the event"
},
"can_guests_modify_event": {
"type": "boolean"
},
"can_guests_see_other_guests": {
"type": "boolean"
},
"can_guests_invite_others": {
"type": "boolean"
},
"summary": {
"type": "string",
"description": "The event summary"
},
"description": {
"type": "string",
"description": "The event description"
},
"exclude_weekends": {
"type": "boolean"
},
"conference_solution_key": {
"type": "string",
"enum": [
"eventHangout",
"eventNamedHangout",
"hangoutsMeet",
"addOn"
],
"description": "Sets the video conference type attached to the meeting",
"nullable": true
},
"post_to_incident_timeline": {
"type": "boolean"
},
"post_to_slack_channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
},
"required": [
"days_until_meeting",
"time_of_meeting",
"meeting_duration",
"summary",
"description"
]
},
"update_google_docs_page_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"update_google_docs_page"
]
},
"file_id": {
"type": "string",
"description": "The Google Doc file ID"
},
"title": {
"type": "string",
"description": "The Google Doc title"
},
"content": {
"type": "string",
"description": "The Google Doc content"
},
"post_mortem_template_id": {
"type": "string",
"description": "Retrospective template to use when updating page, if desired"
},
"template_id": {
"type": "string",
"description": "The Google Doc file ID to use as a template."
}
},
"required": [
"file_id"
]
},
"update_coda_page_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"update_coda_page"
]
},
"doc_id": {
"type": "string",
"description": "The Coda doc id"
},
"page_id": {
"type": "string",
"description": "The Coda page id"
},
"title": {
"type": "string",
"description": "The Coda page title"
},
"subtitle": {
"type": "string",
"description": "The Coda page subtitle"
},
"content": {
"type": "string",
"description": "The Coda page content"
},
"template": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Combined doc_id/page_id in format 'doc_id/page_id'"
},
"name": {
"type": "string"
}
}
}
},
"required": [
"page_id"
]
},
"update_google_calendar_event_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_google_calendar_event"
]
},
"calendar_id": {
"type": "string",
"nullable": true,
"default": "primary"
},
"event_id": {
"type": "string",
"description": "The event ID"
},
"summary": {
"type": "string",
"description": "The event summary"
},
"description": {
"type": "string",
"description": "The event description"
},
"adjustment_days": {
"type": "integer",
"description": "Days to adjust meeting by",
"minimum": 0,
"maximum": 31
},
"time_of_meeting": {
"type": "string",
"description": "Time of meeting in format HH:MM"
},
"meeting_duration": {
"type": "string",
"description": "Meeting duration in format like '1 hour', '30 minutes'",
"example": "1 hour"
},
"send_updates": {
"type": "boolean",
"description": "Send an email to the attendees notifying them of the event"
},
"can_guests_modify_event": {
"type": "boolean"
},
"can_guests_see_other_guests": {
"type": "boolean"
},
"can_guests_invite_others": {
"type": "boolean"
},
"attendees": {
"type": "array",
"description": "Emails of attendees",
"items": {
"type": "string"
}
},
"replace_attendees": {
"type": "boolean"
},
"conference_solution_key": {
"type": "string",
"enum": [
"eventHangout",
"eventNamedHangout",
"hangoutsMeet",
"addOn"
],
"description": "Sets the video conference type attached to the meeting",
"nullable": true
},
"post_to_incident_timeline": {
"type": "boolean"
},
"post_to_slack_channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
},
"required": [
"event_id"
]
},
"create_sharepoint_page_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_sharepoint_page"
]
},
"post_mortem_template_id": {
"type": "string",
"description": "Retrospective template to use when creating page, if desired"
},
"mark_post_mortem_as_published": {
"type": "boolean",
"default": true
},
"title": {
"type": "string",
"description": "The page title"
},
"site": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"drive": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"parent_folder": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"content": {
"type": "string",
"description": "The page content"
},
"template_id": {
"type": "string",
"description": "The SharePoint file ID to use as a template"
}
},
"required": [
"title",
"site",
"drive"
]
},
"create_google_docs_page_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_google_docs_page"
]
},
"post_mortem_template_id": {
"type": "string",
"description": "Retrospective template to use when creating page, if desired"
},
"mark_post_mortem_as_published": {
"type": "boolean",
"default": true
},
"title": {
"type": "string",
"description": "The page title"
},
"drive": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"parent_folder": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"content": {
"type": "string",
"description": "The page content"
},
"template_id": {
"type": "string",
"description": "The Google Doc file ID to use as a template"
},
"permissions": {
"type": "string",
"description": "Page permissions JSON"
}
},
"required": [
"title"
]
},
"create_google_docs_permissions_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_google_docs_permissions"
]
},
"file_id": {
"type": "string",
"description": "The Google Doc file ID"
},
"permissions": {
"type": "string",
"description": "Page permissions JSON"
},
"send_notification_email": {
"type": "boolean"
},
"email_message": {
"type": "string",
"description": "Email message notification",
"nullable": true
}
},
"required": [
"file_id",
"permissions"
]
},
"remove_google_docs_permissions_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"remove_google_docs_permissions"
]
},
"file_id": {
"type": "string",
"description": "The Google Doc file ID"
},
"attribute_to_query_by": {
"type": "string",
"enum": [
"type",
"role",
"email_address"
],
"default": "email_address"
},
"value": {
"type": "string"
}
},
"required": [
"file_id",
"attribute_to_query_by",
"value"
]
},
"create_quip_page_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_google_docs_page"
]
},
"post_mortem_template_id": {
"type": "string",
"description": "Retrospective template to use when creating page, if desired"
},
"title": {
"type": "string",
"description": "The page title"
},
"parent_folder_id": {
"type": "string",
"description": "The parent folder id"
},
"content": {
"type": "string",
"description": "The page content"
},
"template_id": {
"type": "string",
"description": "The Quip file ID to use as a template"
},
"mark_post_mortem_as_published": {
"type": "boolean",
"default": true
}
},
"required": [
"title"
]
},
"create_google_meeting_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_google_meeting"
]
},
"summary": {
"type": "string",
"description": "[DEPRECATED] The meeting summary",
"nullable": true
},
"description": {
"type": "string",
"description": "[DEPRECATED] The meeting description",
"nullable": true
},
"conference_solution_key": {
"type": "string",
"enum": [
"eventHangout",
"eventNamedHangout",
"hangoutsMeet",
"addOn"
],
"description": "[DEPRECATED] Sets the video conference type attached to the meeting",
"nullable": true
},
"record_meeting": {
"type": "boolean",
"description": "Rootly AI will record the meeting and automatically generate a transcript and summary from your meeting"
},
"recording_mode": {
"type": "string",
"enum": [
"speaker_view",
"gallery_view",
"gallery_view_v2",
"audio_only"
],
"description": "The video layout for the bot's recording (e.g. speaker_view, gallery_view, gallery_view_v2, audio_only)",
"nullable": true
},
"post_to_incident_timeline": {
"type": "boolean"
},
"post_to_slack_channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
},
"required": [
"summary",
"description"
]
},
"create_go_to_meeting_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_go_to_meeting_task"
]
},
"subject": {
"type": "string",
"description": "The meeting subject"
},
"conference_call_info": {
"type": "string",
"enum": [
"ptsn",
"free",
"hyrid",
"voip"
],
"default": "voip",
"example": "voip",
"nullable": true
},
"password_required": {
"type": "boolean",
"nullable": true
},
"post_to_incident_timeline": {
"type": "boolean"
},
"post_to_slack_channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
},
"required": [
"subject"
]
},
"create_incident_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_incident"
]
},
"title": {
"type": "string",
"description": "The incident title"
},
"summary": {
"type": "string",
"description": "The incident summary"
},
"severity_id": {
"type": "string"
},
"incident_type_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"service_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of service UUIDs"
},
"functionality_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of functionality UUIDs"
},
"environment_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"group_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of group/team UUIDs"
},
"private": {
"type": "boolean"
},
"custom_fields_mapping": {
"type": "string",
"description": "Custom field mappings. Can contain liquid markup and need to be valid JSON. Use 'services', 'functionalities', or 'groups' keys with arrays of names/slugs for name/slug lookup",
"nullable": true
}
},
"required": [
"title"
]
},
"create_sub_incident_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_sub_incident"
]
},
"title": {
"type": "string",
"description": "The sub incident title"
},
"summary": {
"type": "string",
"description": "The sub incident summary"
}
},
"required": [
"title"
]
},
"create_incident_postmortem_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_incident_postmortem"
]
},
"incident_id": {
"type": "string",
"description": "UUID of the incident that needs a retrospective"
},
"title": {
"type": "string",
"description": "The retrospective title"
},
"status": {
"type": "string",
"nullable": true
},
"template": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "Retrospective template to use",
"nullable": true
}
},
"required": [
"incident_id",
"title"
]
},
"create_jira_issue_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_jira_issue"
]
},
"integration": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "Specify integration id if you have more than one Jira instance"
},
"title": {
"type": "string",
"description": "The issue title"
},
"description": {
"type": "string",
"description": "The issue description"
},
"labels": {
"type": "string",
"description": "The issue labels"
},
"assign_user_email": {
"type": "string",
"description": "The assigned user's email"
},
"reporter_user_email": {
"type": "string",
"description": "The reporter user's email"
},
"project_key": {
"type": "string",
"description": "The project key"
},
"due_date": {
"type": "string",
"description": "The due date"
},
"issue_type": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The issue type id and display name"
},
"priority": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The priority id and display name"
},
"status": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The status id and display name"
},
"custom_fields_mapping": {
"type": "string",
"description": "Custom field mappings. Can contain liquid markup and need to be valid JSON",
"nullable": true
},
"update_payload": {
"type": "string",
"description": "Update payload. Can contain liquid markup and need to be valid JSON",
"nullable": true
}
},
"required": [
"project_key",
"title",
"issue_type"
]
},
"create_jira_subtask_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_jira_subtask"
]
},
"integration": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "Specify integration id if you have more than one Jira instance"
},
"project_key": {
"type": "string",
"description": "The project key"
},
"parent_issue_id": {
"type": "string",
"description": "The parent issue"
},
"title": {
"type": "string",
"description": "The issue title"
},
"description": {
"type": "string",
"description": "The issue description"
},
"subtask_issue_type": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The issue type id and display name"
},
"labels": {
"type": "string",
"description": "The issue labels"
},
"due_date": {
"type": "string",
"description": "The due date"
},
"assign_user_email": {
"type": "string",
"description": "The assigned user's email"
},
"reporter_user_email": {
"type": "string",
"description": "The reporter user's email"
},
"priority": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The priority id and display name"
},
"status": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The status id and display name"
},
"custom_fields_mapping": {
"type": "string",
"description": "Custom field mappings. Can contain liquid markup and need to be valid JSON",
"nullable": true
},
"update_payload": {
"type": "string",
"description": "Update payload. Can contain liquid markup and need to be valid JSON",
"nullable": true
}
},
"required": [
"project_key",
"parent_issue_id",
"title",
"subtask_issue_type"
]
},
"create_linear_issue_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_linear_issue"
]
},
"title": {
"type": "string",
"description": "The issue title"
},
"description": {
"type": "string",
"description": "The issue description"
},
"team": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The team id and display name"
},
"state": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The state id and display name"
},
"project": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The project id and display name"
},
"labels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"priority": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The priority id and display name"
},
"assign_user_email": {
"type": "string",
"description": "The assigned user's email"
},
"custom_fields_mapping": {
"type": "string",
"description": "Custom field mappings. Can contain liquid markup and need to be valid JSON",
"nullable": true
}
},
"required": [
"title",
"team",
"state"
]
},
"create_linear_subtask_issue_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_linear_subtask_issue"
]
},
"parent_issue_id": {
"type": "string",
"description": "The parent issue"
},
"title": {
"type": "string",
"description": "The issue title"
},
"description": {
"type": "string",
"description": "The issue description"
},
"state": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The state id and display name"
},
"priority": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The priority id and display name"
},
"labels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"assign_user_email": {
"type": "string",
"description": "The assigned user's email"
},
"custom_fields_mapping": {
"type": "string",
"description": "Custom field mappings. Can contain liquid markup and need to be valid JSON",
"nullable": true
}
},
"required": [
"parent_issue_id",
"title",
"state"
]
},
"create_linear_issue_comment_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_linear_issue_comment"
]
},
"issue_id": {
"type": "string",
"description": "The issue id"
},
"body": {
"type": "string",
"description": "The issue description"
}
},
"required": [
"issue_id",
"body"
]
},
"create_microsoft_teams_meeting_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_microsoft_teams_meeting"
]
},
"name": {
"type": "string",
"description": "The meeting name"
},
"subject": {
"type": "string",
"description": "The meeting subject"
},
"record_meeting": {
"type": "boolean",
"description": "Rootly AI will record the meeting and automatically generate a transcript and summary from your meeting"
},
"recording_mode": {
"type": "string",
"enum": [
"speaker_view",
"gallery_view",
"gallery_view_v2",
"audio_only"
],
"description": "The video layout for the bot's recording (e.g. speaker_view, gallery_view, gallery_view_v2, audio_only)",
"nullable": true
},
"post_to_incident_timeline": {
"type": "boolean"
},
"post_to_slack_channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
},
"required": [
"name",
"subject"
]
},
"create_microsoft_teams_channel_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_microsoft_teams_channel"
]
},
"team": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"title": {
"type": "string",
"description": "Microsoft Team channel title"
},
"description": {
"type": "string",
"description": "Microsoft Team channel description"
},
"private": {
"type": "string",
"enum": [
"auto",
"true",
"false"
],
"default": "auto"
}
},
"required": [
"team",
"title"
]
},
"create_microsoft_teams_chat_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_microsoft_teams_chat"
]
},
"topic": {
"type": "string",
"description": "Chat topic (only for group chats)",
"nullable": true
},
"chat_type": {
"type": "string",
"enum": [
"group",
"oneOnOne"
],
"default": "group",
"description": "Type of chat to create"
},
"members": {
"type": "array",
"items": {
"type": "object",
"properties": {
"email": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"description": "Array of members to include in the chat"
}
},
"required": [
"members"
]
},
"add_microsoft_teams_tab_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"add_microsoft_teams_tab"
]
},
"playbook_id": {
"type": "string",
"description": "The playbook id if tab is of an incident playbook"
},
"team": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"channel": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"title": {
"type": "string",
"description": "The tab title. Required if not a playbook tab",
"nullable": true
},
"link": {
"type": "string",
"description": "The tab link. Required if not a playbook tab",
"nullable": true
}
},
"required": [
"team",
"channel"
],
"anyOf": [
{
"required": [
"title",
"link"
],
"properties": {
"title": {
"type": "string"
},
"link": {
"type": "string"
}
}
},
{
"required": [
"playbook_id"
],
"properties": {
"playbook_id": {
"type": "string"
}
}
}
]
},
"add_microsoft_teams_chat_tab_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"add_microsoft_teams_chat_tab"
]
},
"chat": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"title": {
"type": "string",
"description": "The tab title"
},
"link": {
"type": "string",
"description": "The tab link"
}
},
"required": [
"chat",
"title",
"link"
]
},
"create_google_chat_space_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_google_chat_space"
]
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"audience": {
"type": "string",
"description": "Target audience resource name (e.g. audiences/default). Leave blank for private space."
}
},
"required": [
"title"
]
},
"send_google_chat_message_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"send_google_chat_message"
]
},
"spaces": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"text": {
"type": "string"
},
"thread_key": {
"type": "string",
"description": "Thread key to reply within a thread. Messages with the same thread key are grouped together",
"nullable": true
}
},
"required": [
"spaces",
"text"
]
},
"send_google_chat_attachments_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"send_google_chat_attachments"
]
},
"spaces": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"attachments": {
"type": "string"
}
},
"required": [
"spaces",
"attachments"
]
},
"invite_to_google_chat_space_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"invite_to_google_chat_space"
]
},
"space": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"emails": {
"type": "string",
"description": "Comma separated list of emails to invite"
}
},
"required": [
"space",
"emails"
]
},
"archive_google_chat_spaces_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"archive_google_chat_spaces"
]
},
"spaces": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
},
"required": [
"spaces"
]
},
"rename_google_chat_space_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"rename_google_chat_space"
]
},
"space": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"title": {
"type": "string"
}
},
"required": [
"space",
"title"
]
},
"update_google_chat_space_description_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"update_google_chat_space_description"
]
},
"space": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"description": {
"type": "string",
"description": "The space description. Supports liquid markup"
}
},
"required": [
"space",
"description"
]
},
"change_google_chat_space_privacy_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"change_google_chat_space_privacy"
]
},
"space": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"audience": {
"type": "string",
"description": "Target audience resource name (e.g. audiences/default). Leave blank to make private.",
"nullable": true
}
},
"required": [
"space"
]
},
"archive_microsoft_teams_channels_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"archive_microsoft_teams_channels"
]
},
"team": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
},
"required": [
"team",
"channels"
]
},
"rename_microsoft_teams_channel_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"rename_microsoft_teams_channel"
]
},
"team": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"channel": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"title": {
"type": "string"
}
},
"required": [
"title",
"team",
"channel"
]
},
"invite_to_microsoft_teams_channel_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"invite_to_microsoft_teams_channel"
]
},
"team": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"channel": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"emails": {
"type": "string",
"description": "Comma separated list of emails to invite"
}
},
"required": [
"channel",
"emails"
]
},
"create_notion_page_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_notion_page"
]
},
"title": {
"type": "string",
"description": "The Notion page title"
},
"parent_page": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The parent page id and display name"
},
"post_mortem_template_id": {
"type": "string",
"description": "Retrospective template to use when creating page task, if desired"
},
"content": {
"type": "string",
"description": "Custom page content with liquid templating support. When provided, only this content will be rendered (no default sections)"
},
"mark_post_mortem_as_published": {
"type": "boolean",
"default": true
},
"show_timeline_as_table": {
"type": "boolean"
},
"show_action_items_as_table": {
"type": "boolean"
}
},
"required": [
"parent_page",
"title"
]
},
"send_microsoft_teams_message_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"send_microsoft_teams_message"
]
},
"channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"text": {
"type": "string",
"description": "The message text"
}
},
"required": [
"text"
],
"anyOf": [
{
"required": [
"channels"
],
"properties": {
"channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
}
}
]
},
"send_microsoft_teams_chat_message_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"send_microsoft_teams_chat_message"
]
},
"chats": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"text": {
"type": "string",
"description": "The message text"
}
},
"required": [
"text",
"chats"
]
},
"send_microsoft_teams_blocks_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"send_microsoft_teams_blocks"
]
},
"channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"attachments": {
"type": "string",
"description": "Support liquid markup. Needs to be a valid JSON string after liquid is parsed"
}
},
"required": [
"attachments"
],
"anyOf": [
{
"required": [
"channels"
],
"properties": {
"channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
}
}
]
},
"update_notion_page_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"update_notion_page"
]
},
"file_id": {
"type": "string",
"description": "The Notion page ID"
},
"title": {
"type": "string",
"description": "The Notion page title"
},
"post_mortem_template_id": {
"type": "string",
"description": "Retrospective template to use when creating page task, if desired"
},
"content": {
"type": "string",
"description": "Custom page content with liquid templating support. When provided, only this content will be rendered (no default sections)"
},
"show_timeline_as_table": {
"type": "boolean"
},
"show_action_items_as_table": {
"type": "boolean"
}
},
"required": [
"file_id"
]
},
"update_quip_page_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"update_quip_page"
]
},
"file_id": {
"type": "string",
"description": "The Quip page ID"
},
"title": {
"type": "string",
"description": "The Quip page title"
},
"content": {
"type": "string",
"description": "The Quip page content"
},
"post_mortem_template_id": {
"type": "string",
"description": "Retrospective template to use when updating page, if desired"
},
"template_id": {
"type": "string",
"description": "The Quip file ID to use as a template"
}
},
"required": [
"file_id"
]
},
"update_confluence_page_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"update_confluence_page"
]
},
"integration": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "Specify integration id if you have more than one Confluence instance"
},
"file_id": {
"type": "string",
"description": "The Confluence page ID"
},
"title": {
"type": "string",
"description": "The Confluence page title"
},
"content": {
"type": "string",
"description": "The Confluence page content"
},
"post_mortem_template_id": {
"type": "string",
"description": "Retrospective template to use when updating page, if desired"
},
"template": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The Confluence template to use"
},
"include_overview": {
"type": "boolean",
"default": true
},
"include_timeline": {
"type": "boolean",
"default": true
}
},
"required": [
"file_id"
]
},
"update_sharepoint_page_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"update_sharepoint_page"
]
},
"file_id": {
"type": "string",
"description": "The SharePoint file ID"
},
"title": {
"type": "string",
"description": "The SharePoint document title"
},
"content": {
"type": "string",
"description": "The SharePoint document content"
},
"post_mortem_template_id": {
"type": "string",
"description": "Retrospective template to use when updating document, if desired"
}
},
"required": [
"file_id"
]
},
"update_dropbox_paper_page_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"update_dropbox_paper_page"
]
},
"file_id": {
"type": "string",
"description": "The Dropbox Paper document ID"
},
"title": {
"type": "string",
"description": "The Dropbox Paper document title"
},
"content": {
"type": "string",
"description": "The Dropbox Paper document content"
},
"post_mortem_template_id": {
"type": "string",
"description": "Retrospective template to use when updating document, if desired"
}
},
"required": [
"file_id"
]
},
"update_datadog_notebook_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"update_datadog_notebook"
]
},
"file_id": {
"type": "string",
"description": "The Datadog notebook ID"
},
"title": {
"type": "string",
"description": "The Datadog notebook title"
},
"content": {
"type": "string",
"description": "The Datadog notebook content"
},
"kind": {
"type": "string",
"description": "The notebook type",
"enum": [
"postmortem",
"runbook",
"investigation",
"documentation",
"report"
]
},
"post_mortem_template_id": {
"type": "string",
"description": "Retrospective template to use when updating notebook, if desired"
},
"template": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The Datadog notebook template to use"
}
},
"required": [
"file_id"
]
},
"create_service_now_incident_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_service_now_incident"
]
},
"title": {
"type": "string",
"description": "The incident title"
},
"description": {
"type": "string",
"description": "The incident description"
},
"priority": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The priority id and display name"
},
"completion": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The completion id and display name"
},
"custom_fields_mapping": {
"type": "string",
"description": "Custom field mappings. Can contain liquid markup and need to be valid JSON",
"nullable": true
}
},
"required": [
"title"
]
},
"create_shortcut_story_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_shortcut_story"
]
},
"title": {
"type": "string",
"description": "The incident title"
},
"kind": {
"type": "string",
"enum": [
"bug",
"chore",
"feature"
]
},
"description": {
"type": "string",
"description": "The incident description"
},
"labels": {
"type": "string",
"description": "The story labels"
},
"due_date": {
"type": "string",
"description": "The due date"
},
"archivation": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The archivation id and display name"
},
"group": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The group id and display name"
},
"project": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The project id and display name"
},
"workflow_state": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The workflow state id workflow state name"
}
},
"required": [
"title",
"archivation",
"kind"
],
"anyOf": [
{
"required": [
"project"
],
"properties": {
"project": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
},
{
"required": [
"workflow_state"
],
"properties": {
"workflow_state": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
}
]
},
"create_shortcut_task_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_shortcut_task"
]
},
"parent_story_id": {
"type": "string",
"description": "The parent story"
},
"description": {
"type": "string",
"description": "The task description"
},
"completion": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The completion id and display name"
}
},
"required": [
"parent_story_id",
"description",
"completion"
]
},
"create_trello_card_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_trello_card"
]
},
"title": {
"type": "string",
"description": "The card title"
},
"description": {
"type": "string",
"description": "The card description"
},
"due_date": {
"type": "string",
"description": "The due date"
},
"board": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The board id and display name"
},
"list": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The list id and display name"
},
"labels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"archivation": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The archivation id and display name"
}
},
"required": [
"title",
"board",
"list"
]
},
"create_webex_meeting_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_webex_meeting"
]
},
"topic": {
"type": "string",
"description": "The meeting topic"
},
"password": {
"type": "string",
"description": "The meeting password"
},
"record_meeting": {
"type": "boolean",
"description": "Rootly AI will record the meeting and automatically generate a transcript and summary from your meeting"
},
"recording_mode": {
"type": "string",
"enum": [
"speaker_view",
"gallery_view",
"gallery_view_v2",
"audio_only"
],
"description": "The video layout for the bot's recording (e.g. speaker_view, gallery_view, gallery_view_v2, audio_only)",
"nullable": true
},
"post_to_incident_timeline": {
"type": "boolean"
},
"post_to_slack_channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
},
"required": [
"topic"
]
},
"create_zendesk_ticket_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_zendesk_ticket"
]
},
"kind": {
"type": "string",
"enum": [
"problem",
"incident",
"question",
"task"
]
},
"subject": {
"type": "string",
"description": "The ticket subject"
},
"comment": {
"type": "string",
"description": "The ticket comment"
},
"tags": {
"type": "string",
"description": "The ticket tags"
},
"priority": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The priority id and display name"
},
"completion": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The completion id and display name"
},
"custom_fields_mapping": {
"type": "string",
"description": "Custom field mappings. Can contain liquid markup and need to be valid JSON",
"nullable": true
},
"ticket_payload": {
"type": "string",
"description": "Additional Zendesk ticket attributes. Will be merged into whatever was specified in this tasks current parameters. Can contain liquid markup and need to be valid JSON",
"nullable": true
}
},
"required": [
"kind",
"subject"
]
},
"create_zendesk_jira_link_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_zendesk_jira_link"
]
},
"jira_issue_id": {
"type": "string",
"description": "Jira Issue Id."
},
"jira_issue_key": {
"type": "string",
"description": "Jira Issue Key."
},
"zendesk_ticket_id": {
"type": "string",
"description": "Zendesk Ticket Id."
}
},
"required": [
"jira_issue_id",
"jira_issue_key",
"zendesk_ticket_id"
]
},
"create_clickup_task_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_clickup_task"
]
},
"title": {
"type": "string",
"description": "The task title"
},
"description": {
"type": "string",
"description": "The task description"
},
"tags": {
"type": "string",
"description": "The task tags"
},
"priority": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The priority id and display name"
},
"due_date": {
"type": "string",
"description": "The due date"
},
"custom_fields_mapping": {
"type": "string",
"description": "Custom field mappings. Can contain liquid markup and need to be valid JSON",
"nullable": true
},
"task_payload": {
"type": "string",
"description": "Additional ClickUp task attributes. Will be merged into whatever was specified in this tasks current parameters. Can contain liquid markup and need to be valid JSON",
"nullable": true
}
},
"required": [
"title"
]
},
"create_motion_task_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_motion_task"
]
},
"workspace": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"project": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"status": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"title": {
"type": "string",
"description": "The task title"
},
"description": {
"type": "string",
"description": "The task description"
},
"labels": {
"type": "array",
"items": {
"type": "string"
}
},
"priority": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The priority id and display name"
},
"duration": {
"type": "string",
"description": "The duration. Eg. \"NONE\", \"REMINDER\", or a integer greater than 0."
},
"due_date": {
"type": "string",
"description": "The due date"
}
},
"required": [
"workspace",
"title"
]
},
"create_zoom_meeting_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_zoom_meeting"
]
},
"topic": {
"type": "string",
"description": "The meeting topic"
},
"password": {
"type": "string",
"description": "The meeting password"
},
"create_as_email": {
"type": "string",
"description": "The email to use if creating as email"
},
"alternative_hosts": {
"type": "array",
"items": {
"type": "string",
"description": "Alternative host email"
}
},
"auto_recording": {
"type": "string",
"enum": [
"none",
"local",
"cloud"
],
"default": "none"
},
"record_meeting": {
"type": "boolean",
"description": "Rootly AI will record the meeting and automatically generate a transcript and summary from your meeting"
},
"recording_mode": {
"type": "string",
"enum": [
"speaker_view",
"gallery_view",
"gallery_view_v2",
"audio_only"
],
"description": "The video layout for the bot's recording (e.g. speaker_view, gallery_view, gallery_view_v2, audio_only)",
"nullable": true
},
"enable_zoom_bot_auto_join": {
"type": "boolean",
"description": "Allow the Rootly bot to start recording without waiting for host approval"
},
"post_to_incident_timeline": {
"type": "boolean"
},
"post_to_slack_channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
},
"required": [
"topic"
]
},
"get_github_commits_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"get_github_commits"
]
},
"service_ids": {
"type": "array",
"items": {
"type": "string",
"description": "ID of service impacted by incident"
}
},
"github_repository_names": {
"type": "array",
"items": {
"type": "string"
}
},
"branch": {
"type": "string",
"description": "The branch"
},
"past_duration": {
"type": "string",
"description": "How far back to fetch commits (in format '1 minute', '30 days', '3 months', etc.)",
"example": "1 hour"
},
"services_impacted_by_incident": {
"type": "boolean"
},
"post_to_incident_timeline": {
"type": "boolean"
},
"post_to_slack_channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
},
"required": [
"branch",
"past_duration"
],
"anyOf": [
{
"required": [
"service_ids"
],
"properties": {
"service_ids": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
{
"required": [
"github_repository_names"
],
"properties": {
"github_repository_names": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
]
},
"get_gitlab_commits_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"get_gitlab_commits"
]
},
"service_ids": {
"type": "array",
"items": {
"type": "string",
"description": "ID of service impacted by incident"
}
},
"gitlab_repository_names": {
"type": "array",
"items": {
"type": "string"
}
},
"branch": {
"type": "string",
"description": "The branch"
},
"past_duration": {
"type": "string",
"description": "How far back to fetch commits (in format '1 minute', '30 days', '3 months', etc.)",
"example": "1 hour"
},
"services_impacted_by_incident": {
"type": "boolean"
},
"post_to_incident_timeline": {
"type": "boolean"
},
"post_to_slack_channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
},
"required": [
"branch",
"past_duration"
],
"anyOf": [
{
"required": [
"service_ids"
],
"properties": {
"service_ids": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
{
"required": [
"gitlab_repository_names"
],
"properties": {
"gitlab_repository_names": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
]
},
"get_pulses_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"get_pulses"
]
},
"service_ids": {
"type": "array",
"items": {
"type": "string",
"description": "ID of service impacted by incident"
}
},
"environment_ids": {
"type": "array",
"items": {
"type": "string",
"description": "ID of environment impacted by incident"
}
},
"labels": {
"type": "array",
"items": {
"type": "string"
}
},
"refs": {
"type": "array",
"items": {
"type": "string"
}
},
"sources": {
"type": "array",
"items": {
"type": "string"
}
},
"past_duration": {
"type": "string",
"description": "How far back to fetch commits (in format '1 minute', '30 days', '3 months', etc.)",
"example": "1 hour"
},
"services_impacted_by_incident": {
"type": "boolean"
},
"environments_impacted_by_incident": {
"type": "boolean"
},
"post_to_incident_timeline": {
"type": "boolean"
},
"post_to_slack_channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"parent_message_thread_task": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "A hash where [id] is the task id of the parent task that sent a message, and [name] is the name of the parent task"
}
},
"required": [
"past_duration"
]
},
"get_alerts_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"get_alerts"
]
},
"service_ids": {
"type": "array",
"items": {
"type": "string",
"description": "ID of service impacted by incident"
}
},
"environment_ids": {
"type": "array",
"items": {
"type": "string",
"description": "ID of environment impacted by incident"
}
},
"labels": {
"type": "array",
"items": {
"type": "string"
}
},
"sources": {
"type": "array",
"items": {
"type": "string"
}
},
"past_duration": {
"type": "string",
"description": "How far back to fetch commits (in format '1 minute', '30 days', '3 months', etc.)",
"example": "1 hour"
},
"services_impacted_by_incident": {
"type": "boolean"
},
"environments_impacted_by_incident": {
"type": "boolean"
},
"post_to_incident_timeline": {
"type": "boolean"
},
"post_to_slack_channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"parent_message_thread_task": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "A hash where [id] is the task id of the parent task that sent a message, and [name] is the name of the parent task"
}
},
"required": [
"past_duration"
]
},
"http_client_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"http_client"
]
},
"headers": {
"type": "string",
"description": "JSON map of HTTP headers"
},
"params": {
"type": "string",
"description": "JSON map of HTTP query parameters"
},
"body": {
"type": "string",
"description": "HTTP body"
},
"url": {
"type": "string",
"description": "URL endpoint",
"example": "https://example.com/foo.json"
},
"event_url": {
"type": "string"
},
"event_message": {
"type": "string"
},
"method": {
"type": "string",
"description": "HTTP method",
"enum": [
"GET",
"POST",
"PATCH",
"PUT",
"DELETE",
"OPTIONS"
],
"default": "GET"
},
"succeed_on_status": {
"type": "string",
"description": "HTTP status code expected. Can be a regular expression. Eg: 200, 200|203, 20[0-3]",
"example": 200
},
"post_to_incident_timeline": {
"type": "boolean"
},
"post_to_slack_channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"retry_count": {
"type": "integer",
"description": "Number of times to retry on HTTP 429 responses (0-4). 0 disables retry.",
"default": 0,
"example": 3
},
"retry_wait_time": {
"type": "integer",
"description": "Seconds to wait before each retry (1-15). Retry-After header is honored when present and <= 90s, taking the larger of retry_wait_time and the header value.",
"default": 1,
"example": 2
}
},
"required": [
"url",
"succeed_on_status"
]
},
"invite_to_slack_channel_opsgenie_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"invite_to_slack_channel_opsgenie"
]
},
"channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"schedule": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"required": [
"schedule",
"channels"
]
},
"invite_to_slack_channel_rootly_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"invite_to_slack_channel_rootly"
]
},
"channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"escalation_policy_target": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"service_target": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"user_target": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"group_target": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"schedule_target": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"required": [
"channels"
]
},
"invite_to_microsoft_teams_channel_rootly_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"invite_to_microsoft_teams_channel_rootly"
]
},
"team": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"channel": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"escalation_policy_target": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"service_target": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"user_target": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"group_target": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"schedule_target": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"required": [
"team",
"channel"
]
},
"invite_to_slack_channel_pagerduty_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"invite_to_slack_channel_pagerduty"
]
},
"channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"escalation_policy": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"schedule": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"service": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"required": [
"channels"
],
"anyOf": [
{
"required": [
"escalation_policy"
],
"properties": {
"escalation_policy": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
},
{
"required": [
"schedule"
],
"properties": {
"schedule": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
}
]
},
"invite_to_slack_channel_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"invite_to_slack_channel"
]
},
"channel": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"slack_users": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"slack_user_groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"slack_emails": {
"type": "string",
"description": "Comma separated list of emails to invite to the channel"
}
},
"required": [
"channel"
],
"anyOf": [
{
"required": [
"slack_users"
],
"properties": {
"slack_users": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
}
},
{
"required": [
"slack_user_groups"
],
"properties": {
"slack_user_groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
}
},
{
"required": [
"slack_emails"
],
"properties": {
"slack_emails": {
"type": "string"
}
}
}
]
},
"invite_to_slack_channel_victor_ops_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"invite_to_slack_channel_victor_ops"
]
},
"channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"team": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"required": [
"team",
"channels"
]
},
"page_opsgenie_on_call_responders_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"page_opsgenie_on_call_responders"
]
},
"title": {
"type": "string",
"description": "Incident title.",
"nullable": true
},
"message": {
"type": "string",
"description": "Message of the incident"
},
"description": {
"type": "string",
"description": "Description field of the incident that is generally used to provide a detailed information about the incident"
},
"teams": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"users": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"priority": {
"type": "string",
"enum": [
"P1",
"P2",
"P3",
"P4",
"P5",
"auto"
],
"default": "P1"
}
}
},
"create_opsgenie_alert_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_opsgenie_alert"
]
},
"message": {
"type": "string",
"description": "Message of the alert"
},
"description": {
"type": "string",
"description": "Description field of the alert that is generally used to provide a detailed information about the alert"
},
"teams": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"users": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"schedules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"escalations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"priority": {
"type": "string",
"enum": [
"P1",
"P2",
"P3",
"P4",
"P5",
"auto"
],
"default": "P1"
},
"details": {
"type": "string",
"description": "Details payload. Can contain liquid markup and need to be valid JSON",
"nullable": true
}
},
"required": [
"message"
]
},
"create_jsmops_alert_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_jsmops_alert"
]
},
"message": {
"type": "string",
"description": "Message of the alert"
},
"description": {
"type": "string",
"description": "Description field of the alert that is generally used to provide a detailed information about the alert",
"nullable": true
},
"teams": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"users": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"schedules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"escalations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"priority": {
"type": "string",
"enum": [
"P3",
"P1",
"P2",
"P4",
"P5",
"auto"
],
"default": "P3"
},
"details": {
"type": "string",
"description": "Details payload. Can contain liquid markup and need to be valid JSON",
"nullable": true
}
},
"required": [
"message"
]
},
"page_jsmops_on_call_responders_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"page_jsmops_on_call_responders"
]
},
"title": {
"type": "string",
"description": "Incident title.",
"nullable": true
},
"message": {
"type": "string",
"description": "Message of the incident"
},
"description": {
"type": "string",
"description": "Description field of the incident that is generally used to provide a detailed information about the incident"
},
"teams": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"users": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"priority": {
"type": "string",
"enum": [
"P3",
"P1",
"P2",
"P4",
"P5",
"auto"
],
"default": "P3"
}
}
},
"update_opsgenie_alert_task_params": {
"type": "object",
"properties": {
"alert_id": {
"type": "string",
"description": "Opsgenie Alert ID"
},
"task_type": {
"type": "string",
"enum": [
"update_opsgenie_alert"
]
},
"message": {
"type": "string",
"description": "Message of the alert"
},
"description": {
"type": "string",
"description": "Description field of the alert that is generally used to provide a detailed information about the alert"
},
"priority": {
"type": "string",
"enum": [
"P1",
"P2",
"P3",
"P4",
"P5",
"auto"
]
},
"completion": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"required": [
"alert_id",
"priority",
"completion"
]
},
"update_opsgenie_incident_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"update_opsgenie_incident"
]
},
"opsgenie_incident_id": {
"type": "string",
"description": "The Opsgenie incident ID, this can also be a Rootly incident variable ex. {{ incident.opsgenie_incident_id }}"
},
"message": {
"type": "string",
"description": "Message of the alert"
},
"description": {
"type": "string",
"description": "Description field of the alert that is generally used to provide a detailed information about the alert"
},
"status": {
"type": "string",
"enum": [
"resolve",
"open",
"close",
"auto"
]
},
"priority": {
"type": "string",
"enum": [
"P1",
"P2",
"P3",
"P4",
"P5",
"auto",
""
],
"nullable": true
}
},
"required": [
"opsgenie_incident_id"
]
},
"page_rootly_on_call_responders_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"page_rootly_on_call_responders"
]
},
"escalation_policy_target": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"service_target": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"user_target": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"group_target": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"functionality_target": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"alert_urgency_id": {
"type": "string",
"description": "Alert urgency ID"
},
"summary": {
"type": "string",
"description": "Alert title"
},
"description": {
"type": "string",
"description": "Alert description"
},
"escalation_note": {
"type": "string"
}
},
"required": [
"summary",
"alert_urgency_id"
]
},
"page_pagerduty_on_call_responders_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"page_pagerduty_on_call_responders"
]
},
"service": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"escalation_policies": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"users": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"title": {
"type": "string",
"description": "Incident title.",
"nullable": true
},
"message": {
"type": "string"
},
"urgency": {
"type": "string",
"enum": [
"high",
"low",
"auto"
],
"default": "high"
},
"priority": {
"type": "string",
"description": "PagerDuty incident priority, selecting auto will let Rootly auto map our incident severity"
},
"create_new_incident_on_conflict": {
"type": "boolean",
"description": "Rootly only supports linking to a single PagerDuty incident. If this feature is disabled Rootly will add responders from any additional pages to the existing PagerDuty incident that is linked to the Rootly incident. If enabled, Rootly will create a new PagerDuty incident that is not linked to any Rootly incidents",
"default": false
}
},
"required": [
"service"
]
},
"page_victor_ops_on_call_responders_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"page_victor_ops_on_call_responders"
]
},
"escalation_policies": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"users": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"title": {
"type": "string",
"description": "Alert title.",
"nullable": true
}
},
"anyOf": [
{
"required": [
"users"
],
"properties": {
"users": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
}
},
{
"required": [
"escalation_policies"
],
"properties": {
"escalation_policies": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
}
}
]
},
"update_victor_ops_incident_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"update_victor_ops_incident"
]
},
"victor_ops_incident_id": {
"type": "string",
"description": "The victor_ops incident ID, this can also be a Rootly incident variable ex. {{ incident.victor_ops_incident_id }}"
},
"status": {
"type": "string",
"enum": [
"resolve",
"ack",
"auto"
]
},
"resolution_message": {
"type": "string",
"description": "Resolution message"
}
},
"required": [
"victor_ops_incident_id",
"status"
]
},
"print_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"print"
]
},
"message": {
"type": "string",
"description": "The message to print"
}
},
"required": [
"message"
]
},
"publish_incident_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"publish_incident"
]
},
"incident": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"public_title": {
"type": "string"
},
"event": {
"type": "string",
"description": "Incident event description"
},
"status": {
"type": "string",
"enum": [
"investigating",
"identified",
"monitoring",
"resolved",
"scheduled",
"in_progress",
"completed"
],
"default": "resolved"
},
"notify_subscribers": {
"type": "boolean",
"description": "When true notifies subscribers of the status page by email/text",
"default": false
},
"should_tweet": {
"type": "boolean",
"description": "For Statuspage.io integrated pages auto publishes a tweet for your update",
"default": false
},
"status_page_template": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"status_page_id": {
"type": "string"
},
"integration_payload": {
"type": "string",
"description": "Additional API Payload you can pass to statuspage.io for example. Can contain liquid markup and need to be valid JSON",
"nullable": true
}
},
"required": [
"incident",
"public_title",
"status",
"status_page_id"
]
},
"redis_client_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"redis_client"
]
},
"url": {
"type": "string",
"example": "redis://redis-12345.c1.us-east-1-2.ec2.cloud.redislabs.com:12345"
},
"commands": {
"type": "string"
},
"event_url": {
"type": "string"
},
"event_message": {
"type": "string"
},
"post_to_incident_timeline": {
"type": "boolean"
},
"post_to_slack_channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
},
"required": [
"url",
"commands"
]
},
"rename_slack_channel_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"rename_slack_channel"
]
},
"channel": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"title": {
"type": "string"
}
},
"required": [
"title",
"channel"
]
},
"change_slack_channel_privacy_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"change_slack_channel_privacy"
]
},
"channel": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"privacy": {
"type": "string",
"enum": [
"private",
"public"
]
}
},
"required": [
"channel",
"privacy"
]
},
"run_command_heroku_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"run_command_heroku"
]
},
"command": {
"type": "string"
},
"app_name": {
"type": "string"
},
"size": {
"type": "string",
"enum": [
"standard-1X",
"standard-2X"
]
},
"post_to_incident_timeline": {
"type": "boolean"
},
"post_to_slack_channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
},
"required": [
"command",
"app_name",
"size"
]
},
"send_email_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"send_email"
]
},
"from": {
"type": "string",
"description": "The from email address. Need to use SMTP integration if different than rootly.com",
"default": "Rootly "
},
"to": {
"type": "array",
"items": {
"type": "string",
"description": "To address email"
}
},
"cc": {
"type": "array",
"items": {
"type": "string",
"description": "Cc address email"
}
},
"bcc": {
"type": "array",
"items": {
"type": "string",
"description": "Bcc address email"
}
},
"subject": {
"type": "string",
"description": "The subject"
},
"preheader": {
"type": "string",
"description": "The preheader",
"nullable": true
},
"body": {
"type": "string",
"description": "The email body",
"nullable": true
},
"include_header": {
"type": "boolean"
},
"include_footer": {
"type": "boolean"
},
"custom_logo_url": {
"type": "string",
"description": "URL to your custom email logo",
"nullable": true
}
},
"required": [
"to",
"subject",
"body"
]
},
"send_dashboard_report_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"send_dashboard_report"
]
},
"dashboard_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"from": {
"type": "string",
"description": "The from email address. Need to use SMTP integration if different than rootly.com",
"default": "Rootly "
},
"to": {
"type": "array",
"items": {
"type": "string",
"description": "The recipient"
}
},
"subject": {
"type": "string",
"description": "The subject"
},
"preheader": {
"type": "string",
"description": "The preheader",
"nullable": true
},
"body": {
"type": "string",
"description": "The email body",
"nullable": true
}
},
"required": [
"dashboard_ids",
"to",
"subject",
"body"
]
},
"create_slack_channel_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_slack_channel"
]
},
"workspace": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"title": {
"type": "string",
"description": "Slack channel title"
},
"private": {
"type": "string",
"enum": [
"auto",
"true",
"false"
],
"default": "auto"
}
},
"required": [
"workspace",
"title"
]
},
"send_slack_message_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"send_slack_message"
]
},
"channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"slack_users": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"slack_user_groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"actionables": {
"type": "array",
"items": {
"type": "string",
"enum": [
"update_summary",
"update_status",
"archive_channel",
"manage_incident_roles",
"update_incident",
"all_commands",
"leave_feedback",
"manage_form_fields",
"manage_action_items",
"view_tasks",
"add_pagerduty_responders",
"add_opsgenie_responders",
"add_victor_ops_responders",
"update_status_page",
"pause_reminder",
"snooze_reminder",
"restart_reminder",
"cancel_incident",
"delete_message"
]
}
},
"broadcast_thread_reply_to_channel": {
"type": "boolean"
},
"send_as_ephemeral": {
"type": "boolean"
},
"color": {
"type": "string",
"description": "A hex color ex. #FFFFFF"
},
"pin_to_channel": {
"type": "boolean"
},
"update_parent_message": {
"type": "boolean"
},
"thread_ts": {
"type": "string",
"description": "The thread to send the message into"
},
"parent_message_thread_task": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "A hash where [id] is the task id of the parent task that sent a message, and [name] is the name of the parent task"
},
"text": {
"type": "string",
"description": "The message text"
},
"send_only_as_threaded_message": {
"type": "boolean",
"description": "When set to true, if the parent for this threaded message cannot be found the message will be skipped."
}
},
"required": [
"text"
],
"anyOf": [
{
"required": [
"channels"
],
"properties": {
"channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
}
},
{
"required": [
"slack_users"
],
"properties": {
"slack_users": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
}
},
{
"required": [
"slack_user_groups"
],
"properties": {
"slack_user_groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
}
}
]
},
"send_sms_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"send_sms"
]
},
"phone_numbers": {
"type": "array",
"items": {
"type": "string",
"description": "A recipient phone number",
"example": [
"14150001111"
]
}
},
"name": {
"type": "string",
"description": "The name"
},
"content": {
"type": "string",
"description": "The SMS message"
}
},
"required": [
"phone_numbers",
"name",
"content"
]
},
"send_whatsapp_message_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"send_whatsapp_message"
]
},
"phone_numbers": {
"type": "array",
"items": {
"type": "string",
"description": "A recipient phone number",
"example": [
"14150001111"
]
}
},
"name": {
"type": "string",
"description": "The name"
},
"content": {
"type": "string",
"description": "The WhatsApp message"
}
},
"required": [
"phone_numbers",
"name",
"content"
]
},
"snapshot_datadog_graph_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"snapshot_datadog_graph"
]
},
"dashboards": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"past_duration": {
"type": "string",
"description": "in format '1 minute', '30 days', '3 months', etc",
"example": "1 hour"
},
"metric_queries": {
"type": "array",
"items": {
"type": "string"
}
},
"post_to_incident_timeline": {
"type": "boolean"
},
"post_to_slack_channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
},
"required": [
"past_duration"
]
},
"snapshot_grafana_dashboard_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"snapshot_grafana_dashboard"
]
},
"dashboards": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"post_to_incident_timeline": {
"type": "boolean"
},
"post_to_slack_channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
},
"required": [
"dashboards"
]
},
"snapshot_looker_look_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"snapshot_looker_look"
]
},
"dashboards": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"post_to_incident_timeline": {
"type": "boolean"
},
"post_to_slack_channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
},
"required": [
"dashboards"
]
},
"snapshot_new_relic_graph_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"snapshot_looker_graph"
]
},
"metric_query": {
"type": "string"
},
"metric_type": {
"type": "string",
"enum": [
"APDEX",
"AREA",
"BAR",
"BASELINE",
"BILLBOARD",
"BULLET",
"EVENT_FEED",
"FUNNEL",
"HEATMAP",
"HISTOGRAM",
"LINE",
"PIE",
"SCATTER",
"STACKED_HORIZONTAL_BAR",
"TABLE",
"VERTICAL_BAR"
]
},
"post_to_incident_timeline": {
"type": "boolean"
},
"post_to_slack_channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
},
"required": [
"metric_query",
"metric_type"
]
},
"tweet_twitter_message_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"tweet_twitter_message"
]
},
"message": {
"type": "string"
}
},
"required": [
"message"
]
},
"update_airtable_table_record_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"update_airtable_table_record"
]
},
"base_key": {
"type": "string",
"description": "The base key"
},
"table_name": {
"type": "string",
"description": "The table name"
},
"record_id": {
"type": "string",
"description": "The record id"
},
"custom_fields_mapping": {
"type": "string",
"description": "Custom field mappings. Can contain liquid markup and need to be valid JSON",
"nullable": true
}
},
"required": [
"base_key",
"table_name",
"record_id"
]
},
"update_asana_task_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"update_asana_task"
]
},
"task_id": {
"type": "string",
"description": "The task id"
},
"title": {
"type": "string",
"description": "The task title"
},
"notes": {
"type": "string"
},
"assign_user_email": {
"type": "string",
"description": "The assigned user's email"
},
"completion": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"due_date": {
"type": "string",
"description": "The due date"
},
"custom_fields_mapping": {
"type": "string",
"description": "Custom field mappings. Can contain liquid markup and need to be valid JSON",
"nullable": true
},
"dependency_direction": {
"type": "string",
"enum": [
"blocking",
"blocked_by"
],
"default": "blocking"
},
"dependent_task_ids": {
"type": "array",
"description": "Dependent task ids. Supports liquid syntax",
"items": {
"type": "string"
},
"nullable": true
}
},
"required": [
"task_id",
"completion"
]
},
"update_github_issue_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"update_github_issue"
]
},
"issue_id": {
"type": "string",
"description": "The issue id"
},
"repository": {
"type": "object",
"description": "The repository (used for loading labels and issue types)",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"title": {
"type": "string",
"description": "The issue title"
},
"body": {
"type": "string",
"description": "The issue body"
},
"labels": {
"type": "array",
"description": "The issue labels",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"labels_mode": {
"type": "string",
"description": "How to apply labels. 'replace' (default) overwrites all existing labels. 'append' adds to existing labels without removing them.",
"enum": [
"replace",
"append"
],
"default": "replace"
},
"issue_type": {
"type": "object",
"description": "The issue type",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"completion": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"custom_fields_mapping": {
"type": "string",
"description": "Custom field mappings. Can contain liquid markup and need to be valid JSON",
"nullable": true
}
},
"required": [
"issue_id",
"completion"
]
},
"update_gitlab_issue_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"update_gitlab_issue"
]
},
"issue_id": {
"type": "string",
"description": "The issue id"
},
"issue_type": {
"type": "string",
"description": "The issue type",
"enum": [
"issue",
"incident",
"test_case",
"task"
]
},
"title": {
"type": "string",
"description": "The issue title"
},
"description": {
"type": "string",
"description": "The issue description"
},
"labels": {
"type": "string",
"description": "The issue labels"
},
"due_date": {
"type": "string",
"description": "The due date"
},
"completion": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"required": [
"issue_id",
"completion"
]
},
"update_incident_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"update_incident"
]
},
"attribute_to_query_by": {
"type": "string",
"enum": [
"id",
"slug",
"sequential_id",
"pagerduty_incident_id",
"opsgenie_incident_id",
"victor_ops_incident_id",
"jira_issue_id",
"asana_task_id",
"shortcut_task_id",
"linear_issue_id",
"zendesk_ticket_id",
"motion_task_id",
"trello_card_id",
"airtable_record_id",
"shortcut_story_id",
"github_issue_id",
"gitlab_issue_id",
"freshservice_ticket_id",
"freshservice_task_id",
"clickup_task_id"
],
"default": "id"
},
"incident_id": {
"type": "string",
"description": "The incident id to update or id of any attribute on the incident"
},
"title": {
"type": "string",
"description": "The incident title",
"nullable": true
},
"summary": {
"type": "string",
"description": "The incident summary",
"nullable": true
},
"status": {
"type": "string",
"nullable": true
},
"severity_id": {
"type": "string",
"nullable": true
},
"incident_type_ids": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"service_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of service UUIDs",
"nullable": true
},
"functionality_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of functionality UUIDs",
"nullable": true
},
"environment_ids": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"group_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of group/team UUIDs",
"nullable": true
},
"started_at": {
"type": "string",
"nullable": true
},
"detected_at": {
"type": "string",
"nullable": true
},
"acknowledged_at": {
"type": "string",
"nullable": true
},
"mitigated_at": {
"type": "string",
"nullable": true
},
"resolved_at": {
"type": "string",
"nullable": true
},
"private": {
"type": "boolean"
},
"custom_fields_mapping": {
"type": "string",
"description": "Custom field mappings. Can contain liquid markup and need to be valid JSON. Use 'services', 'functionalities', or 'groups' keys with arrays of names/slugs for name/slug lookup",
"nullable": true
}
},
"required": [
"incident_id"
]
},
"update_incident_postmortem_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"update_incident_postmortem"
]
},
"postmortem_id": {
"type": "string",
"description": "UUID of the retrospective that needs to be updated"
},
"title": {
"type": "string",
"description": "The incident title",
"nullable": true
},
"status": {
"type": "string",
"nullable": true
}
},
"required": [
"postmortem_id"
]
},
"update_jira_issue_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"update_jira_issue"
]
},
"integration": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "Specify integration id if you have more than one Jira instance"
},
"issue_id": {
"type": "string",
"description": "The issue id"
},
"title": {
"type": "string",
"description": "The issue title"
},
"description": {
"type": "string",
"description": "The issue description"
},
"labels": {
"type": "string",
"description": "The issue labels"
},
"assign_user_email": {
"type": "string",
"description": "The assigned user's email"
},
"reporter_user_email": {
"type": "string",
"description": "The reporter user's email"
},
"project_key": {
"type": "string",
"description": "The project key"
},
"due_date": {
"type": "string",
"description": "The due date"
},
"priority": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The priority id and display name"
},
"status": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The status id and display name"
},
"custom_fields_mapping": {
"type": "string",
"description": "Custom field mappings. Can contain liquid markup and need to be valid JSON",
"nullable": true
},
"update_payload": {
"type": "string",
"description": "Update payload. Can contain liquid markup and need to be valid JSON",
"nullable": true
}
},
"required": [
"issue_id",
"project_key"
]
},
"update_linear_issue_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"update_linear_issue"
]
},
"issue_id": {
"type": "string",
"description": "The issue id"
},
"title": {
"type": "string",
"description": "The issue title"
},
"description": {
"type": "string",
"description": "The issue description"
},
"state": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The state id and display name",
"nullable": true
},
"project": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The project id and display name"
},
"labels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"priority": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The priority id and display name"
},
"assign_user_email": {
"type": "string",
"description": "The assigned user's email"
},
"custom_fields_mapping": {
"type": "string",
"description": "Custom field mappings. Can contain liquid markup and need to be valid JSON",
"nullable": true
}
},
"required": [
"issue_id"
]
},
"update_service_now_incident_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"update_service_now_incident"
]
},
"incident_id": {
"type": "string",
"description": "The incident id"
},
"title": {
"type": "string",
"description": "The incident title"
},
"description": {
"type": "string",
"description": "The incident description"
},
"priority": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The priority id and display name"
},
"completion": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The completion id and display name"
},
"custom_fields_mapping": {
"type": "string",
"description": "Custom field mappings. Can contain liquid markup and need to be valid JSON",
"nullable": true
}
},
"required": [
"incident_id"
]
},
"update_shortcut_story_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"update_shortcut_story"
]
},
"story_id": {
"type": "string",
"description": "The story id"
},
"title": {
"type": "string",
"description": "The incident title"
},
"description": {
"type": "string",
"description": "The incident description"
},
"labels": {
"type": "string",
"description": "The story labels"
},
"due_date": {
"type": "string",
"description": "The due date"
},
"archivation": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The archivation id and display name"
}
},
"required": [
"story_id",
"archivation"
]
},
"update_shortcut_task_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"update_shortcut_task"
]
},
"task_id": {
"type": "string",
"description": "The task id"
},
"parent_story_id": {
"type": "string",
"description": "The parent story"
},
"description": {
"type": "string",
"description": "The task description"
},
"completion": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The completion id and display name"
}
},
"required": [
"task_id",
"parent_story_id",
"completion"
]
},
"update_slack_channel_topic_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"update_slack_channel_topic"
]
},
"channel": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"topic": {
"type": "string"
}
},
"required": [
"channel",
"topic"
]
},
"update_status_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"update_status"
]
},
"status": {
"type": "string",
"enum": [
"in_triage",
"started",
"mitigated",
"resolved",
"closed",
"cancelled"
]
},
"inactivity_timeout": {
"type": "string",
"description": "In format '1 hour', '1 day', etc",
"example": "1 hour"
}
},
"required": [
"status"
]
},
"update_incident_status_timestamp_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"update_status"
]
},
"sub_status_id": {
"type": "string",
"description": "Sub-status to update timestamp for"
},
"assigned_at": {
"type": "string",
"description": "Timestamp of when the sub-status was assigned"
}
},
"required": [
"sub_status_id",
"assigned_at"
]
},
"update_trello_card_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"update_trello_card"
]
},
"card_id": {
"type": "string",
"description": "The card id"
},
"title": {
"type": "string",
"description": "The card title"
},
"description": {
"type": "string",
"description": "The card description"
},
"due_date": {
"type": "string",
"description": "The due date"
},
"board": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The board id and display name"
},
"list": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The list id and display name"
},
"labels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"archivation": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The archivation id and display name"
}
},
"required": [
"card_id",
"archivation"
]
},
"update_clickup_task_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"update_clickup_task"
]
},
"task_id": {
"type": "string",
"description": "The task id"
},
"title": {
"type": "string",
"description": "The task title"
},
"description": {
"type": "string",
"description": "The task description"
},
"tags": {
"type": "string",
"description": "The task tags"
},
"priority": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The priority id and display name"
},
"due_date": {
"type": "string",
"description": "The due date"
},
"custom_fields_mapping": {
"type": "string",
"description": "Custom field mappings. Can contain liquid markup and need to be valid JSON",
"nullable": true
},
"task_payload": {
"type": "string",
"description": "Additional ClickUp task attributes. Will be merged into whatever was specified in this tasks current parameters. Can contain liquid markup and need to be valid JSON",
"nullable": true
}
},
"required": [
"task_id"
]
},
"update_motion_task_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"update_motion_task"
]
},
"task_id": {
"type": "string",
"description": "The task id"
},
"title": {
"type": "string",
"description": "The task title"
},
"description": {
"type": "string",
"description": "The task description"
},
"labels": {
"type": "array",
"items": {
"type": "string"
}
},
"priority": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The priority id and display name"
},
"duration": {
"type": "string",
"description": "The duration. Eg. \"NONE\", \"REMINDER\", or a integer greater than 0."
},
"due_date": {
"type": "string",
"description": "The due date"
}
},
"required": [
"task_id"
]
},
"update_zendesk_ticket_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"update_zendesk_ticket"
]
},
"ticket_id": {
"type": "string",
"description": "The ticket id"
},
"subject": {
"type": "string",
"description": "The ticket subject"
},
"tags": {
"type": "string",
"description": "The ticket tags"
},
"priority": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The priority id and display name"
},
"completion": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The completion id and display name"
},
"custom_fields_mapping": {
"type": "string",
"description": "Custom field mappings. Can contain liquid markup and need to be valid JSON",
"nullable": true
},
"ticket_payload": {
"type": "string",
"description": "Additional Zendesk ticket attributes. Will be merged into whatever was specified in this tasks current parameters. Can contain liquid markup and need to be valid JSON",
"nullable": true
}
},
"required": [
"ticket_id"
]
},
"update_attached_alerts_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"update_attached_alerts"
]
},
"status": {
"type": "string",
"enum": [
"acknowledged",
"resolved"
]
}
},
"required": [
"status"
]
},
"trigger_workflow_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"trigger_workflow"
]
},
"kind": {
"type": "string",
"enum": [
"incident",
"post_mortem",
"action_item",
"pulse",
"alert"
],
"default": "incident"
},
"attribute_to_query_by": {
"type": "string",
"enum": [
"id",
"slug",
"sequential_id",
"pagerduty_incident_id",
"opsgenie_incident_id",
"victor_ops_incident_id",
"jira_issue_id",
"asana_task_id",
"shortcut_task_id",
"linear_issue_id",
"zendesk_ticket_id",
"motion_task_id",
"trello_card_id",
"airtable_record_id",
"shortcut_story_id",
"github_issue_id",
"freshservice_ticket_id",
"freshservice_task_id",
"clickup_task_id"
],
"default": "id",
"description": "[\"(incident) kind can only match [:id, :slug, :sequential_id, :pagerduty_incident_id, :opsgenie_incident_id, :victor_ops_incident_id, :jira_issue_id, :asana_task_id, :shortcut_task_id, :linear_issue_id, :zendesk_ticket_id, :motion_task_id, :trello_card_id, :airtable_record_id, :shortcut_story_id, :github_issue_id, :freshservice_ticket_id, :freshservice_task_id, :clickup_task_id]\", \"(post_mortem) kind can only match [:id]\", \"(action_item) kind can only match [:id, :jira_issue_id, :asana_task_id, :shortcut_task_id, :linear_issue_id, :zendesk_ticket_id, :motion_task_id, :trello_card_id, :airtable_record_id, :shortcut_story_id, :github_issue_id, :freshservice_ticket_id, :freshservice_task_id, :clickup_task_id]\", \"(pulse) kind can only match [:id]\", \"(alert) kind can only match [:id]\"]"
},
"resource": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"workflow": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"check_workflow_conditions": {
"type": "boolean"
}
},
"required": [
"kind",
"workflow",
"resource",
"attribute_to_query_by"
]
},
"send_slack_blocks_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"send_slack_blocks"
]
},
"message": {
"type": "string"
},
"blocks": {
"type": "string",
"description": "Support liquid markup. Needs to be a valid JSON string after liquid is parsed"
},
"attachments": {
"type": "string",
"description": "Support liquid markup. Needs to be a valid JSON string after liquid is parsed"
},
"channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"slack_users": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"slack_user_groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"broadcast_thread_reply_to_channel": {
"type": "boolean"
},
"send_as_ephemeral": {
"type": "boolean"
},
"pin_to_channel": {
"type": "boolean"
},
"thread_ts": {
"type": "string",
"description": "The thread to send the message into"
},
"update_parent_message": {
"type": "boolean"
},
"parent_message_thread_task": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "A hash where [id] is the task id of the parent task that sent a message, and [name] is the name of the parent task"
},
"send_only_as_threaded_message": {
"type": "boolean",
"description": "When set to true, if the parent for this threaded message cannot be found the message will be skipped."
}
},
"required": [
"blocks"
],
"anyOf": [
{
"required": [
"channels"
],
"properties": {
"channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
}
},
{
"required": [
"slack_users"
],
"properties": {
"slack_users": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
}
},
{
"required": [
"slack_user_groups"
],
"properties": {
"slack_user_groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
}
}
]
},
"create_openai_chat_completion_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"openai_chat_completion"
]
},
"model": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The OpenAI model. eg: gpt-5-nano"
},
"system_prompt": {
"type": "string",
"description": "The system prompt to send to OpenAI (optional)"
},
"prompt": {
"type": "string",
"description": "The prompt to send to OpenAI"
},
"temperature": {
"type": "number",
"description": "Controls randomness in the response. Higher values make output more random",
"minimum": 0.0,
"maximum": 2.0
},
"max_tokens": {
"type": "integer",
"description": "Maximum number of tokens to generate in the response",
"minimum": 1
},
"top_p": {
"type": "number",
"description": "Controls diversity via nucleus sampling. Lower values make output more focused",
"minimum": 0.0,
"maximum": 1.0
},
"reasoning_effort": {
"type": "string",
"description": "Constrains effort on reasoning for GPT-5 and o-series models",
"enum": [
"minimal",
"low",
"medium",
"high"
]
},
"reasoning_summary": {
"type": "string",
"description": "Summary of the reasoning performed by the model for GPT-5 and o-series models",
"enum": [
"auto",
"concise",
"detailed"
]
}
},
"required": [
"model",
"prompt"
]
},
"create_watsonx_chat_completion_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_watsonx_chat_completion_task"
]
},
"model": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The WatsonX model. eg: ibm/granite-3-b8b-instruct"
},
"system_prompt": {
"type": "string",
"description": "The system prompt to send to WatsonX (optional)"
},
"prompt": {
"type": "string",
"description": "The prompt to send to WatsonX"
},
"project_id": {
"type": "string"
}
},
"required": [
"project_id",
"model",
"prompt"
]
},
"create_google_gemini_chat_completion_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_google_gemini_chat_completion_task"
]
},
"model": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The Gemini model. eg: gemini-2.0-flash"
},
"system_prompt": {
"type": "string",
"description": "The system prompt to send to Gemini (optional)"
},
"prompt": {
"type": "string",
"description": "The prompt to send to Gemini"
}
},
"required": [
"model",
"prompt"
]
},
"create_mistral_chat_completion_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_mistral_chat_completion_task"
]
},
"model": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The Mistral model. eg: mistral-large-latest"
},
"system_prompt": {
"type": "string",
"description": "The system prompt to send to Mistral (optional)"
},
"prompt": {
"type": "string",
"description": "The prompt to send to Mistral"
},
"temperature": {
"type": "number",
"minimum": 0.0,
"maximum": 1.5,
"description": "Sampling temperature (0.0-1.5). Higher values make output more random."
},
"max_tokens": {
"type": "integer",
"minimum": 1,
"description": "Maximum number of tokens to generate"
},
"top_p": {
"type": "number",
"minimum": 0.0,
"maximum": 1.0,
"description": "Nucleus sampling parameter (0.0-1.0)"
}
},
"required": [
"model",
"prompt"
]
},
"create_anthropic_chat_completion_task_params": {
"type": "object",
"properties": {
"task_type": {
"type": "string",
"enum": [
"create_anthropic_chat_completion_task"
]
},
"model": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"description": "The Anthropic model. eg: claude-3-5-sonnet-20241022"
},
"system_prompt": {
"type": "string",
"description": "The system prompt to send to Anthropic (optional)"
},
"prompt": {
"type": "string",
"description": "The prompt to send to Anthropic"
}
},
"required": [
"model",
"prompt"
]
},
"new_workflow_task": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"workflow_tasks"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the workflow task"
},
"position": {
"type": "integer",
"description": "The position of the workflow task"
},
"skip_on_failure": {
"type": "boolean",
"description": "Skip workflow task if any failures"
},
"enabled": {
"type": "boolean",
"description": "Enable/disable workflow task",
"default": true
},
"task_params": {
"oneOf": [
{
"$ref": "#/components/schemas/add_action_item_task_params"
},
{
"$ref": "#/components/schemas/update_action_item_task_params"
},
{
"$ref": "#/components/schemas/add_role_task_params"
},
{
"$ref": "#/components/schemas/add_slack_bookmark_task_params"
},
{
"$ref": "#/components/schemas/add_team_task_params"
},
{
"$ref": "#/components/schemas/add_to_timeline_task_params"
},
{
"$ref": "#/components/schemas/archive_slack_channels_task_params"
},
{
"$ref": "#/components/schemas/attach_datadog_dashboards_task_params"
},
{
"$ref": "#/components/schemas/auto_assign_role_opsgenie_task_params"
},
{
"$ref": "#/components/schemas/auto_assign_role_rootly_task_params"
},
{
"$ref": "#/components/schemas/auto_assign_role_pagerduty_task_params"
},
{
"$ref": "#/components/schemas/update_pagerduty_incident_task_params"
},
{
"$ref": "#/components/schemas/create_pagerduty_status_update_task_params"
},
{
"$ref": "#/components/schemas/create_pagertree_alert_task_params"
},
{
"$ref": "#/components/schemas/update_pagertree_alert_task_params"
},
{
"$ref": "#/components/schemas/auto_assign_role_victor_ops_task_params"
},
{
"$ref": "#/components/schemas/call_people_task_params"
},
{
"$ref": "#/components/schemas/create_airtable_table_record_task_params"
},
{
"$ref": "#/components/schemas/create_asana_subtask_task_params"
},
{
"$ref": "#/components/schemas/create_asana_task_task_params"
},
{
"$ref": "#/components/schemas/create_confluence_page_task_params"
},
{
"$ref": "#/components/schemas/create_datadog_notebook_task_params"
},
{
"$ref": "#/components/schemas/create_coda_page_task_params"
},
{
"$ref": "#/components/schemas/create_dropbox_paper_page_task_params"
},
{
"$ref": "#/components/schemas/create_github_issue_task_params"
},
{
"$ref": "#/components/schemas/create_gitlab_issue_task_params"
},
{
"$ref": "#/components/schemas/create_outlook_event_task_params"
},
{
"$ref": "#/components/schemas/create_google_calendar_event_task_params"
},
{
"$ref": "#/components/schemas/update_google_docs_page_task_params"
},
{
"$ref": "#/components/schemas/update_coda_page_task_params"
},
{
"$ref": "#/components/schemas/update_google_calendar_event_task_params"
},
{
"$ref": "#/components/schemas/create_sharepoint_page_task_params"
},
{
"$ref": "#/components/schemas/create_google_docs_page_task_params"
},
{
"$ref": "#/components/schemas/create_google_docs_permissions_task_params"
},
{
"$ref": "#/components/schemas/remove_google_docs_permissions_task_params"
},
{
"$ref": "#/components/schemas/create_quip_page_task_params"
},
{
"$ref": "#/components/schemas/create_google_meeting_task_params"
},
{
"$ref": "#/components/schemas/create_go_to_meeting_task_params"
},
{
"$ref": "#/components/schemas/create_incident_task_params"
},
{
"$ref": "#/components/schemas/create_sub_incident_task_params"
},
{
"$ref": "#/components/schemas/create_incident_postmortem_task_params"
},
{
"$ref": "#/components/schemas/create_jira_issue_task_params"
},
{
"$ref": "#/components/schemas/create_jira_subtask_task_params"
},
{
"$ref": "#/components/schemas/create_linear_issue_task_params"
},
{
"$ref": "#/components/schemas/create_linear_subtask_issue_task_params"
},
{
"$ref": "#/components/schemas/create_linear_issue_comment_task_params"
},
{
"$ref": "#/components/schemas/create_microsoft_teams_meeting_task_params"
},
{
"$ref": "#/components/schemas/create_microsoft_teams_channel_task_params"
},
{
"$ref": "#/components/schemas/create_microsoft_teams_chat_task_params"
},
{
"$ref": "#/components/schemas/add_microsoft_teams_tab_task_params"
},
{
"$ref": "#/components/schemas/add_microsoft_teams_chat_tab_task_params"
},
{
"$ref": "#/components/schemas/create_google_chat_space_task_params"
},
{
"$ref": "#/components/schemas/send_google_chat_message_task_params"
},
{
"$ref": "#/components/schemas/send_google_chat_attachments_task_params"
},
{
"$ref": "#/components/schemas/invite_to_google_chat_space_task_params"
},
{
"$ref": "#/components/schemas/archive_google_chat_spaces_task_params"
},
{
"$ref": "#/components/schemas/rename_google_chat_space_task_params"
},
{
"$ref": "#/components/schemas/update_google_chat_space_description_task_params"
},
{
"$ref": "#/components/schemas/change_google_chat_space_privacy_task_params"
},
{
"$ref": "#/components/schemas/archive_microsoft_teams_channels_task_params"
},
{
"$ref": "#/components/schemas/rename_microsoft_teams_channel_task_params"
},
{
"$ref": "#/components/schemas/invite_to_microsoft_teams_channel_task_params"
},
{
"$ref": "#/components/schemas/create_notion_page_task_params"
},
{
"$ref": "#/components/schemas/send_microsoft_teams_message_task_params"
},
{
"$ref": "#/components/schemas/send_microsoft_teams_chat_message_task_params"
},
{
"$ref": "#/components/schemas/send_microsoft_teams_blocks_task_params"
},
{
"$ref": "#/components/schemas/update_notion_page_task_params"
},
{
"$ref": "#/components/schemas/update_quip_page_task_params"
},
{
"$ref": "#/components/schemas/update_confluence_page_task_params"
},
{
"$ref": "#/components/schemas/update_sharepoint_page_task_params"
},
{
"$ref": "#/components/schemas/update_dropbox_paper_page_task_params"
},
{
"$ref": "#/components/schemas/update_datadog_notebook_task_params"
},
{
"$ref": "#/components/schemas/create_service_now_incident_task_params"
},
{
"$ref": "#/components/schemas/create_shortcut_story_task_params"
},
{
"$ref": "#/components/schemas/create_shortcut_task_task_params"
},
{
"$ref": "#/components/schemas/create_trello_card_task_params"
},
{
"$ref": "#/components/schemas/create_webex_meeting_task_params"
},
{
"$ref": "#/components/schemas/create_zendesk_ticket_task_params"
},
{
"$ref": "#/components/schemas/create_zendesk_jira_link_task_params"
},
{
"$ref": "#/components/schemas/create_clickup_task_task_params"
},
{
"$ref": "#/components/schemas/create_motion_task_task_params"
},
{
"$ref": "#/components/schemas/create_zoom_meeting_task_params"
},
{
"$ref": "#/components/schemas/get_github_commits_task_params"
},
{
"$ref": "#/components/schemas/get_gitlab_commits_task_params"
},
{
"$ref": "#/components/schemas/get_pulses_task_params"
},
{
"$ref": "#/components/schemas/get_alerts_task_params"
},
{
"$ref": "#/components/schemas/http_client_task_params"
},
{
"$ref": "#/components/schemas/invite_to_slack_channel_opsgenie_task_params"
},
{
"$ref": "#/components/schemas/invite_to_slack_channel_rootly_task_params"
},
{
"$ref": "#/components/schemas/invite_to_microsoft_teams_channel_rootly_task_params"
},
{
"$ref": "#/components/schemas/invite_to_slack_channel_pagerduty_task_params"
},
{
"$ref": "#/components/schemas/invite_to_slack_channel_task_params"
},
{
"$ref": "#/components/schemas/invite_to_slack_channel_victor_ops_task_params"
},
{
"$ref": "#/components/schemas/page_opsgenie_on_call_responders_task_params"
},
{
"$ref": "#/components/schemas/create_opsgenie_alert_task_params"
},
{
"$ref": "#/components/schemas/create_jsmops_alert_task_params"
},
{
"$ref": "#/components/schemas/page_jsmops_on_call_responders_task_params"
},
{
"$ref": "#/components/schemas/update_opsgenie_alert_task_params"
},
{
"$ref": "#/components/schemas/update_opsgenie_incident_task_params"
},
{
"$ref": "#/components/schemas/page_rootly_on_call_responders_task_params"
},
{
"$ref": "#/components/schemas/page_pagerduty_on_call_responders_task_params"
},
{
"$ref": "#/components/schemas/page_victor_ops_on_call_responders_task_params"
},
{
"$ref": "#/components/schemas/update_victor_ops_incident_task_params"
},
{
"$ref": "#/components/schemas/print_task_params"
},
{
"$ref": "#/components/schemas/publish_incident_task_params"
},
{
"$ref": "#/components/schemas/redis_client_task_params"
},
{
"$ref": "#/components/schemas/rename_slack_channel_task_params"
},
{
"$ref": "#/components/schemas/change_slack_channel_privacy_task_params"
},
{
"$ref": "#/components/schemas/run_command_heroku_task_params"
},
{
"$ref": "#/components/schemas/send_email_task_params"
},
{
"$ref": "#/components/schemas/send_dashboard_report_task_params"
},
{
"$ref": "#/components/schemas/create_slack_channel_task_params"
},
{
"$ref": "#/components/schemas/send_slack_message_task_params"
},
{
"$ref": "#/components/schemas/send_sms_task_params"
},
{
"$ref": "#/components/schemas/send_whatsapp_message_task_params"
},
{
"$ref": "#/components/schemas/snapshot_datadog_graph_task_params"
},
{
"$ref": "#/components/schemas/snapshot_grafana_dashboard_task_params"
},
{
"$ref": "#/components/schemas/snapshot_looker_look_task_params"
},
{
"$ref": "#/components/schemas/snapshot_new_relic_graph_task_params"
},
{
"$ref": "#/components/schemas/tweet_twitter_message_task_params"
},
{
"$ref": "#/components/schemas/update_airtable_table_record_task_params"
},
{
"$ref": "#/components/schemas/update_asana_task_task_params"
},
{
"$ref": "#/components/schemas/update_github_issue_task_params"
},
{
"$ref": "#/components/schemas/update_gitlab_issue_task_params"
},
{
"$ref": "#/components/schemas/update_incident_task_params"
},
{
"$ref": "#/components/schemas/update_incident_postmortem_task_params"
},
{
"$ref": "#/components/schemas/update_jira_issue_task_params"
},
{
"$ref": "#/components/schemas/update_linear_issue_task_params"
},
{
"$ref": "#/components/schemas/update_service_now_incident_task_params"
},
{
"$ref": "#/components/schemas/update_shortcut_story_task_params"
},
{
"$ref": "#/components/schemas/update_shortcut_task_task_params"
},
{
"$ref": "#/components/schemas/update_slack_channel_topic_task_params"
},
{
"$ref": "#/components/schemas/update_status_task_params"
},
{
"$ref": "#/components/schemas/update_incident_status_timestamp_task_params"
},
{
"$ref": "#/components/schemas/update_trello_card_task_params"
},
{
"$ref": "#/components/schemas/update_clickup_task_task_params"
},
{
"$ref": "#/components/schemas/update_motion_task_task_params"
},
{
"$ref": "#/components/schemas/update_zendesk_ticket_task_params"
},
{
"$ref": "#/components/schemas/update_attached_alerts_task_params"
},
{
"$ref": "#/components/schemas/trigger_workflow_task_params"
},
{
"$ref": "#/components/schemas/send_slack_blocks_task_params"
},
{
"$ref": "#/components/schemas/create_openai_chat_completion_task_params"
},
{
"$ref": "#/components/schemas/create_watsonx_chat_completion_task_params"
},
{
"$ref": "#/components/schemas/create_google_gemini_chat_completion_task_params"
},
{
"$ref": "#/components/schemas/create_mistral_chat_completion_task_params"
},
{
"$ref": "#/components/schemas/create_anthropic_chat_completion_task_params"
}
]
}
},
"required": [
"task_params"
],
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_workflow_task": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"workflow_tasks"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the workflow task"
},
"position": {
"type": "integer",
"description": "The position of the workflow task"
},
"skip_on_failure": {
"type": "boolean",
"description": "Skip workflow task if any failures"
},
"enabled": {
"type": "boolean",
"description": "Enable/disable workflow task",
"default": true
},
"task_params": {
"anyOf": [
{
"$ref": "#/components/schemas/add_action_item_task_params"
},
{
"$ref": "#/components/schemas/update_action_item_task_params"
},
{
"$ref": "#/components/schemas/add_role_task_params"
},
{
"$ref": "#/components/schemas/add_slack_bookmark_task_params"
},
{
"$ref": "#/components/schemas/add_team_task_params"
},
{
"$ref": "#/components/schemas/add_to_timeline_task_params"
},
{
"$ref": "#/components/schemas/archive_slack_channels_task_params"
},
{
"$ref": "#/components/schemas/attach_datadog_dashboards_task_params"
},
{
"$ref": "#/components/schemas/auto_assign_role_opsgenie_task_params"
},
{
"$ref": "#/components/schemas/auto_assign_role_rootly_task_params"
},
{
"$ref": "#/components/schemas/auto_assign_role_pagerduty_task_params"
},
{
"$ref": "#/components/schemas/update_pagerduty_incident_task_params"
},
{
"$ref": "#/components/schemas/create_pagerduty_status_update_task_params"
},
{
"$ref": "#/components/schemas/create_pagertree_alert_task_params"
},
{
"$ref": "#/components/schemas/update_pagertree_alert_task_params"
},
{
"$ref": "#/components/schemas/auto_assign_role_victor_ops_task_params"
},
{
"$ref": "#/components/schemas/call_people_task_params"
},
{
"$ref": "#/components/schemas/create_airtable_table_record_task_params"
},
{
"$ref": "#/components/schemas/create_asana_subtask_task_params"
},
{
"$ref": "#/components/schemas/create_asana_task_task_params"
},
{
"$ref": "#/components/schemas/create_confluence_page_task_params"
},
{
"$ref": "#/components/schemas/create_datadog_notebook_task_params"
},
{
"$ref": "#/components/schemas/create_coda_page_task_params"
},
{
"$ref": "#/components/schemas/create_dropbox_paper_page_task_params"
},
{
"$ref": "#/components/schemas/create_github_issue_task_params"
},
{
"$ref": "#/components/schemas/create_gitlab_issue_task_params"
},
{
"$ref": "#/components/schemas/create_outlook_event_task_params"
},
{
"$ref": "#/components/schemas/create_google_calendar_event_task_params"
},
{
"$ref": "#/components/schemas/update_google_docs_page_task_params"
},
{
"$ref": "#/components/schemas/update_coda_page_task_params"
},
{
"$ref": "#/components/schemas/update_google_calendar_event_task_params"
},
{
"$ref": "#/components/schemas/create_sharepoint_page_task_params"
},
{
"$ref": "#/components/schemas/create_google_docs_page_task_params"
},
{
"$ref": "#/components/schemas/create_google_docs_permissions_task_params"
},
{
"$ref": "#/components/schemas/remove_google_docs_permissions_task_params"
},
{
"$ref": "#/components/schemas/create_quip_page_task_params"
},
{
"$ref": "#/components/schemas/create_google_meeting_task_params"
},
{
"$ref": "#/components/schemas/create_go_to_meeting_task_params"
},
{
"$ref": "#/components/schemas/create_incident_task_params"
},
{
"$ref": "#/components/schemas/create_sub_incident_task_params"
},
{
"$ref": "#/components/schemas/create_incident_postmortem_task_params"
},
{
"$ref": "#/components/schemas/create_jira_issue_task_params"
},
{
"$ref": "#/components/schemas/create_jira_subtask_task_params"
},
{
"$ref": "#/components/schemas/create_linear_issue_task_params"
},
{
"$ref": "#/components/schemas/create_linear_subtask_issue_task_params"
},
{
"$ref": "#/components/schemas/create_linear_issue_comment_task_params"
},
{
"$ref": "#/components/schemas/create_microsoft_teams_meeting_task_params"
},
{
"$ref": "#/components/schemas/create_microsoft_teams_channel_task_params"
},
{
"$ref": "#/components/schemas/create_microsoft_teams_chat_task_params"
},
{
"$ref": "#/components/schemas/add_microsoft_teams_tab_task_params"
},
{
"$ref": "#/components/schemas/add_microsoft_teams_chat_tab_task_params"
},
{
"$ref": "#/components/schemas/create_google_chat_space_task_params"
},
{
"$ref": "#/components/schemas/send_google_chat_message_task_params"
},
{
"$ref": "#/components/schemas/send_google_chat_attachments_task_params"
},
{
"$ref": "#/components/schemas/invite_to_google_chat_space_task_params"
},
{
"$ref": "#/components/schemas/archive_google_chat_spaces_task_params"
},
{
"$ref": "#/components/schemas/rename_google_chat_space_task_params"
},
{
"$ref": "#/components/schemas/update_google_chat_space_description_task_params"
},
{
"$ref": "#/components/schemas/change_google_chat_space_privacy_task_params"
},
{
"$ref": "#/components/schemas/archive_microsoft_teams_channels_task_params"
},
{
"$ref": "#/components/schemas/rename_microsoft_teams_channel_task_params"
},
{
"$ref": "#/components/schemas/invite_to_microsoft_teams_channel_task_params"
},
{
"$ref": "#/components/schemas/create_notion_page_task_params"
},
{
"$ref": "#/components/schemas/send_microsoft_teams_message_task_params"
},
{
"$ref": "#/components/schemas/send_microsoft_teams_chat_message_task_params"
},
{
"$ref": "#/components/schemas/send_microsoft_teams_blocks_task_params"
},
{
"$ref": "#/components/schemas/update_notion_page_task_params"
},
{
"$ref": "#/components/schemas/update_quip_page_task_params"
},
{
"$ref": "#/components/schemas/update_confluence_page_task_params"
},
{
"$ref": "#/components/schemas/update_sharepoint_page_task_params"
},
{
"$ref": "#/components/schemas/update_dropbox_paper_page_task_params"
},
{
"$ref": "#/components/schemas/update_datadog_notebook_task_params"
},
{
"$ref": "#/components/schemas/create_service_now_incident_task_params"
},
{
"$ref": "#/components/schemas/create_shortcut_story_task_params"
},
{
"$ref": "#/components/schemas/create_shortcut_task_task_params"
},
{
"$ref": "#/components/schemas/create_trello_card_task_params"
},
{
"$ref": "#/components/schemas/create_webex_meeting_task_params"
},
{
"$ref": "#/components/schemas/create_zendesk_ticket_task_params"
},
{
"$ref": "#/components/schemas/create_zendesk_jira_link_task_params"
},
{
"$ref": "#/components/schemas/create_clickup_task_task_params"
},
{
"$ref": "#/components/schemas/create_motion_task_task_params"
},
{
"$ref": "#/components/schemas/create_zoom_meeting_task_params"
},
{
"$ref": "#/components/schemas/get_github_commits_task_params"
},
{
"$ref": "#/components/schemas/get_gitlab_commits_task_params"
},
{
"$ref": "#/components/schemas/get_pulses_task_params"
},
{
"$ref": "#/components/schemas/get_alerts_task_params"
},
{
"$ref": "#/components/schemas/http_client_task_params"
},
{
"$ref": "#/components/schemas/invite_to_slack_channel_opsgenie_task_params"
},
{
"$ref": "#/components/schemas/invite_to_slack_channel_rootly_task_params"
},
{
"$ref": "#/components/schemas/invite_to_microsoft_teams_channel_rootly_task_params"
},
{
"$ref": "#/components/schemas/invite_to_slack_channel_pagerduty_task_params"
},
{
"$ref": "#/components/schemas/invite_to_slack_channel_task_params"
},
{
"$ref": "#/components/schemas/invite_to_slack_channel_victor_ops_task_params"
},
{
"$ref": "#/components/schemas/page_opsgenie_on_call_responders_task_params"
},
{
"$ref": "#/components/schemas/create_opsgenie_alert_task_params"
},
{
"$ref": "#/components/schemas/create_jsmops_alert_task_params"
},
{
"$ref": "#/components/schemas/page_jsmops_on_call_responders_task_params"
},
{
"$ref": "#/components/schemas/update_opsgenie_alert_task_params"
},
{
"$ref": "#/components/schemas/update_opsgenie_incident_task_params"
},
{
"$ref": "#/components/schemas/page_rootly_on_call_responders_task_params"
},
{
"$ref": "#/components/schemas/page_pagerduty_on_call_responders_task_params"
},
{
"$ref": "#/components/schemas/page_victor_ops_on_call_responders_task_params"
},
{
"$ref": "#/components/schemas/update_victor_ops_incident_task_params"
},
{
"$ref": "#/components/schemas/print_task_params"
},
{
"$ref": "#/components/schemas/publish_incident_task_params"
},
{
"$ref": "#/components/schemas/redis_client_task_params"
},
{
"$ref": "#/components/schemas/rename_slack_channel_task_params"
},
{
"$ref": "#/components/schemas/change_slack_channel_privacy_task_params"
},
{
"$ref": "#/components/schemas/run_command_heroku_task_params"
},
{
"$ref": "#/components/schemas/send_email_task_params"
},
{
"$ref": "#/components/schemas/send_dashboard_report_task_params"
},
{
"$ref": "#/components/schemas/create_slack_channel_task_params"
},
{
"$ref": "#/components/schemas/send_slack_message_task_params"
},
{
"$ref": "#/components/schemas/send_sms_task_params"
},
{
"$ref": "#/components/schemas/send_whatsapp_message_task_params"
},
{
"$ref": "#/components/schemas/snapshot_datadog_graph_task_params"
},
{
"$ref": "#/components/schemas/snapshot_grafana_dashboard_task_params"
},
{
"$ref": "#/components/schemas/snapshot_looker_look_task_params"
},
{
"$ref": "#/components/schemas/snapshot_new_relic_graph_task_params"
},
{
"$ref": "#/components/schemas/tweet_twitter_message_task_params"
},
{
"$ref": "#/components/schemas/update_airtable_table_record_task_params"
},
{
"$ref": "#/components/schemas/update_asana_task_task_params"
},
{
"$ref": "#/components/schemas/update_github_issue_task_params"
},
{
"$ref": "#/components/schemas/update_gitlab_issue_task_params"
},
{
"$ref": "#/components/schemas/update_incident_task_params"
},
{
"$ref": "#/components/schemas/update_incident_postmortem_task_params"
},
{
"$ref": "#/components/schemas/update_jira_issue_task_params"
},
{
"$ref": "#/components/schemas/update_linear_issue_task_params"
},
{
"$ref": "#/components/schemas/update_service_now_incident_task_params"
},
{
"$ref": "#/components/schemas/update_shortcut_story_task_params"
},
{
"$ref": "#/components/schemas/update_shortcut_task_task_params"
},
{
"$ref": "#/components/schemas/update_slack_channel_topic_task_params"
},
{
"$ref": "#/components/schemas/update_status_task_params"
},
{
"$ref": "#/components/schemas/update_incident_status_timestamp_task_params"
},
{
"$ref": "#/components/schemas/update_trello_card_task_params"
},
{
"$ref": "#/components/schemas/update_clickup_task_task_params"
},
{
"$ref": "#/components/schemas/update_motion_task_task_params"
},
{
"$ref": "#/components/schemas/update_zendesk_ticket_task_params"
},
{
"$ref": "#/components/schemas/update_attached_alerts_task_params"
},
{
"$ref": "#/components/schemas/trigger_workflow_task_params"
},
{
"$ref": "#/components/schemas/send_slack_blocks_task_params"
},
{
"$ref": "#/components/schemas/create_openai_chat_completion_task_params"
},
{
"$ref": "#/components/schemas/create_watsonx_chat_completion_task_params"
},
{
"$ref": "#/components/schemas/create_google_gemini_chat_completion_task_params"
},
{
"$ref": "#/components/schemas/create_mistral_chat_completion_task_params"
},
{
"$ref": "#/components/schemas/create_anthropic_chat_completion_task_params"
}
]
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"workflow_task": {
"type": "object",
"properties": {
"workflow_id": {
"type": "string",
"description": "The ID of the parent workflow"
},
"task_params": {
"oneOf": [
{
"$ref": "#/components/schemas/add_action_item_task_params"
},
{
"$ref": "#/components/schemas/update_action_item_task_params"
},
{
"$ref": "#/components/schemas/add_role_task_params"
},
{
"$ref": "#/components/schemas/add_slack_bookmark_task_params"
},
{
"$ref": "#/components/schemas/add_team_task_params"
},
{
"$ref": "#/components/schemas/add_to_timeline_task_params"
},
{
"$ref": "#/components/schemas/archive_slack_channels_task_params"
},
{
"$ref": "#/components/schemas/attach_datadog_dashboards_task_params"
},
{
"$ref": "#/components/schemas/auto_assign_role_opsgenie_task_params"
},
{
"$ref": "#/components/schemas/auto_assign_role_rootly_task_params"
},
{
"$ref": "#/components/schemas/auto_assign_role_pagerduty_task_params"
},
{
"$ref": "#/components/schemas/update_pagerduty_incident_task_params"
},
{
"$ref": "#/components/schemas/create_pagerduty_status_update_task_params"
},
{
"$ref": "#/components/schemas/create_pagertree_alert_task_params"
},
{
"$ref": "#/components/schemas/update_pagertree_alert_task_params"
},
{
"$ref": "#/components/schemas/auto_assign_role_victor_ops_task_params"
},
{
"$ref": "#/components/schemas/call_people_task_params"
},
{
"$ref": "#/components/schemas/create_airtable_table_record_task_params"
},
{
"$ref": "#/components/schemas/create_asana_subtask_task_params"
},
{
"$ref": "#/components/schemas/create_asana_task_task_params"
},
{
"$ref": "#/components/schemas/create_confluence_page_task_params"
},
{
"$ref": "#/components/schemas/create_datadog_notebook_task_params"
},
{
"$ref": "#/components/schemas/create_coda_page_task_params"
},
{
"$ref": "#/components/schemas/create_dropbox_paper_page_task_params"
},
{
"$ref": "#/components/schemas/create_github_issue_task_params"
},
{
"$ref": "#/components/schemas/create_gitlab_issue_task_params"
},
{
"$ref": "#/components/schemas/create_outlook_event_task_params"
},
{
"$ref": "#/components/schemas/create_google_calendar_event_task_params"
},
{
"$ref": "#/components/schemas/update_google_docs_page_task_params"
},
{
"$ref": "#/components/schemas/update_coda_page_task_params"
},
{
"$ref": "#/components/schemas/update_google_calendar_event_task_params"
},
{
"$ref": "#/components/schemas/create_sharepoint_page_task_params"
},
{
"$ref": "#/components/schemas/create_google_docs_page_task_params"
},
{
"$ref": "#/components/schemas/create_google_docs_permissions_task_params"
},
{
"$ref": "#/components/schemas/remove_google_docs_permissions_task_params"
},
{
"$ref": "#/components/schemas/create_quip_page_task_params"
},
{
"$ref": "#/components/schemas/create_google_meeting_task_params"
},
{
"$ref": "#/components/schemas/create_go_to_meeting_task_params"
},
{
"$ref": "#/components/schemas/create_incident_task_params"
},
{
"$ref": "#/components/schemas/create_sub_incident_task_params"
},
{
"$ref": "#/components/schemas/create_incident_postmortem_task_params"
},
{
"$ref": "#/components/schemas/create_jira_issue_task_params"
},
{
"$ref": "#/components/schemas/create_jira_subtask_task_params"
},
{
"$ref": "#/components/schemas/create_linear_issue_task_params"
},
{
"$ref": "#/components/schemas/create_linear_subtask_issue_task_params"
},
{
"$ref": "#/components/schemas/create_linear_issue_comment_task_params"
},
{
"$ref": "#/components/schemas/create_microsoft_teams_meeting_task_params"
},
{
"$ref": "#/components/schemas/create_microsoft_teams_channel_task_params"
},
{
"$ref": "#/components/schemas/create_microsoft_teams_chat_task_params"
},
{
"$ref": "#/components/schemas/add_microsoft_teams_tab_task_params"
},
{
"$ref": "#/components/schemas/add_microsoft_teams_chat_tab_task_params"
},
{
"$ref": "#/components/schemas/create_google_chat_space_task_params"
},
{
"$ref": "#/components/schemas/send_google_chat_message_task_params"
},
{
"$ref": "#/components/schemas/send_google_chat_attachments_task_params"
},
{
"$ref": "#/components/schemas/invite_to_google_chat_space_task_params"
},
{
"$ref": "#/components/schemas/archive_google_chat_spaces_task_params"
},
{
"$ref": "#/components/schemas/rename_google_chat_space_task_params"
},
{
"$ref": "#/components/schemas/update_google_chat_space_description_task_params"
},
{
"$ref": "#/components/schemas/change_google_chat_space_privacy_task_params"
},
{
"$ref": "#/components/schemas/archive_microsoft_teams_channels_task_params"
},
{
"$ref": "#/components/schemas/rename_microsoft_teams_channel_task_params"
},
{
"$ref": "#/components/schemas/invite_to_microsoft_teams_channel_task_params"
},
{
"$ref": "#/components/schemas/create_notion_page_task_params"
},
{
"$ref": "#/components/schemas/send_microsoft_teams_message_task_params"
},
{
"$ref": "#/components/schemas/send_microsoft_teams_chat_message_task_params"
},
{
"$ref": "#/components/schemas/send_microsoft_teams_blocks_task_params"
},
{
"$ref": "#/components/schemas/update_notion_page_task_params"
},
{
"$ref": "#/components/schemas/update_quip_page_task_params"
},
{
"$ref": "#/components/schemas/update_confluence_page_task_params"
},
{
"$ref": "#/components/schemas/update_sharepoint_page_task_params"
},
{
"$ref": "#/components/schemas/update_dropbox_paper_page_task_params"
},
{
"$ref": "#/components/schemas/update_datadog_notebook_task_params"
},
{
"$ref": "#/components/schemas/create_service_now_incident_task_params"
},
{
"$ref": "#/components/schemas/create_shortcut_story_task_params"
},
{
"$ref": "#/components/schemas/create_shortcut_task_task_params"
},
{
"$ref": "#/components/schemas/create_trello_card_task_params"
},
{
"$ref": "#/components/schemas/create_webex_meeting_task_params"
},
{
"$ref": "#/components/schemas/create_zendesk_ticket_task_params"
},
{
"$ref": "#/components/schemas/create_zendesk_jira_link_task_params"
},
{
"$ref": "#/components/schemas/create_clickup_task_task_params"
},
{
"$ref": "#/components/schemas/create_motion_task_task_params"
},
{
"$ref": "#/components/schemas/create_zoom_meeting_task_params"
},
{
"$ref": "#/components/schemas/get_github_commits_task_params"
},
{
"$ref": "#/components/schemas/get_gitlab_commits_task_params"
},
{
"$ref": "#/components/schemas/get_pulses_task_params"
},
{
"$ref": "#/components/schemas/get_alerts_task_params"
},
{
"$ref": "#/components/schemas/http_client_task_params"
},
{
"$ref": "#/components/schemas/invite_to_slack_channel_opsgenie_task_params"
},
{
"$ref": "#/components/schemas/invite_to_slack_channel_rootly_task_params"
},
{
"$ref": "#/components/schemas/invite_to_microsoft_teams_channel_rootly_task_params"
},
{
"$ref": "#/components/schemas/invite_to_slack_channel_pagerduty_task_params"
},
{
"$ref": "#/components/schemas/invite_to_slack_channel_task_params"
},
{
"$ref": "#/components/schemas/invite_to_slack_channel_victor_ops_task_params"
},
{
"$ref": "#/components/schemas/page_opsgenie_on_call_responders_task_params"
},
{
"$ref": "#/components/schemas/create_opsgenie_alert_task_params"
},
{
"$ref": "#/components/schemas/create_jsmops_alert_task_params"
},
{
"$ref": "#/components/schemas/page_jsmops_on_call_responders_task_params"
},
{
"$ref": "#/components/schemas/update_opsgenie_alert_task_params"
},
{
"$ref": "#/components/schemas/update_opsgenie_incident_task_params"
},
{
"$ref": "#/components/schemas/page_rootly_on_call_responders_task_params"
},
{
"$ref": "#/components/schemas/page_pagerduty_on_call_responders_task_params"
},
{
"$ref": "#/components/schemas/page_victor_ops_on_call_responders_task_params"
},
{
"$ref": "#/components/schemas/update_victor_ops_incident_task_params"
},
{
"$ref": "#/components/schemas/print_task_params"
},
{
"$ref": "#/components/schemas/publish_incident_task_params"
},
{
"$ref": "#/components/schemas/redis_client_task_params"
},
{
"$ref": "#/components/schemas/rename_slack_channel_task_params"
},
{
"$ref": "#/components/schemas/change_slack_channel_privacy_task_params"
},
{
"$ref": "#/components/schemas/run_command_heroku_task_params"
},
{
"$ref": "#/components/schemas/send_email_task_params"
},
{
"$ref": "#/components/schemas/send_dashboard_report_task_params"
},
{
"$ref": "#/components/schemas/create_slack_channel_task_params"
},
{
"$ref": "#/components/schemas/send_slack_message_task_params"
},
{
"$ref": "#/components/schemas/send_sms_task_params"
},
{
"$ref": "#/components/schemas/send_whatsapp_message_task_params"
},
{
"$ref": "#/components/schemas/snapshot_datadog_graph_task_params"
},
{
"$ref": "#/components/schemas/snapshot_grafana_dashboard_task_params"
},
{
"$ref": "#/components/schemas/snapshot_looker_look_task_params"
},
{
"$ref": "#/components/schemas/snapshot_new_relic_graph_task_params"
},
{
"$ref": "#/components/schemas/tweet_twitter_message_task_params"
},
{
"$ref": "#/components/schemas/update_airtable_table_record_task_params"
},
{
"$ref": "#/components/schemas/update_asana_task_task_params"
},
{
"$ref": "#/components/schemas/update_github_issue_task_params"
},
{
"$ref": "#/components/schemas/update_gitlab_issue_task_params"
},
{
"$ref": "#/components/schemas/update_incident_task_params"
},
{
"$ref": "#/components/schemas/update_incident_postmortem_task_params"
},
{
"$ref": "#/components/schemas/update_jira_issue_task_params"
},
{
"$ref": "#/components/schemas/update_linear_issue_task_params"
},
{
"$ref": "#/components/schemas/update_service_now_incident_task_params"
},
{
"$ref": "#/components/schemas/update_shortcut_story_task_params"
},
{
"$ref": "#/components/schemas/update_shortcut_task_task_params"
},
{
"$ref": "#/components/schemas/update_slack_channel_topic_task_params"
},
{
"$ref": "#/components/schemas/update_status_task_params"
},
{
"$ref": "#/components/schemas/update_incident_status_timestamp_task_params"
},
{
"$ref": "#/components/schemas/update_trello_card_task_params"
},
{
"$ref": "#/components/schemas/update_clickup_task_task_params"
},
{
"$ref": "#/components/schemas/update_motion_task_task_params"
},
{
"$ref": "#/components/schemas/update_zendesk_ticket_task_params"
},
{
"$ref": "#/components/schemas/update_attached_alerts_task_params"
},
{
"$ref": "#/components/schemas/trigger_workflow_task_params"
},
{
"$ref": "#/components/schemas/send_slack_blocks_task_params"
},
{
"$ref": "#/components/schemas/create_openai_chat_completion_task_params"
},
{
"$ref": "#/components/schemas/create_watsonx_chat_completion_task_params"
},
{
"$ref": "#/components/schemas/create_google_gemini_chat_completion_task_params"
},
{
"$ref": "#/components/schemas/create_mistral_chat_completion_task_params"
},
{
"$ref": "#/components/schemas/create_anthropic_chat_completion_task_params"
}
]
},
"name": {
"type": "string",
"description": "Name of the workflow task"
},
"position": {
"type": "integer",
"description": "The position of the workflow task"
},
"skip_on_failure": {
"type": "boolean",
"description": "Skip workflow task if any failures"
},
"enabled": {
"type": "boolean",
"description": "Enable/disable workflow task",
"default": true
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"workflow_id",
"task_params",
"position",
"skip_on_failure",
"enabled",
"created_at",
"updated_at"
]
},
"workflow_task_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the workflow task"
},
"type": {
"type": "string",
"enum": [
"workflow_tasks"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/workflow_task"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"workflow_task_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the workflow task"
},
"type": {
"type": "string",
"enum": [
"workflow_tasks"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/workflow_task"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_workflow_action_item_form_field_condition": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"workflow_action_item_form_field_conditions"
]
},
"attributes": {
"type": "object",
"properties": {
"form_field_id": {
"type": "string",
"description": "The custom field for this condition"
},
"action_item_condition": {
"type": "string",
"description": "The trigger condition",
"enum": [
"IS",
"IS NOT",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"values": {
"type": "array",
"items": {
"type": "string",
"description": "The value to associate with the custom field trigger"
}
},
"selected_catalog_entity_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected catalog entities for select and multi_select kinds"
}
},
"selected_functionality_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected functionalities for select and multi_select kinds"
}
},
"selected_group_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected groups (teams) for select and multi_select kinds"
}
},
"selected_option_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected option id for select and multi_select kinds"
}
},
"selected_service_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected services for select and multi_select kinds"
}
},
"selected_user_ids": {
"type": "array",
"items": {
"type": "integer",
"description": "The selected user id for select and multi_select kinds"
}
},
"selected_cause_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected causes for select and multi_select kinds"
}
},
"selected_environment_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected environments for select and multi_select kinds"
}
},
"selected_incident_type_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected incident types for select and multi_select kinds"
}
}
},
"additionalProperties": false,
"required": [
"action_item_condition",
"form_field_id"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_workflow_action_item_form_field_condition": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"workflow_action_item_form_field_conditions"
]
},
"attributes": {
"type": "object",
"properties": {
"action_item_condition": {
"type": "string",
"description": "The trigger condition",
"enum": [
"IS",
"IS NOT",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"values": {
"type": "array",
"items": {
"type": "string",
"description": "The value to associate with the custom field trigger"
}
},
"selected_catalog_entity_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected catalog entities for select and multi_select kinds"
}
},
"selected_functionality_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected functionalities for select and multi_select kinds"
}
},
"selected_group_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected groups (teams) for select and multi_select kinds"
}
},
"selected_option_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected option id for select and multi_select kinds"
}
},
"selected_service_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected services for select and multi_select kinds"
}
},
"selected_user_ids": {
"type": "array",
"items": {
"type": "integer",
"description": "The selected user id for select and multi_select kinds"
}
},
"selected_cause_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected causes for select and multi_select kinds"
}
},
"selected_environment_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected environments for select and multi_select kinds"
}
},
"selected_incident_type_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected incident types for select and multi_select kinds"
}
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"workflow_action_item_form_field_condition": {
"type": "object",
"properties": {
"workflow_id": {
"type": "string",
"description": "The workflow for this condition"
},
"form_field_id": {
"type": "string",
"description": "The custom field for this condition"
},
"action_item_condition": {
"type": "string",
"description": "The trigger condition",
"enum": [
"IS",
"IS NOT",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"values": {
"type": "array",
"items": {
"type": "string",
"description": "The value to associate with the custom field trigger"
}
},
"selected_catalog_entity_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected catalog entities for select and multi_select kinds"
}
},
"selected_functionality_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected functionalities for select and multi_select kinds"
}
},
"selected_group_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected groups (teams) for select and multi_select kinds"
}
},
"selected_option_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected option id for select and multi_select kinds"
}
},
"selected_service_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected services for select and multi_select kinds"
}
},
"selected_user_ids": {
"type": "array",
"items": {
"type": "integer",
"description": "The selected user id for select and multi_select kinds"
}
},
"selected_cause_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected causes for select and multi_select kinds"
}
},
"selected_environment_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected environments for select and multi_select kinds"
}
},
"selected_incident_type_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected incident types for select and multi_select kinds"
}
}
},
"required": [
"workflow_id",
"form_field_id",
"action_item_condition",
"selected_catalog_entity_ids",
"selected_option_ids",
"selected_user_ids"
]
},
"workflow_action_item_form_field_condition_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the workflow_action_item_form_field_condition"
},
"type": {
"type": "string",
"enum": [
"workflow_action_item_form_field_conditions"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/workflow_action_item_form_field_condition"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"workflow_action_item_form_field_condition_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the workflow_action_item_form_field_condition"
},
"type": {
"type": "string",
"enum": [
"workflow_action_item_form_field_conditions"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/workflow_action_item_form_field_condition"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_workflow_custom_field_selection": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"workflow_custom_field_selections"
]
},
"attributes": {
"type": "object",
"properties": {
"workflow_id": {
"type": "string",
"description": "The workflow for this selection"
},
"custom_field_id": {
"type": "integer",
"description": "The custom field for this selection"
},
"incident_condition": {
"type": "string",
"description": "The trigger condition",
"enum": [
"IS",
"IS NOT",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"values": {
"type": "array",
"items": {
"type": "string",
"description": "The value to associate with the custom field trigger"
}
},
"selected_option_ids": {
"type": "array",
"items": {
"type": "integer",
"description": "The selected option id for select and multi_select kinds"
}
}
},
"additionalProperties": false,
"required": [
"incident_condition",
"custom_field_id"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_workflow_custom_field_selection": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"workflow_custom_field_selections"
]
},
"attributes": {
"type": "object",
"properties": {
"incident_condition": {
"type": "string",
"description": "The trigger condition",
"enum": [
"IS",
"IS NOT",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"values": {
"type": "array",
"items": {
"type": "string",
"description": "The value to associate with the custom field trigger"
}
},
"selected_option_ids": {
"type": "array",
"items": {
"type": "integer",
"description": "The selected option id for select and multi_select kinds"
}
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"workflow_custom_field_selection": {
"type": "object",
"properties": {
"workflow_id": {
"type": "string",
"description": "The workflow for this selection"
},
"custom_field_id": {
"type": "integer",
"description": "The custom field for this selection"
},
"incident_condition": {
"type": "string",
"description": "The trigger condition",
"enum": [
"IS",
"IS NOT",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"values": {
"type": "array",
"items": {
"type": "string",
"description": "The value to associate with the custom field trigger"
}
},
"selected_option_ids": {
"type": "array",
"items": {
"type": "integer",
"description": "The selected option id for select and multi_select kinds"
}
}
},
"required": [
"workflow_id",
"custom_field_id",
"incident_condition",
"selected_option_ids"
]
},
"workflow_custom_field_selection_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the workflow_custom_field_selection"
},
"type": {
"type": "string",
"enum": [
"workflow_custom_field_selections"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/workflow_custom_field_selection"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"workflow_custom_field_selection_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the workflow_custom_field_selection"
},
"type": {
"type": "string",
"enum": [
"workflow_custom_field_selections"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/workflow_custom_field_selection"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_workflow_form_field_condition": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"workflow_form_field_conditions"
]
},
"attributes": {
"type": "object",
"properties": {
"workflow_id": {
"type": "string",
"description": "The workflow for this condition"
},
"form_field_id": {
"type": "string",
"description": "The custom field for this condition"
},
"incident_condition": {
"type": "string",
"description": "The trigger condition",
"enum": [
"IS",
"IS NOT",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"values": {
"type": "array",
"items": {
"type": "string",
"description": "The value to associate with the custom field trigger"
}
},
"selected_catalog_entity_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected catalog entities for select and multi_select kinds"
}
},
"selected_functionality_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected functionalities for select and multi_select kinds"
}
},
"selected_group_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected groups (teams) for select and multi_select kinds"
}
},
"selected_option_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected option id for select and multi_select kinds"
}
},
"selected_service_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected services for select and multi_select kinds"
}
},
"selected_user_ids": {
"type": "array",
"items": {
"type": "integer",
"description": "The selected user id for select and multi_select kinds"
}
},
"selected_cause_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected causes for select and multi_select kinds"
}
},
"selected_environment_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected environments for select and multi_select kinds"
}
},
"selected_incident_type_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected incident types for select and multi_select kinds"
}
}
},
"additionalProperties": false,
"required": [
"incident_condition",
"form_field_id"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_workflow_form_field_condition": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"workflow_form_field_conditions"
]
},
"attributes": {
"type": "object",
"properties": {
"incident_condition": {
"type": "string",
"description": "The trigger condition",
"enum": [
"IS",
"IS NOT",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"values": {
"type": "array",
"items": {
"type": "string",
"description": "The value to associate with the custom field trigger"
}
},
"selected_catalog_entity_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected catalog entities for select and multi_select kinds"
}
},
"selected_functionality_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected functionalities for select and multi_select kinds"
}
},
"selected_group_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected groups (teams) for select and multi_select kinds"
}
},
"selected_option_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected option id for select and multi_select kinds"
}
},
"selected_service_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected services for select and multi_select kinds"
}
},
"selected_user_ids": {
"type": "array",
"items": {
"type": "integer",
"description": "The selected user id for select and multi_select kinds"
}
},
"selected_cause_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected causes for select and multi_select kinds"
}
},
"selected_environment_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected environments for select and multi_select kinds"
}
},
"selected_incident_type_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected incident types for select and multi_select kinds"
}
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"workflow_form_field_condition": {
"type": "object",
"properties": {
"workflow_id": {
"type": "string",
"description": "The workflow for this condition"
},
"form_field_id": {
"type": "string",
"description": "The custom field for this condition"
},
"incident_condition": {
"type": "string",
"description": "The trigger condition",
"enum": [
"IS",
"IS NOT",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"values": {
"type": "array",
"items": {
"type": "string",
"description": "The value to associate with the custom field trigger"
}
},
"selected_catalog_entity_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected catalog entities for select and multi_select kinds"
}
},
"selected_functionality_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected functionalities for select and multi_select kinds"
}
},
"selected_group_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected groups (teams) for select and multi_select kinds"
}
},
"selected_option_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected option id for select and multi_select kinds"
}
},
"selected_service_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected services for select and multi_select kinds"
}
},
"selected_user_ids": {
"type": "array",
"items": {
"type": "integer",
"description": "The selected user id for select and multi_select kinds"
}
},
"selected_cause_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected causes for select and multi_select kinds"
}
},
"selected_environment_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected environments for select and multi_select kinds"
}
},
"selected_incident_type_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected incident types for select and multi_select kinds"
}
}
},
"required": [
"workflow_id",
"form_field_id",
"incident_condition",
"selected_catalog_entity_ids",
"selected_option_ids",
"selected_user_ids"
]
},
"workflow_form_field_condition_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the workflow_form_field_condition"
},
"type": {
"type": "string",
"enum": [
"workflow_form_field_conditions"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/workflow_form_field_condition"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"workflow_form_field_condition_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the workflow_form_field_condition"
},
"type": {
"type": "string",
"enum": [
"workflow_form_field_conditions"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/workflow_form_field_condition"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_workflow_group": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"workflow_groups"
]
},
"attributes": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "The kind of the workflow group",
"enum": [
"simple",
"incident",
"post_mortem",
"action_item",
"pulse",
"alert"
],
"nullable": true
},
"name": {
"type": "string",
"description": "The name of the workflow group."
},
"description": {
"type": "string",
"description": "A description of the workflow group.",
"nullable": true
},
"icon": {
"type": "string",
"description": "An emoji icon displayed next to the workflow group."
},
"expanded": {
"type": "boolean",
"description": "Whether the group is expanded or collapsed."
},
"position": {
"type": "integer",
"description": "The position of the workflow group"
}
},
"required": [
"name"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_workflow_group": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"workflow_groups"
]
},
"attributes": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "The kind of the workflow group",
"enum": [
"simple",
"incident",
"post_mortem",
"action_item",
"pulse",
"alert"
],
"nullable": true
},
"name": {
"type": "string",
"description": "The name of the workflow group."
},
"description": {
"type": "string",
"description": "A description of the workflow group.",
"nullable": true
},
"icon": {
"type": "string",
"description": "An emoji icon displayed next to the workflow group."
},
"expanded": {
"type": "boolean",
"description": "Whether the group is expanded or collapsed."
},
"position": {
"type": "integer",
"description": "The position of the workflow group"
}
}
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"workflow_group": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "The kind of the workflow group",
"enum": [
"simple",
"incident",
"post_mortem",
"action_item",
"pulse",
"alert"
],
"nullable": true
},
"name": {
"type": "string",
"description": "The name of the workflow group."
},
"slug": {
"type": "string",
"description": "The slug of the workflow group."
},
"description": {
"type": "string",
"description": "A description of the workflow group.",
"nullable": true
},
"icon": {
"type": "string",
"description": "An emoji icon displayed next to the workflow group."
},
"expanded": {
"type": "boolean",
"description": "Whether the group is expanded or collapsed."
},
"position": {
"type": "integer",
"description": "The position of the workflow group"
}
},
"required": [
"name",
"position"
]
},
"workflow_group_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the workflow group"
},
"type": {
"type": "string",
"enum": [
"workflow_groups"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/workflow_group"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"workflow_group_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the workflow group"
},
"type": {
"type": "string",
"enum": [
"workflow_groups"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/workflow_group"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_workflow_run": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"workflow_runs"
]
},
"attributes": {
"type": "object",
"anyOf": [
{
"properties": {
"immediate": {
"type": "boolean",
"nullable": true,
"default": true,
"description": "If false, this will respect wait time configured on the workflow."
},
"check_conditions": {
"type": "boolean",
"nullable": true,
"default": false,
"description": "If true, this will check conditions. If conditions are not satisfied the run will not be created."
},
"context": {
"type": "object",
"additionalProperties": true
}
}
},
{
"properties": {
"incident_id": {
"type": "string"
},
"immediate": {
"type": "boolean",
"nullable": true,
"default": true,
"description": "If false, this will respect wait time configured on the workflow"
},
"check_conditions": {
"type": "boolean",
"nullable": true,
"default": false,
"description": "If true, this will check conditions. If conditions are not satisfied the run will not be created"
},
"context": {
"type": "object",
"additionalProperties": true
}
},
"required": [
"incident_id"
]
},
{
"properties": {
"post_mortem_id": {
"type": "string"
},
"immediate": {
"type": "boolean",
"nullable": true,
"default": true,
"description": "If false, this will respect wait time configured on the workflow"
},
"check_conditions": {
"type": "boolean",
"nullable": true,
"default": false,
"description": "If true, this will check conditions. If conditions are not satisfied the run will not be created"
},
"context": {
"type": "object",
"additionalProperties": true
}
},
"required": [
"post_mortem_id"
]
},
{
"properties": {
"action_item_id": {
"type": "string"
},
"immediate": {
"type": "boolean",
"nullable": true,
"default": true,
"description": "If false, this will respect wait time configured on the workflow"
},
"check_conditions": {
"type": "boolean",
"nullable": true,
"default": false,
"description": "If true, this will check conditions. If conditions are not satisfied the run will not be created"
},
"context": {
"type": "object",
"additionalProperties": true
}
},
"required": [
"action_item_id"
]
},
{
"properties": {
"alert_id": {
"type": "string"
},
"immediate": {
"type": "boolean",
"nullable": true,
"default": true,
"description": "If false, this will respect wait time configured on the workflow"
},
"check_conditions": {
"type": "boolean",
"nullable": true,
"default": false,
"description": "If true, this will check conditions. If conditions are not satisfied the run will not be created"
},
"context": {
"type": "object",
"additionalProperties": true
}
},
"required": [
"alert_id"
]
},
{
"properties": {
"pulse_id": {
"type": "string"
},
"immediate": {
"type": "boolean",
"nullable": true,
"default": true,
"description": "If false, this will respect wait time configured on the workflow"
},
"check_conditions": {
"type": "boolean",
"nullable": true,
"default": false,
"description": "If true, this will check conditions. If conditions are not satisfied the run will not be created"
},
"context": {
"type": "object",
"additionalProperties": true
}
},
"required": [
"pulse_id"
]
}
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"workflow_run": {
"type": "object",
"properties": {
"workflow_id": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"queued",
"started",
"completed",
"completed_with_errors",
"failed",
"canceled"
]
},
"status_message": {
"type": "string",
"nullable": true
},
"triggered_by": {
"type": "string",
"enum": [
"system",
"user",
"workflow"
]
},
"started_at": {
"type": "string",
"nullable": true
},
"completed_at": {
"type": "string",
"nullable": true
},
"failed_at": {
"type": "string",
"nullable": true
},
"canceled_at": {
"type": "string",
"nullable": true
},
"incident_id": {
"type": "string",
"nullable": true
},
"post_mortem_id": {
"type": "string",
"nullable": true
},
"action_item_id": {
"type": "string",
"nullable": true
},
"alert_id": {
"type": "string",
"nullable": true
},
"pulse_id": {
"type": "string",
"nullable": true
},
"context": {
"type": "object",
"additionalProperties": true
}
},
"required": [
"status",
"triggered_by",
"workflow_id"
]
},
"workflow_run_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the workflow run"
},
"type": {
"type": "string",
"enum": [
"workflow_runs"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/workflow_run"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"workflow_runs_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the workflow run"
},
"type": {
"type": "string",
"enum": [
"workflow_runs"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/workflow_run"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_workflow": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"workflows"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The title of the workflow"
},
"description": {
"type": "string",
"description": "The description of the workflow",
"nullable": true
},
"command": {
"type": "string",
"description": "Workflow command",
"nullable": true
},
"command_feedback_enabled": {
"type": "boolean",
"description": "This will notify you back when the workflow is starting",
"nullable": true
},
"wait": {
"type": "string",
"description": "Wait this duration before executing",
"nullable": true
},
"priority": {
"type": "string",
"description": "Priority",
"enum": [
"low",
"normal",
"high"
],
"nullable": true
},
"repeat_every_duration": {
"type": "string",
"description": "Repeat workflow every duration",
"nullable": true
},
"repeat_condition_duration_since_first_run": {
"type": "string",
"description": "The workflow will stop repeating if its runtime since it's first workflow run exceeds the duration set in this field",
"nullable": true
},
"repeat_condition_number_of_repeats": {
"type": "integer",
"description": "The workflow will stop repeating if the number of repeats exceeds the value set in this field"
},
"continuously_repeat": {
"type": "boolean",
"description": "When continuously repeat is true, repeat workflows aren't automatically stopped when conditions aren't met. This setting won't override your conditions set by repeat_condition_duration_since_first_run and repeat_condition_number_of_repeats parameters."
},
"repeat_on": {
"type": "array",
"items": {
"type": "string",
"description": "Repeat on weekdays",
"enum": [
"S",
"M",
"T",
"W",
"R",
"F",
"U"
]
}
},
"enabled": {
"type": "boolean"
},
"locked": {
"type": "boolean",
"description": "Restricts workflow edits to admins when turned on. Only admins can set this field."
},
"position": {
"type": "integer",
"description": "The order which the workflow should run with other workflows."
},
"workflow_group_id": {
"type": "string",
"description": "The group this workflow belongs to.",
"nullable": true
},
"trigger_params": {
"oneOf": [
{
"$ref": "#/components/schemas/incident_trigger_params"
},
{
"$ref": "#/components/schemas/action_item_trigger_params"
},
{
"$ref": "#/components/schemas/alert_trigger_params"
},
{
"$ref": "#/components/schemas/pulse_trigger_params"
},
{
"$ref": "#/components/schemas/simple_trigger_params"
}
]
},
"environment_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"severity_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"incident_type_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"incident_role_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"service_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"functionality_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"group_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"cause_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"sub_status_ids": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"incident_trigger_params": {
"type": "object",
"properties": {
"trigger_type": {
"type": "string",
"enum": [
"incident"
]
},
"triggers": {
"type": "array",
"items": {
"type": "string",
"description": "Actions that trigger the workflow. One of custom_fields..updated, incident_in_triage, incident_created, incident_started, incident_updated, title_updated, summary_updated, status_updated, severity_updated, environments_added, environments_removed, environments_updated, incident_types_added, incident_types_removed, incident_types_updated, services_added, services_removed, services_updated, visibility_updated, functionalities_added, functionalities_removed, functionalities_updated, teams_added, teams_removed, teams_updated, causes_added, causes_removed, causes_updated, timeline_updated, status_page_timeline_updated, role_assignments_updated, role_assignments_added, role_assignments_removed, slack_command, slack_channel_created, slack_channel_converted, microsoft_teams_channel_created, microsoft_teams_chat_created, google_chat_space_created, subscribers_updated, subscribers_added, subscribers_removed, user_joined_slack_channel, user_left_slack_channel, meeting_summary_created"
}
},
"incident_visibilities": {
"type": "array",
"items": {
"type": "boolean"
}
},
"incident_kinds": {
"type": "array",
"items": {
"type": "string",
"enum": [
"test",
"test_sub",
"example",
"example_sub",
"normal",
"normal_sub",
"backfilled",
"scheduled",
"scheduled_sub"
]
}
},
"incident_statuses": {
"type": "array",
"items": {
"type": "string",
"enum": [
"in_triage",
"started",
"detected",
"acknowledged",
"mitigated",
"resolved",
"closed",
"cancelled",
"scheduled",
"in_progress",
"completed"
]
}
},
"incident_inactivity_duration": {
"type": "string",
"description": "ex. 10 min, 1h, 3 days, 2 weeks",
"nullable": true
},
"incident_condition": {
"type": "string",
"enum": [
"ALL",
"ANY",
"NONE"
],
"default": "ALL"
},
"incident_condition_visibility": {
"type": "string",
"enum": [
"IS",
"IS NOT",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_condition_kind": {
"type": "string",
"enum": [
"IS",
"IS NOT",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "IS"
},
"incident_condition_status": {
"type": "string",
"enum": [
"IS",
"IS NOT",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_condition_sub_status": {
"type": "string",
"enum": [
"IS",
"IS NOT",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_condition_environment": {
"type": "string",
"enum": [
"IS",
"IS NOT",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_condition_severity": {
"type": "string",
"enum": [
"IS",
"IS NOT",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_condition_incident_type": {
"type": "string",
"enum": [
"IS",
"IS NOT",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_condition_incident_roles": {
"type": "string",
"enum": [
"IS",
"IS NOT",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_condition_service": {
"type": "string",
"enum": [
"IS",
"IS NOT",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_condition_functionality": {
"type": "string",
"enum": [
"IS",
"IS NOT",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_condition_group": {
"type": "string",
"enum": [
"IS",
"IS NOT",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_condition_cause": {
"type": "string",
"enum": [
"IS",
"IS NOT",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_post_mortem_condition_cause": {
"type": "string",
"enum": [
"IS",
"IS NOT",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY",
"description": "[DEPRECATED] Use incident_condition_cause instead"
},
"incident_condition_summary": {
"type": "string",
"enum": [
"SET",
"UNSET"
],
"nullable": true
},
"incident_condition_started_at": {
"type": "string",
"enum": [
"SET",
"UNSET"
],
"nullable": true
},
"incident_condition_detected_at": {
"type": "string",
"enum": [
"SET",
"UNSET"
],
"nullable": true
},
"incident_condition_acknowledged_at": {
"type": "string",
"enum": [
"SET",
"UNSET"
],
"nullable": true
},
"incident_condition_mitigated_at": {
"type": "string",
"enum": [
"SET",
"UNSET"
],
"nullable": true
},
"incident_condition_resolved_at": {
"type": "string",
"enum": [
"SET",
"UNSET"
],
"nullable": true
},
"incident_conditional_inactivity": {
"type": "string",
"enum": [
"IS"
],
"nullable": true
}
},
"required": [
"trigger_type"
]
},
"post_mortem_trigger_params": {
"type": "object",
"properties": {
"trigger_type": {
"type": "string",
"enum": [
"post_mortem"
]
},
"triggers": {
"type": "array",
"items": {
"type": "string",
"description": "Actions that trigger the workflow. One of custom_fields..updated, post_mortem_created, post_mortem_updated, status_updated, slack_command"
}
},
"incident_visibilities": {
"type": "array",
"items": {
"type": "boolean"
}
},
"incident_kinds": {
"type": "array",
"items": {
"type": "string",
"enum": [
"test",
"test_sub",
"example",
"example_sub",
"normal",
"normal_sub",
"backfilled",
"scheduled",
"scheduled_sub"
]
}
},
"incident_statuses": {
"type": "array",
"items": {
"type": "string",
"enum": [
"in_triage",
"started",
"detected",
"acknowledged",
"mitigated",
"resolved",
"closed",
"cancelled",
"scheduled",
"in_progress",
"completed"
]
}
},
"incident_inactivity_duration": {
"type": "string",
"description": "ex. 10 min, 1h, 3 days, 2 weeks",
"nullable": true
},
"incident_condition": {
"type": "string",
"enum": [
"ALL",
"ANY",
"NONE"
],
"default": "ALL"
},
"incident_condition_visibility": {
"type": "string",
"enum": [
"IS",
"IS NOT",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_condition_kind": {
"type": "string",
"enum": [
"IS",
"IS NOT",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "IS"
},
"incident_condition_status": {
"type": "string",
"enum": [
"IS",
"IS NOT",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_condition_sub_status": {
"type": "string",
"enum": [
"IS",
"IS NOT",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_condition_environment": {
"type": "string",
"enum": [
"IS",
"IS NOT",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_condition_severity": {
"type": "string",
"enum": [
"IS",
"IS NOT",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_condition_incident_type": {
"type": "string",
"enum": [
"IS",
"IS NOT",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_condition_incident_roles": {
"type": "string",
"enum": [
"IS",
"IS NOT",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_condition_service": {
"type": "string",
"enum": [
"IS",
"IS NOT",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_condition_functionality": {
"type": "string",
"enum": [
"IS",
"IS NOT",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_condition_group": {
"type": "string",
"enum": [
"IS",
"IS NOT",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_condition_cause": {
"type": "string",
"enum": [
"IS",
"IS NOT",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_post_mortem_condition_cause": {
"type": "string",
"enum": [
"IS",
"IS NOT",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY",
"description": "[DEPRECATED] Use incident_condition_cause instead"
},
"incident_condition_summary": {
"type": "string",
"enum": [
"SET",
"UNSET"
],
"nullable": true
},
"incident_condition_started_at": {
"type": "string",
"enum": [
"SET",
"UNSET"
],
"nullable": true
},
"incident_condition_detected_at": {
"type": "string",
"enum": [
"SET",
"UNSET"
],
"nullable": true
},
"incident_condition_acknowledged_at": {
"type": "string",
"enum": [
"SET",
"UNSET"
],
"nullable": true
},
"incident_condition_mitigated_at": {
"type": "string",
"enum": [
"SET",
"UNSET"
],
"nullable": true
},
"incident_condition_resolved_at": {
"type": "string",
"enum": [
"SET",
"UNSET"
],
"nullable": true
},
"incident_conditional_inactivity": {
"type": "string",
"enum": [
"IS"
],
"nullable": true
},
"incident_post_mortem_condition": {
"type": "string",
"enum": [
"ALL",
"ANY",
"NONE"
]
},
"incident_post_mortem_condition_status": {
"type": "string",
"enum": [
"IS",
"IS NOT",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_post_mortem_statuses": {
"type": "array",
"items": {
"type": "string",
"enum": [
"draft",
"published"
]
}
}
},
"required": [
"trigger_type"
]
},
"action_item_trigger_params": {
"type": "object",
"properties": {
"trigger_type": {
"type": "string",
"enum": [
"action_item"
]
},
"triggers": {
"type": "array",
"items": {
"type": "string",
"description": "Actions that trigger the workflow. One of custom_fields..updated, incident_updated, action_item_created, action_item_updated, assigned_user_updated, summary_updated, description_updated, status_updated, priority_updated, due_date_updated, teams_updated, slack_command"
}
},
"incident_visibilities": {
"type": "array",
"items": {
"type": "boolean"
}
},
"incident_kinds": {
"type": "array",
"items": {
"type": "string",
"enum": [
"test",
"test_sub",
"example",
"example_sub",
"normal",
"normal_sub",
"backfilled",
"scheduled",
"scheduled_sub"
]
}
},
"incident_statuses": {
"type": "array",
"items": {
"type": "string",
"enum": [
"in_triage",
"started",
"detected",
"acknowledged",
"mitigated",
"resolved",
"closed",
"cancelled",
"scheduled",
"in_progress",
"completed"
]
}
},
"incident_inactivity_duration": {
"type": "string",
"description": "ex. 10 min, 1h, 3 days, 2 weeks",
"nullable": true
},
"incident_condition": {
"type": "string",
"enum": [
"ALL",
"ANY",
"NONE"
],
"default": "ALL"
},
"incident_condition_visibility": {
"type": "string",
"enum": [
"IS",
"IS NOT",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_condition_kind": {
"type": "string",
"enum": [
"IS",
"IS NOT",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "IS"
},
"incident_condition_status": {
"type": "string",
"enum": [
"IS",
"IS NOT",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_condition_sub_status": {
"type": "string",
"enum": [
"IS",
"IS NOT",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_condition_environment": {
"type": "string",
"enum": [
"IS",
"IS NOT",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_condition_severity": {
"type": "string",
"enum": [
"IS",
"IS NOT",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_condition_incident_type": {
"type": "string",
"enum": [
"IS",
"IS NOT",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_condition_incident_roles": {
"type": "string",
"enum": [
"IS",
"IS NOT",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_condition_service": {
"type": "string",
"enum": [
"IS",
"IS NOT",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_condition_functionality": {
"type": "string",
"enum": [
"IS",
"IS NOT",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_condition_group": {
"type": "string",
"enum": [
"IS",
"IS NOT",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_condition_summary": {
"type": "string",
"enum": [
"SET",
"UNSET"
],
"nullable": true
},
"incident_condition_started_at": {
"type": "string",
"enum": [
"SET",
"UNSET"
],
"nullable": true
},
"incident_condition_detected_at": {
"type": "string",
"enum": [
"SET",
"UNSET"
],
"nullable": true
},
"incident_condition_acknowledged_at": {
"type": "string",
"enum": [
"SET",
"UNSET"
],
"nullable": true
},
"incident_condition_mitigated_at": {
"type": "string",
"enum": [
"SET",
"UNSET"
],
"nullable": true
},
"incident_condition_resolved_at": {
"type": "string",
"enum": [
"SET",
"UNSET"
],
"nullable": true
},
"incident_conditional_inactivity": {
"type": "string",
"enum": [
"IS"
],
"nullable": true
},
"incident_action_item_condition": {
"type": "string",
"enum": [
"ALL",
"ANY",
"NONE"
]
},
"incident_action_item_condition_kind": {
"type": "string",
"enum": [
"IS",
"IS NOT",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_action_item_kinds": {
"type": "array",
"items": {
"type": "string",
"enum": [
"task",
"follow_up"
]
}
},
"incident_action_item_condition_status": {
"type": "string",
"enum": [
"IS",
"IS NOT",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_action_item_statuses": {
"type": "array",
"items": {
"type": "string",
"enum": [
"open",
"in_progress",
"cancelled",
"done"
]
}
},
"incident_action_item_condition_priority": {
"type": "string",
"enum": [
"IS",
"IS NOT",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_action_item_priorities": {
"type": "array",
"items": {
"type": "string",
"enum": [
"high",
"medium",
"low"
]
}
},
"incident_action_item_condition_group": {
"type": "string",
"enum": [
"IS",
"IS NOT",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"incident_action_item_group_ids": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"trigger_type"
]
},
"alert_trigger_params": {
"type": "object",
"properties": {
"trigger_type": {
"type": "string",
"enum": [
"alert"
]
},
"triggers": {
"type": "array",
"items": {
"type": "string",
"description": "Actions that trigger the workflow",
"enum": [
"alert_created",
"alert_status_updated"
]
}
},
"alert_condition": {
"type": "string",
"enum": [
"ALL",
"ANY",
"NONE"
]
},
"alert_condition_source": {
"type": "string",
"enum": [
"IS",
"IS NOT",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"alert_condition_source_use_regexp": {
"type": "boolean",
"default": false
},
"alert_sources": {
"type": "array",
"items": {
"type": "string"
}
},
"alert_condition_label": {
"type": "string",
"enum": [
"IS",
"IS NOT",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"alert_condition_label_use_regexp": {
"type": "boolean",
"default": false
},
"alert_condition_status": {
"type": "string",
"enum": [
"IS",
"IS NOT",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"alert_condition_status_use_regexp": {
"type": "boolean",
"default": false
},
"alert_statuses": {
"type": "array",
"items": {
"type": "string"
}
},
"alert_labels": {
"type": "array",
"items": {
"type": "string"
}
},
"alert_condition_urgency": {
"type": "string",
"enum": [
"IS",
"IS NOT",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"alert_urgency_ids": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
},
"alert_condition_payload": {
"type": "string",
"enum": [
"IS",
"IS NOT",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"alert_condition_payload_use_regexp": {
"type": "boolean",
"default": false
},
"alert_payload": {
"type": "array",
"items": {
"type": "string"
}
},
"alert_query_payload": {
"type": "string",
"description": "You can use jsonpath syntax. eg: $.incident.teams[*]",
"nullable": true
},
"alert_field_conditions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"alert_field_id": {
"type": "string"
},
"condition_type": {
"type": "string",
"enum": [
"IS",
"IS NOT",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
]
},
"values": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"alert_field_id",
"condition_type"
]
}
},
"alert_payload_conditions": {
"type": "object",
"properties": {
"logic": {
"type": "string",
"enum": [
"ALL",
"ANY",
"NONE"
]
},
"conditions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"query": {
"type": "string"
},
"operator": {
"type": "string",
"enum": [
"IS",
"IS NOT",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
]
},
"values": {
"type": "array",
"items": {
"type": "string"
}
},
"use_regexp": {
"type": "boolean"
}
},
"required": [
"query",
"operator"
]
}
}
}
}
},
"required": [
"trigger_type"
]
},
"pulse_trigger_params": {
"type": "object",
"properties": {
"trigger_type": {
"type": "string",
"enum": [
"pulse"
]
},
"triggers": {
"type": "array",
"items": {
"type": "string",
"description": "Actions that trigger the workflow",
"enum": [
"pulse_created"
]
}
},
"pulse_condition": {
"type": "string",
"enum": [
"ALL",
"ANY",
"NONE"
]
},
"pulse_condition_source": {
"type": "string",
"enum": [
"IS",
"IS NOT",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"pulse_condition_source_use_regexp": {
"type": "boolean",
"default": false
},
"pulse_sources": {
"type": "array",
"items": {
"type": "string"
}
},
"pulse_condition_label": {
"type": "string",
"enum": [
"IS",
"IS NOT",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"pulse_condition_label_use_regexp": {
"type": "boolean",
"default": false
},
"pulse_labels": {
"type": "array",
"items": {
"type": "string"
}
},
"pulse_condition_payload": {
"type": "string",
"enum": [
"IS",
"IS NOT",
"ANY",
"CONTAINS",
"CONTAINS_ALL",
"CONTAINS_NONE",
"NONE",
"SET",
"UNSET"
],
"default": "ANY"
},
"pulse_condition_payload_use_regexp": {
"type": "boolean",
"default": false
},
"pulse_payload": {
"type": "array",
"items": {
"type": "string"
}
},
"pulse_query_payload": {
"type": "string",
"description": "You can use jsonpath syntax. eg: $.incident.teams[*]",
"nullable": true
}
},
"required": [
"trigger_type"
]
},
"simple_trigger_params": {
"type": "object",
"properties": {
"trigger_type": {
"type": "string",
"enum": [
"simple"
]
},
"triggers": {
"type": "array",
"items": {
"type": "string",
"description": "Actions that trigger the workflow",
"enum": [
"slack_command"
]
}
}
},
"required": [
"trigger_type"
]
},
"update_workflow": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"workflows"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The title of the workflow"
},
"description": {
"type": "string",
"description": "The description of the workflow",
"nullable": true
},
"command": {
"type": "string",
"description": "Workflow command",
"nullable": true
},
"command_feedback_enabled": {
"type": "boolean",
"description": "This will notify you back when the workflow is starting",
"nullable": true
},
"wait": {
"type": "string",
"description": "Wait this duration before executing",
"nullable": true
},
"repeat_every_duration": {
"type": "string",
"description": "Repeat workflow every duration",
"nullable": true
},
"repeat_condition_duration_since_first_run": {
"type": "string",
"description": "The workflow will stop repeating if its runtime since it's first workflow run exceeds the duration set in this field",
"nullable": true
},
"repeat_condition_number_of_repeats": {
"type": "integer",
"description": "The workflow will stop repeating if the number of repeats exceeds the value set in this field"
},
"continuously_repeat": {
"type": "boolean",
"description": "When continuously repeat is true, repeat workflows aren't automatically stopped when conditions aren't met. This setting won't override your conditions set by repeat_condition_duration_since_first_run and repeat_condition_number_of_repeats parameters."
},
"enabled": {
"type": "boolean"
},
"locked": {
"type": "boolean",
"description": "Restricts workflow edits to admins when turned on. Only admins can set this field."
},
"position": {
"type": "integer",
"description": "The order which the workflow should run with other workflows."
},
"workflow_group_id": {
"type": "string",
"description": "The group this workflow belongs to.",
"nullable": true
},
"trigger_params": {
"oneOf": [
{
"$ref": "#/components/schemas/incident_trigger_params"
},
{
"$ref": "#/components/schemas/action_item_trigger_params"
},
{
"$ref": "#/components/schemas/alert_trigger_params"
},
{
"$ref": "#/components/schemas/pulse_trigger_params"
},
{
"$ref": "#/components/schemas/simple_trigger_params"
}
]
},
"environment_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"severity_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"incident_type_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"incident_role_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"service_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"functionality_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"group_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"cause_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"sub_status_ids": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"workflow": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The title of the workflow"
},
"slug": {
"type": "string",
"description": "The slug of the workflow"
},
"description": {
"type": "string",
"description": "The description of the workflow",
"nullable": true
},
"command": {
"type": "string",
"description": "Workflow command",
"nullable": true
},
"command_feedback_enabled": {
"type": "boolean",
"description": "This will notify you back when the workflow is starting",
"nullable": true
},
"wait": {
"type": "string",
"description": "Wait this duration before executing",
"nullable": true
},
"repeat_every_duration": {
"type": "string",
"description": "Repeat workflow every duration",
"nullable": true
},
"repeat_condition_duration_since_first_run": {
"type": "string",
"description": "The workflow will stop repeating if its runtime since it's first workflow run exceeds the duration set in this field",
"nullable": true
},
"repeat_condition_number_of_repeats": {
"type": "integer",
"description": "The workflow will stop repeating if the number of repeats exceeds the value set in this field"
},
"continuously_repeat": {
"type": "boolean",
"description": "When continuously repeat is true, repeat workflows aren't automatically stopped when conditions aren't met. This setting won't override your conditions set by repeat_condition_duration_since_first_run and repeat_condition_number_of_repeats parameters."
},
"repeat_on": {
"type": "array",
"items": {
"type": "string",
"description": "Repeat on weekdays",
"enum": [
"S",
"M",
"T",
"W",
"R",
"F",
"U"
]
},
"nullable": true
},
"enabled": {
"type": "boolean"
},
"locked": {
"type": "boolean",
"description": "Restricts workflow edits to admins when turned on. Only admins can set this field."
},
"position": {
"type": "integer",
"description": "The order which the workflow should run with other workflows."
},
"workflow_group_id": {
"type": "string",
"description": "The group this workflow belongs to.",
"nullable": true
},
"trigger_params": {
"oneOf": [
{
"$ref": "#/components/schemas/incident_trigger_params"
},
{
"$ref": "#/components/schemas/action_item_trigger_params"
},
{
"$ref": "#/components/schemas/alert_trigger_params"
},
{
"$ref": "#/components/schemas/pulse_trigger_params"
},
{
"$ref": "#/components/schemas/simple_trigger_params"
}
]
},
"environment_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"severity_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"incident_type_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"incident_role_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"service_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"functionality_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"group_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"cause_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"sub_status_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"name",
"created_at",
"updated_at"
]
},
"workflow_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the workflow"
},
"type": {
"type": "string",
"enum": [
"workflows"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/workflow"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"workflow_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the workflow"
},
"type": {
"type": "string",
"enum": [
"workflows"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/workflow"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_live_call_router": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"live_call_routers"
]
},
"attributes": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "The kind of the live_call_router",
"enum": [
"voicemail",
"live"
]
},
"enabled": {
"type": "boolean",
"description": "Whether the live_call_router is enabled"
},
"name": {
"type": "string",
"description": "The name of the live_call_router"
},
"country_code": {
"type": "string",
"description": "The country code of the live_call_router",
"enum": [
"AU",
"CA",
"DE",
"NL",
"NZ",
"SE",
"CH",
"GB",
"US"
]
},
"phone_type": {
"type": "string",
"description": "The phone type of the live_call_router",
"enum": [
"local",
"toll_free",
"mobile"
]
},
"phone_number": {
"type": "string",
"description": "You can select a phone number using [generate_phone_number](#//api/v1/live_call_routers/generate_phone_number) API and pass that phone number here to register"
},
"voicemail_greeting": {
"type": "string",
"description": "The voicemail greeting of the live_call_router"
},
"caller_greeting": {
"type": "string",
"description": "The caller greeting message of the live_call_router"
},
"unavailable_responder_message": {
"type": "string",
"nullable": true,
"maxLength": 300,
"description": "The message played to the caller when a responder doesn't answer and the call moves on to the next person in the escalation. Leave blank to use the default message."
},
"waiting_music_url": {
"type": "string",
"description": "The waiting music URL of the live_call_router",
"enum": [
"https://storage.rootly.com/twilio/voicemail/ClockworkWaltz.mp3",
"https://storage.rootly.com/twilio/voicemail/ith_brahms-116-4.mp3",
"https://storage.rootly.com/twilio/voicemail/Mellotroniac_-_Flight_Of_Young_Hearts_Flute.mp3",
"https://storage.rootly.com/twilio/voicemail/BusyStrings.mp3",
"https://storage.rootly.com/twilio/voicemail/oldDog_-_endless_goodbye_%28instr.%29.mp3",
"https://storage.rootly.com/twilio/voicemail/MARKOVICHAMP-Borghestral.mp3",
"https://storage.rootly.com/twilio/voicemail/ith_chopin-15-2.mp3"
]
},
"sent_to_voicemail_delay": {
"type": "integer",
"description": "The delay (seconds) after which the caller in redirected to voicemail"
},
"should_redirect_to_voicemail_on_no_answer": {
"type": "boolean",
"description": "This prompts the caller to choose voicemail or connect live"
},
"escalation_level_delay_in_seconds": {
"type": "integer",
"description": "This overrides the delay (seconds) in escalation levels"
},
"should_auto_resolve_alert_on_call_end": {
"type": "boolean",
"description": "This overrides the delay (seconds) in escalation levels"
},
"alert_urgency_id": {
"type": "string",
"description": "This is used in escalation paths to determine who to page"
},
"calling_tree_enabled": {
"type": "boolean",
"description": "Whether the live call router is configured as a phone tree, requiring callers to press a key before being connected"
},
"calling_tree_prompt": {
"type": "string",
"description": "The audio instructions callers will hear when they call this number, prompting them to select from available options to route their call"
},
"paging_targets": {
"type": "array",
"description": "Paging targets that callers can select from when this live call router is configured as a phone tree.",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of paging target"
},
"type": {
"type": "string",
"description": "The type of the paging target. Please contact support if you encounter issues using `functionality` as a target type.",
"enum": [
"service",
"team",
"escalation_policy",
"functionality"
]
},
"alert_urgency_id": {
"type": "string",
"description": "This is used in escalation paths to determine who to page"
}
},
"required": [
"id",
"type",
"alert_urgency_id"
],
"nullable": false
}
},
"escalation_policy_trigger_params": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of notification target"
},
"type": {
"type": "string",
"description": "The type of the notification target. Please contact support if you encounter issues using `functionality` as a target type.",
"enum": [
"service",
"group",
"escalation_policy",
"functionality"
]
}
},
"required": [
"id",
"type"
]
}
},
"additionalProperties": false,
"required": [
"kind",
"name",
"country_code",
"phone_type",
"phone_number",
"voicemail_greeting",
"paging_targets"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_live_call_router": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"live_call_routers"
]
},
"attributes": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "The kind of the live_call_router",
"enum": [
"voicemail",
"live"
]
},
"enabled": {
"type": "boolean",
"description": "Whether the live_call_router is enabled"
},
"name": {
"type": "string",
"description": "The name of the live_call_router"
},
"country_code": {
"type": "string",
"description": "The country code of the live_call_router",
"enum": [
"AU",
"CA",
"DE",
"NL",
"NZ",
"SE",
"CH",
"GB",
"US"
]
},
"phone_type": {
"type": "string",
"description": "The phone type of the live_call_router",
"enum": [
"local",
"toll_free",
"mobile"
]
},
"voicemail_greeting": {
"type": "string",
"description": "The voicemail greeting of the live_call_router"
},
"caller_greeting": {
"type": "string",
"description": "The caller greeting message of the live_call_router"
},
"unavailable_responder_message": {
"type": "string",
"nullable": true,
"maxLength": 300,
"description": "The message played to the caller when a responder doesn't answer and the call moves on to the next person in the escalation. Leave blank to use the default message."
},
"waiting_music_url": {
"type": "string",
"description": "The waiting music URL of the live_call_router",
"enum": [
"https://storage.rootly.com/twilio/voicemail/ClockworkWaltz.mp3",
"https://storage.rootly.com/twilio/voicemail/ith_brahms-116-4.mp3",
"https://storage.rootly.com/twilio/voicemail/Mellotroniac_-_Flight_Of_Young_Hearts_Flute.mp3",
"https://storage.rootly.com/twilio/voicemail/BusyStrings.mp3",
"https://storage.rootly.com/twilio/voicemail/oldDog_-_endless_goodbye_%28instr.%29.mp3",
"https://storage.rootly.com/twilio/voicemail/MARKOVICHAMP-Borghestral.mp3",
"https://storage.rootly.com/twilio/voicemail/ith_chopin-15-2.mp3"
]
},
"sent_to_voicemail_delay": {
"type": "integer",
"description": "The delay (seconds) after which the caller in redirected to voicemail"
},
"should_redirect_to_voicemail_on_no_answer": {
"type": "boolean",
"description": "This prompts the caller to choose voicemail or connect live"
},
"escalation_level_delay_in_seconds": {
"type": "integer",
"description": "This overrides the delay (seconds) in escalation levels"
},
"should_auto_resolve_alert_on_call_end": {
"type": "boolean",
"description": "This overrides the delay (seconds) in escalation levels"
},
"alert_urgency_id": {
"type": "string",
"description": "This is used in escalation paths to determine who to page"
},
"calling_tree_enabled": {
"type": "boolean",
"description": "Whether the live call router is configured as a phone tree, requiring callers to press a key before being connected"
},
"calling_tree_prompt": {
"type": "string",
"description": "The audio instructions callers will hear when they call this number, prompting them to select from available options to route their call"
},
"paging_targets": {
"type": "array",
"description": "Paging targets that callers can select from when this live call router is configured as a phone tree.",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of paging target"
},
"type": {
"type": "string",
"description": "The type of the paging target. Please contact support if you encounter issues using `functionality` as a target type.",
"enum": [
"service",
"team",
"escalation_policy",
"functionality"
]
},
"alert_urgency_id": {
"type": "string",
"description": "This is used in escalation paths to determine who to page"
}
},
"required": [
"id",
"type",
"alert_urgency_id"
],
"nullable": false
}
},
"escalation_policy_trigger_params": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of notification target"
},
"type": {
"type": "string",
"description": "The type of the notification target. Please contact support if you encounter issues using `Functionality` as a target type.",
"enum": [
"Service",
"Group",
"EscalationPolicy",
"Functionality"
]
}
},
"required": [
"id",
"type"
]
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"live_call_router": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "The kind of the live_call_router",
"enum": [
"voicemail",
"live"
]
},
"enabled": {
"type": "boolean",
"description": "Whether the live_call_router is enabled"
},
"name": {
"type": "string",
"description": "The name of the live_call_router"
},
"country_code": {
"type": "string",
"description": "The country code of the live_call_router",
"enum": [
"AU",
"CA",
"DE",
"NL",
"NZ",
"SE",
"CH",
"GB",
"US"
]
},
"phone_type": {
"type": "string",
"description": "The phone type of the live_call_router",
"enum": [
"local",
"toll_free",
"mobile"
]
},
"phone_number": {
"type": "string",
"description": "You can select a phone number using [generate_phone_number](#//api/v1/live_call_routers/generate_phone_number) API and pass that phone number here to register"
},
"voicemail_greeting": {
"type": "string",
"description": "The voicemail greeting of the live_call_router"
},
"caller_greeting": {
"type": "string",
"description": "The caller greeting message of the live_call_router"
},
"unavailable_responder_message": {
"type": "string",
"nullable": true,
"maxLength": 300,
"description": "The message played to the caller when a responder doesn't answer and the call moves on to the next person in the escalation. Leave blank to use the default message."
},
"waiting_music_url": {
"type": "string",
"description": "The waiting music URL of the live_call_router",
"enum": [
"https://storage.rootly.com/twilio/voicemail/ClockworkWaltz.mp3",
"https://storage.rootly.com/twilio/voicemail/ith_brahms-116-4.mp3",
"https://storage.rootly.com/twilio/voicemail/Mellotroniac_-_Flight_Of_Young_Hearts_Flute.mp3",
"https://storage.rootly.com/twilio/voicemail/BusyStrings.mp3",
"https://storage.rootly.com/twilio/voicemail/oldDog_-_endless_goodbye_%28instr.%29.mp3",
"https://storage.rootly.com/twilio/voicemail/MARKOVICHAMP-Borghestral.mp3",
"https://storage.rootly.com/twilio/voicemail/ith_chopin-15-2.mp3"
]
},
"sent_to_voicemail_delay": {
"type": "integer",
"description": "The delay (seconds) after which the caller in redirected to voicemail"
},
"should_redirect_to_voicemail_on_no_answer": {
"type": "boolean",
"description": "This prompts the caller to choose voicemail or connect live"
},
"escalation_level_delay_in_seconds": {
"type": "integer",
"description": "This overrides the delay (seconds) in escalation levels"
},
"should_auto_resolve_alert_on_call_end": {
"type": "boolean",
"description": "This overrides the delay (seconds) in escalation levels"
},
"alert_urgency_id": {
"type": "string",
"description": "This is used in escalation paths to determine who to page"
},
"calling_tree_prompt": {
"type": "string",
"description": "The audio instructions callers will hear when they call this number, prompting them to select from available options to route their call"
},
"paging_targets": {
"type": "array",
"description": "Paging targets that callers can select from when this live call router is configured as a phone tree.",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of paging target"
},
"type": {
"type": "string",
"description": "The type of the paging target. Please contact support if you encounter issues using `functionality` as a target type.",
"enum": [
"service",
"team",
"escalation_policy",
"functionality"
]
},
"alert_urgency_id": {
"type": "string",
"description": "This is used in escalation paths to determine who to page"
}
},
"required": [
"id",
"type",
"alert_urgency_id"
],
"nullable": false
}
},
"escalation_policy_trigger_params": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of notification target"
},
"type": {
"type": "string",
"description": "The type of the notification target. Please contact support if you encounter issues using `Functionality` as a target type.",
"enum": [
"Service",
"Group",
"EscalationPolicy",
"Functionality"
]
}
},
"required": [
"id",
"type"
]
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"name",
"created_at",
"updated_at"
]
},
"live_call_router_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the live_call_router"
},
"type": {
"type": "string",
"enum": [
"live_call_routers"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/live_call_router"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"live_call_router_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the live_call_router"
},
"type": {
"type": "string",
"enum": [
"live_call_routers"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/live_call_router"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_heartbeat": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"heartbeats"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the heartbeat"
},
"description": {
"type": "string",
"description": "The description of the heartbeat",
"nullable": true
},
"alert_summary": {
"type": "string",
"description": "Summary of alerts triggered when heartbeat expires."
},
"alert_description": {
"type": "string",
"description": "Description of alerts triggered when heartbeat expires.",
"nullable": true
},
"alert_urgency_id": {
"type": "string",
"description": "Urgency of alerts triggered when heartbeat expires.",
"nullable": true
},
"interval": {
"type": "integer"
},
"interval_unit": {
"type": "string",
"enum": [
"minutes",
"hours",
"days"
]
},
"notification_target_id": {
"type": "string"
},
"notification_target_type": {
"type": "string",
"description": "The type of the notification target. Please contact support if you encounter issues using `Functionality` as a target type.",
"enum": [
"User",
"Group",
"Service",
"EscalationPolicy",
"Functionality"
]
},
"owner_group_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of team IDs that own this heartbeat"
},
"enabled": {
"type": "boolean",
"description": "Whether to trigger alerts when heartbeat is expired."
}
},
"additionalProperties": false,
"required": [
"name",
"alert_summary",
"interval",
"interval_unit",
"notification_target_id",
"notification_target_type"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_heartbeat": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"heartbeats"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the heartbeat"
},
"description": {
"type": "string",
"description": "The description of the heartbeat",
"nullable": true
},
"alert_summary": {
"type": "string",
"description": "Summary of alerts triggered when heartbeat expires."
},
"alert_description": {
"type": "string",
"description": "Description of alerts triggered when heartbeat expires.",
"nullable": true
},
"alert_urgency_id": {
"type": "string",
"description": "Urgency of alerts triggered when heartbeat expires.",
"nullable": true
},
"interval": {
"type": "integer"
},
"interval_unit": {
"type": "string",
"enum": [
"minutes",
"hours",
"days"
]
},
"notification_target_id": {
"type": "string"
},
"notification_target_type": {
"type": "string",
"description": "The type of the notification target. Please contact support if you encounter issues using `Functionality` as a target type.",
"enum": [
"User",
"Group",
"Service",
"EscalationPolicy",
"Functionality"
]
},
"owner_group_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of team IDs that own this heartbeat"
},
"enabled": {
"type": "boolean",
"description": "Whether to trigger alerts when heartbeat is expired."
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"heartbeat": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the heartbeat"
},
"description": {
"type": "string",
"description": "The description of the heartbeat",
"nullable": true
},
"alert_summary": {
"type": "string",
"description": "Summary of alerts triggered when heartbeat expires."
},
"alert_description": {
"type": "string",
"description": "Description of alerts triggered when heartbeat expires.",
"nullable": true
},
"alert_urgency_id": {
"type": "string",
"description": "Urgency of alerts triggered when heartbeat expires.",
"nullable": true
},
"interval": {
"type": "integer"
},
"interval_unit": {
"type": "string",
"enum": [
"minutes",
"hours",
"days"
]
},
"notification_target_id": {
"type": "string"
},
"notification_target_type": {
"type": "string",
"description": "The type of the notification target. Please contact support if you encounter issues using `Functionality` as a target type.",
"enum": [
"User",
"Group",
"Service",
"EscalationPolicy",
"Functionality"
]
},
"owner_group_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of team IDs that own this heartbeat"
},
"enabled": {
"type": "boolean",
"description": "Whether to trigger alerts when heartbeat is expired."
},
"status": {
"type": "string",
"enum": [
"waiting",
"active",
"expired"
]
},
"ping_url": {
"type": "string",
"nullable": true,
"description": "URL to receive heartbeat pings."
},
"secret": {
"type": "string",
"nullable": true,
"description": "Secret used as bearer token when pinging heartbeat."
},
"email_address": {
"type": "string",
"description": "Email address to receive heartbeat pings."
},
"last_pinged_at": {
"type": "string",
"description": "When the heartbeat was last pinged.",
"nullable": true
},
"expires_at": {
"type": "string",
"description": "When heartbeat expires",
"nullable": true
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"name",
"alert_summary",
"interval",
"interval_unit",
"notification_target_id",
"notification_target_type",
"enabled",
"status",
"email_address",
"created_at",
"updated_at"
]
},
"heartbeat_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the heartbeat"
},
"type": {
"type": "string",
"enum": [
"heartbeats"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/heartbeat"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"heartbeat_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the heartbeat"
},
"type": {
"type": "string",
"enum": [
"heartbeats"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/heartbeat"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_incident_action_item": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_action_items"
]
},
"attributes": {
"type": "object",
"properties": {
"summary": {
"type": "string",
"description": "The summary of the action item"
},
"description": {
"type": "string",
"description": "The description of the action item",
"nullable": true
},
"kind": {
"type": "string",
"description": "The kind of the action item",
"enum": [
"task",
"follow_up"
]
},
"assigned_to_user_id": {
"type": "integer",
"description": "ID of user you wish to assign this action item",
"nullable": true
},
"assigned_to_group_ids": {
"type": "array",
"description": "IDs of groups you wish to assign this action item",
"items": {
"type": "string"
}
},
"priority": {
"type": "string",
"description": "The priority of the action item",
"enum": [
"high",
"medium",
"low"
]
},
"status": {
"type": "string",
"description": "The status of the action item",
"enum": [
"open",
"in_progress",
"cancelled",
"done"
]
},
"due_date": {
"type": "string",
"description": "The due date of the action item",
"nullable": true
},
"jira_issue_id": {
"type": "string",
"description": "The Jira issue ID.",
"nullable": true
},
"jira_issue_key": {
"type": "string",
"description": "The Jira issue key.",
"nullable": true
},
"jira_issue_url": {
"type": "string",
"description": "The Jira issue URL.",
"nullable": true
},
"form_field_selections": {
"type": "array",
"nullable": true,
"description": "Custom field values to set on the action item. Ignored unless custom fields for action items are enabled for the organization.",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of an existing selection. Required when updating or removing a field's existing value."
},
"form_field_id": {
"type": "string",
"description": "ID of the custom field"
},
"value": {
"oneOf": [
{
"type": "string",
"nullable": true
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
"description": "Value for text, textarea, rich text, date, datetime, number, checkbox, or tag fields"
},
"selected_option_ids": {
"type": "array",
"description": "IDs of the selected custom field options",
"items": {
"type": "string"
}
},
"selected_user_ids": {
"type": "array",
"description": "IDs of the selected users",
"items": {
"type": "integer"
}
},
"selected_group_ids": {
"type": "array",
"description": "IDs of the selected teams",
"items": {
"type": "string"
}
},
"selected_service_ids": {
"type": "array",
"description": "IDs of the selected services",
"items": {
"type": "string"
}
},
"selected_functionality_ids": {
"type": "array",
"description": "IDs of the selected functionalities",
"items": {
"type": "string"
}
},
"selected_catalog_entity_ids": {
"type": "array",
"description": "IDs of the selected catalog entities",
"items": {
"type": "string"
}
},
"selected_environment_ids": {
"type": "array",
"description": "IDs of the selected environments",
"items": {
"type": "string"
}
},
"selected_cause_ids": {
"type": "array",
"description": "IDs of the selected causes",
"items": {
"type": "string"
}
},
"selected_incident_type_ids": {
"type": "array",
"description": "IDs of the selected incident types",
"items": {
"type": "string"
}
},
"_destroy": {
"type": "boolean",
"nullable": true,
"description": "Set to true to remove the field's value from the action item"
}
},
"additionalProperties": false,
"required": [
"form_field_id"
]
}
}
},
"additionalProperties": false,
"required": [
"summary"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_incident_action_item": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_action_items"
]
},
"attributes": {
"type": "object",
"properties": {
"summary": {
"type": "string",
"description": "The summary of the action item"
},
"description": {
"type": "string",
"description": "The description of the action item",
"nullable": true
},
"kind": {
"type": "string",
"description": "The kind of the action item",
"enum": [
"task",
"follow_up"
]
},
"assigned_to_user_id": {
"type": "integer",
"description": "ID of user you wish to assign this action item",
"nullable": true
},
"assigned_to_group_ids": {
"type": "array",
"description": "IDs of groups you wish to assign this action item",
"items": {
"type": "string"
},
"nullable": true
},
"priority": {
"type": "string",
"description": "The priority of the action item",
"enum": [
"high",
"medium",
"low"
]
},
"status": {
"type": "string",
"description": "The status of the action item",
"enum": [
"open",
"in_progress",
"cancelled",
"done"
]
},
"due_date": {
"type": "string",
"description": "The due date of the action item",
"nullable": true
},
"jira_issue_id": {
"type": "string",
"description": "The Jira issue ID.",
"nullable": true
},
"jira_issue_key": {
"type": "string",
"description": "The Jira issue key.",
"nullable": true
},
"jira_issue_url": {
"type": "string",
"description": "The Jira issue URL.",
"nullable": true
},
"form_field_selections": {
"type": "array",
"nullable": true,
"description": "Custom field values to set on the action item. Ignored unless custom fields for action items are enabled for the organization.",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of an existing selection. Required when updating or removing a field's existing value."
},
"form_field_id": {
"type": "string",
"description": "ID of the custom field"
},
"value": {
"oneOf": [
{
"type": "string",
"nullable": true
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
"description": "Value for text, textarea, rich text, date, datetime, number, checkbox, or tag fields"
},
"selected_option_ids": {
"type": "array",
"description": "IDs of the selected custom field options",
"items": {
"type": "string"
}
},
"selected_user_ids": {
"type": "array",
"description": "IDs of the selected users",
"items": {
"type": "integer"
}
},
"selected_group_ids": {
"type": "array",
"description": "IDs of the selected teams",
"items": {
"type": "string"
}
},
"selected_service_ids": {
"type": "array",
"description": "IDs of the selected services",
"items": {
"type": "string"
}
},
"selected_functionality_ids": {
"type": "array",
"description": "IDs of the selected functionalities",
"items": {
"type": "string"
}
},
"selected_catalog_entity_ids": {
"type": "array",
"description": "IDs of the selected catalog entities",
"items": {
"type": "string"
}
},
"selected_environment_ids": {
"type": "array",
"description": "IDs of the selected environments",
"items": {
"type": "string"
}
},
"selected_cause_ids": {
"type": "array",
"description": "IDs of the selected causes",
"items": {
"type": "string"
}
},
"selected_incident_type_ids": {
"type": "array",
"description": "IDs of the selected incident types",
"items": {
"type": "string"
}
},
"_destroy": {
"type": "boolean",
"nullable": true,
"description": "Set to true to remove the field's value from the action item"
}
},
"additionalProperties": false,
"required": [
"form_field_id"
]
}
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"incident_action_item": {
"type": "object",
"properties": {
"summary": {
"type": "string",
"description": "The summary of the action item"
},
"description": {
"type": "string",
"description": "The description of incident action item",
"nullable": true
},
"kind": {
"type": "string",
"description": "The kind of the action item",
"enum": [
"task",
"follow_up"
]
},
"assigned_to": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/user_flat_response"
}
],
"description": "User assigned to this action item",
"nullable": true
},
"assigned_to_group_ids": {
"type": "array",
"description": "IDs of groups you wish to assign this action item",
"items": {
"type": "string"
},
"nullable": true
},
"priority": {
"type": "string",
"description": "The priority of the action item",
"enum": [
"high",
"medium",
"low"
]
},
"status": {
"type": "string",
"description": "The status of the action item",
"enum": [
"open",
"in_progress",
"cancelled",
"done"
]
},
"due_date": {
"type": "string",
"description": "The due date of the action item",
"nullable": true
},
"jira_issue_id": {
"type": "string",
"description": "The Jira issue ID.",
"nullable": true
},
"jira_issue_key": {
"type": "string",
"description": "The Jira issue key.",
"nullable": true
},
"jira_issue_url": {
"type": "string",
"description": "The Jira issue URL.",
"nullable": true
},
"created_by": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/user_flat_response"
}
],
"description": "User who created this action item",
"nullable": true
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"summary",
"created_at",
"updated_at"
]
},
"incident_action_item_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the action item"
},
"type": {
"type": "string",
"enum": [
"incident_action_items"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_action_item"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"incident_action_item_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the action item"
},
"type": {
"type": "string",
"enum": [
"incident_action_items"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_action_item"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_incident_custom_field_selection": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_custom_field_selections"
]
},
"attributes": {
"type": "object",
"properties": {
"custom_field_id": {
"type": "integer",
"description": "The custom field for this selection"
},
"value": {
"type": "string",
"description": "The selected value for text kind custom fields",
"nullable": true
},
"selected_option_ids": {
"type": "array",
"items": {
"type": "integer",
"description": "The selected option id for select and multi_select kinds"
}
}
},
"additionalProperties": false,
"required": [
"value",
"custom_field_id"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_incident_custom_field_selection": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_custom_field_selections"
]
},
"attributes": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The selected value for text kind custom fields",
"nullable": true
},
"selected_option_ids": {
"type": "array",
"items": {
"type": "integer",
"description": "The selected option id for select and multi_select kinds"
}
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"incident_custom_field_selection": {
"type": "object",
"properties": {
"incident_id": {
"type": "string"
},
"custom_field_id": {
"type": "integer"
},
"value": {
"type": "string",
"description": "The value of the incident_custom_field_selection",
"nullable": true
},
"selected_option_ids": {
"type": "array",
"items": {
"type": "integer",
"description": "The selected option id for select and multi_select kinds"
}
}
},
"required": [
"value",
"selected_option_ids"
]
},
"incident_custom_field_selection_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident_custom_field_selection"
},
"type": {
"type": "string",
"enum": [
"incident_custom_field_selections"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_custom_field_selection"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"incident_custom_field_selection_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident_custom_field_selection"
},
"type": {
"type": "string",
"enum": [
"incident_custom_field_selections"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_custom_field_selection"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_incident_event_functionality": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_event_functionalities"
]
},
"attributes": {
"type": "object",
"properties": {
"incident_event_id": {
"type": "string",
"description": "The ID of the incident event."
},
"functionality_id": {
"type": "string",
"description": "The ID of the functionality."
},
"status": {
"type": "string",
"description": "The status of the affected functionality",
"enum": [
"operational",
"partial_outage",
"major_outage"
]
}
},
"additionalProperties": false,
"required": [
"incident_event_id",
"functionality_id",
"status"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_incident_event_functionality": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_event_functionalities"
]
},
"attributes": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "The status of the affected functionality",
"enum": [
"operational",
"partial_outage",
"major_outage"
]
}
},
"additionalProperties": false,
"required": [
"status"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"incident_event_functionality": {
"type": "object",
"properties": {
"incident_event_id": {
"type": "string",
"description": "The ID of the incident event."
},
"functionality_id": {
"type": "string",
"description": "The ID of the functionality."
},
"status": {
"type": "string",
"description": "The status of the affected functionality",
"enum": [
"operational",
"partial_outage",
"major_outage"
]
}
},
"additionalProperties": false,
"required": [
"incident_event_id",
"functionality_id",
"status"
]
},
"incident_event_functionality_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident event functionality"
},
"type": {
"type": "string",
"enum": [
"incident_event_functionalities"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_event_functionality"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"incident_event_functionality_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident event functionality"
},
"type": {
"type": "string",
"enum": [
"incident_event_functionalities"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_event_functionality"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_incident_event_service": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_event_services"
]
},
"attributes": {
"type": "object",
"properties": {
"incident_event_id": {
"type": "string",
"description": "The ID of the incident event."
},
"service_id": {
"type": "string",
"description": "The ID of the service."
},
"status": {
"type": "string",
"description": "The status of the affected service",
"enum": [
"operational",
"partial_outage",
"major_outage"
]
}
},
"additionalProperties": false,
"required": [
"incident_event_id",
"service_id",
"status"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_incident_event_service": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_event_services"
]
},
"attributes": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "The status of the affected service",
"enum": [
"operational",
"partial_outage",
"major_outage"
]
}
},
"additionalProperties": false,
"required": [
"status"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"incident_event_service": {
"type": "object",
"properties": {
"incident_event_id": {
"type": "string",
"description": "The ID of the incident event."
},
"service_id": {
"type": "string",
"description": "The ID of the service."
},
"status": {
"type": "string",
"description": "The status of the affected service",
"enum": [
"operational",
"partial_outage",
"major_outage"
]
}
},
"additionalProperties": false,
"required": [
"incident_event_id",
"service_id",
"status"
]
},
"incident_event_service_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident event service"
},
"type": {
"type": "string",
"enum": [
"incident_event_services"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_event_service"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"incident_event_service_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident event service"
},
"type": {
"type": "string",
"enum": [
"incident_event_services"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_event_service"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_incident_event": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_events"
]
},
"attributes": {
"type": "object",
"properties": {
"event": {
"type": "string",
"description": "The summary of the incident event"
},
"visibility": {
"type": "string",
"description": "The visibility of the incident action item",
"enum": [
"internal",
"external"
]
}
},
"additionalProperties": false,
"required": [
"event"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_incident_event": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_events"
]
},
"attributes": {
"type": "object",
"properties": {
"event": {
"type": "string",
"description": "The summary of the incident event"
},
"visibility": {
"type": "string",
"description": "The visibility of the incident action item",
"enum": [
"internal",
"external"
]
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"incident_event": {
"type": "object",
"properties": {
"event": {
"type": "string",
"description": "The summary of the incident event"
},
"visibility": {
"type": "string",
"description": "The visibility of the incident action item",
"enum": [
"internal",
"external"
]
},
"occurred_at": {
"type": "string",
"description": "Date of occurence"
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"event",
"occurred_at",
"created_at",
"updated_at"
]
},
"incident_event_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident event"
},
"type": {
"type": "string",
"enum": [
"incident_events"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_event"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"incident_event_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident event"
},
"type": {
"type": "string",
"enum": [
"incident_events"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_event"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_incident_feedback": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_feedbacks"
]
},
"attributes": {
"type": "object",
"properties": {
"feedback": {
"type": "string",
"description": "The feedback of the incident feedback"
},
"rating": {
"type": "integer",
"description": "The rating of the incident feedback",
"enum": [
4,
3,
2,
1,
0
]
},
"anonymous": {
"type": "boolean",
"description": "Is the feedback anonymous?"
}
},
"additionalProperties": false,
"required": [
"rating",
"feedback"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_incident_feedback": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_feedbacks"
]
},
"attributes": {
"type": "object",
"properties": {
"feedback": {
"type": "string",
"description": "The feedback of the incident feedback"
},
"rating": {
"type": "integer",
"description": "The rating of the incident feedback",
"enum": [
4,
3,
2,
1,
0
]
},
"anonymous": {
"type": "boolean",
"description": "Is the feedback anonymous?"
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"incident_feedback": {
"type": "object",
"properties": {
"feedback": {
"type": "string",
"description": "The feedback of the incident feedback"
},
"rating": {
"type": "integer",
"description": "The rating of the incident feedback",
"enum": [
4,
3,
2,
1,
0
]
},
"anonymous": {
"type": "boolean",
"description": "Is the feedback anonymous?"
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"rating",
"feedback",
"anonymous",
"created_at",
"updated_at"
]
},
"incident_feedback_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident feedback"
},
"type": {
"type": "string",
"enum": [
"incident_feedbacks"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_feedback"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"incident_feedback_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident feedback"
},
"type": {
"type": "string",
"enum": [
"incident_feedbacks"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_feedback"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_incident_form_field_selection": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_form_field_selections"
]
},
"attributes": {
"type": "object",
"properties": {
"incident_id": {
"type": "string"
},
"form_field_id": {
"type": "string",
"description": "The custom field for this selection"
},
"value": {
"type": "string",
"description": "The selected value for text kind custom fields",
"nullable": true
},
"selected_catalog_entity_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected catalog entities for select and multi_select kinds"
}
},
"selected_group_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected groups (teams) for select and multi_select kinds"
}
},
"selected_option_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected options for select and multi_select kinds"
}
},
"selected_service_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected services for select and multi_select kinds"
}
},
"selected_functionality_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected functionalities for select and multi_select kinds"
}
},
"selected_user_ids": {
"type": "array",
"items": {
"type": "integer",
"description": "The selected users for select and multi_select kinds"
}
},
"selected_environment_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected environments for select and multi_select kinds"
}
},
"selected_cause_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected causes for select and multi_select kinds"
}
},
"selected_incident_type_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected incident types for select and multi_select kinds"
}
}
},
"additionalProperties": false,
"required": [
"form_field_id",
"incident_id"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_incident_form_field_selection": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_form_field_selections"
]
},
"attributes": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The selected value for text kind custom fields",
"nullable": true
},
"selected_catalog_entity_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected catalog entities for select and multi_select kinds"
}
},
"selected_group_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected groups (teams) for select and multi_select kinds"
}
},
"selected_option_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected options for select and multi_select kinds"
}
},
"selected_service_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected services for select and multi_select kinds"
}
},
"selected_functionality_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected functionalities for select and multi_select kinds"
}
},
"selected_user_ids": {
"type": "array",
"items": {
"type": "integer",
"description": "The selected users for select and multi_select kinds"
}
},
"selected_environment_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected environments for select and multi_select kinds"
}
},
"selected_cause_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected causes for select and multi_select kinds"
}
},
"selected_incident_type_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected incident types for select and multi_select kinds"
}
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"incident_form_field_selection": {
"type": "object",
"properties": {
"incident_id": {
"type": "string"
},
"form_field_id": {
"type": "string",
"description": "The custom field for this selection"
},
"value": {
"type": "string",
"description": "The selected value for text kind custom fields",
"nullable": true
},
"selected_catalog_entity_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected catalog entities for select and multi_select kinds"
}
},
"selected_group_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected groups (teams) for select and multi_select kinds"
}
},
"selected_option_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected options for select and multi_select kinds"
}
},
"selected_service_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected services for select and multi_select kinds"
}
},
"selected_functionality_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected functionalities for select and multi_select kinds"
}
},
"selected_user_ids": {
"type": "array",
"items": {
"type": "integer",
"description": "The selected users for select and multi_select kinds"
}
},
"selected_environment_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected environments for select and multi_select kinds"
}
},
"selected_cause_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected causes for select and multi_select kinds"
}
},
"selected_incident_type_ids": {
"type": "array",
"items": {
"type": "string",
"description": "The selected incident types for select and multi_select kinds"
}
}
},
"required": [
"incident_id",
"form_field_id"
]
},
"incident_form_field_selection_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident_form_field_selection"
},
"type": {
"type": "string",
"enum": [
"incident_form_field_selections"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_form_field_selection"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"incident_form_field_selection_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident_form_field_selection"
},
"type": {
"type": "string",
"enum": [
"incident_form_field_selections"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_form_field_selection"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_incident_permission_set_boolean": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_permission_set_booleans"
]
},
"attributes": {
"type": "object",
"properties": {
"incident_permission_set_id": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"publish_to_status_page",
"assign_incident_roles",
"invite_subscribers",
"update_summary",
"update_timeline",
"trigger_workflows",
"create_communications",
"read_communications",
"update_communications",
"delete_communications",
"send_communications",
"modify_custom_fields"
]
},
"private": {
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"severity_params": {
"type": "object",
"properties": {
"fully_enabled": {
"type": "boolean",
"description": "Whether permissions are enabled for any severity incident",
"default": true
},
"create_enabled": {
"type": "boolean",
"description": "Whether permissions are enabled when creating incident",
"default": false
},
"applies_to_unassigned": {
"type": "boolean",
"description": "Whether permissions are enabled for incident without severity",
"default": true
},
"severity_ids": {
"type": "array",
"description": "Severity ids that determine if an incident is permitted based on matching severity",
"items": {
"type": "string"
},
"nullable": true
}
}
}
},
"additionalProperties": false,
"required": [
"kind",
"incident_permission_set_id"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_incident_permission_set_boolean": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_permission_set_booleans"
]
},
"attributes": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"publish_to_status_page",
"assign_incident_roles",
"invite_subscribers",
"update_summary",
"update_timeline",
"trigger_workflows",
"create_communications",
"read_communications",
"update_communications",
"delete_communications",
"send_communications",
"modify_custom_fields"
]
},
"private": {
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"severity_params": {
"type": "object",
"properties": {
"fully_enabled": {
"type": "boolean",
"description": "Whether permissions are enabled for any severity incident",
"default": true
},
"applies_to_unassigned": {
"type": "boolean",
"description": "Whether permissions are enabled for incident without severity",
"default": true
},
"create_enabled": {
"type": "boolean",
"description": "Whether permissions are enabled when creating incident",
"default": false
},
"severity_ids": {
"type": "array",
"description": "Severity ids that determine if an incident is permitted based on matching severity",
"items": {
"type": "string"
},
"nullable": true
}
}
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"incident_permission_set_boolean": {
"type": "object",
"properties": {
"incident_permission_set_id": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"publish_to_status_page",
"assign_incident_roles",
"invite_subscribers",
"update_summary",
"update_timeline",
"trigger_workflows",
"create_communications",
"read_communications",
"update_communications",
"delete_communications",
"send_communications",
"modify_custom_fields"
]
},
"private": {
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"kind",
"created_at",
"updated_at"
]
},
"incident_permission_set_boolean_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident permission set boolean"
},
"type": {
"type": "string",
"enum": [
"incident_permission_set_booleans"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_permission_set_boolean"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"incident_permission_set_boolean_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident permission set boolean"
},
"type": {
"type": "string",
"enum": [
"incident_permission_set_booleans"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_permission_set_boolean"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_incident_permission_set_resource": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_permission_set_resources"
]
},
"attributes": {
"type": "object",
"properties": {
"incident_permission_set_id": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"severities",
"incident_types",
"statuses",
"sub_statuses"
]
},
"private": {
"type": "boolean"
},
"resource_id": {
"type": "string"
},
"resource_type": {
"type": "string"
},
"severity_params": {
"type": "object",
"properties": {
"fully_enabled": {
"type": "boolean",
"description": "Whether permissions are enabled for any severity incident",
"default": true
},
"create_enabled": {
"type": "boolean",
"description": "Whether permissions are enabled when creating incident",
"default": false
},
"applies_to_unassigned": {
"type": "boolean",
"description": "Whether permissions are enabled for incident without severity",
"default": true
},
"severity_ids": {
"type": "array",
"description": "Severity ids that determine if an incident is permitted based on matching severity",
"items": {
"type": "string"
},
"nullable": true
}
}
}
},
"additionalProperties": false,
"required": [
"incident_permission_set_id",
"kind"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_incident_permission_set_resource": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_permission_set_resources"
]
},
"attributes": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"severities",
"incident_types",
"statuses",
"sub_statuses"
]
},
"private": {
"type": "boolean"
},
"resource_id": {
"type": "string"
},
"resource_type": {
"type": "string"
},
"severity_params": {
"type": "object",
"properties": {
"fully_enabled": {
"type": "boolean",
"description": "Whether permissions are enabled for any severity incident",
"default": true
},
"create_enabled": {
"type": "boolean",
"description": "Whether permissions are enabled when creating incident",
"default": false
},
"applies_to_unassigned": {
"type": "boolean",
"description": "Whether permissions are enabled for incident without severity",
"default": true
},
"severity_ids": {
"type": "array",
"description": "Severity ids that determine if an incident is permitted based on matching severity",
"items": {
"type": "string"
},
"nullable": true
}
}
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"incident_permission_set_resource": {
"type": "object",
"properties": {
"incident_permission_set_id": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"severities",
"incident_types",
"statuses",
"sub_statuses"
]
},
"private": {
"type": "boolean"
},
"resource_id": {
"type": "string"
},
"resource_type": {
"type": "string"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"incident_permission_set_id",
"kind",
"created_at",
"updated_at"
]
},
"incident_permission_set_resource_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident permission set resource"
},
"type": {
"type": "string",
"enum": [
"incident_permission_set_resources"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_permission_set_resource"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"incident_permission_set_resource_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident permission set resource"
},
"type": {
"type": "string",
"enum": [
"incident_permission_set_resources"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_permission_set_resource"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_incident_permission_set": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_permission_sets"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The incident permission set name."
},
"description": {
"type": "string",
"description": "The incident permission set description.",
"nullable": true
},
"private_incident_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"public_incident_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_incident_permission_set": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_permission_sets"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The incident permission set name."
},
"description": {
"type": "string",
"description": "The incident permission set description.",
"nullable": true
},
"private_incident_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"public_incident_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"incident_permission_set": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The incident permission set name."
},
"slug": {
"type": "string",
"description": "The incident permission set slug."
},
"description": {
"type": "string",
"description": "The incident permission set description.",
"nullable": true
},
"private_incident_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"public_incident_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"name",
"created_at",
"updated_at"
]
},
"incident_permission_set_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident permission set"
},
"type": {
"type": "string",
"enum": [
"incident_permission_sets"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_permission_set"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"incident_permission_set_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident permission set"
},
"type": {
"type": "string",
"enum": [
"incident_permission_sets"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_permission_set"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"update_incident_post_mortem": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_post_mortems"
]
},
"attributes": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the incident retrospective"
},
"status": {
"type": "string",
"description": "The status of the incident retrospective",
"enum": [
"draft",
"published"
]
},
"started_at": {
"type": "string",
"description": "Date of started at",
"nullable": true
},
"mitigated_at": {
"type": "string",
"description": "Date of mitigation",
"nullable": true
},
"resolved_at": {
"type": "string",
"description": "Date of resolution",
"nullable": true
},
"show_timeline": {
"type": "boolean",
"description": "Show events timeline of the incident retrospective"
},
"show_timeline_trail": {
"type": "boolean",
"description": "Show trail events in the timeline of the incident retrospective"
},
"show_timeline_genius": {
"type": "boolean",
"description": "Show workflow events in the timeline of the incident retrospective"
},
"show_timeline_tasks": {
"type": "boolean",
"description": "Show tasks in the timeline of the incident retrospective"
},
"show_timeline_action_items": {
"type": "boolean",
"description": "Show action items in the timeline of the incident retrospective"
},
"show_services_impacted": {
"type": "boolean",
"description": "Show functionalities impacted of the incident retrospective"
},
"show_functionalities_impacted": {
"type": "boolean",
"description": "Show services impacted of the incident retrospective"
},
"show_groups_impacted": {
"type": "boolean",
"description": "Show groups impacted of the incident retrospective"
},
"show_alerts_attached": {
"type": "boolean",
"description": "Show alerts attached to the incident"
},
"show_action_items": {
"type": "boolean",
"description": "Show action items (follow-ups) in the incident retrospective"
},
"cause_ids": {
"type": "array",
"description": "The Cause IDs to attach to the incident retrospective",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"incident_post_mortem": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the incident retrospective"
},
"content": {
"type": "string",
"description": "The content of the incident retrospective (Only if internal)",
"nullable": true
},
"status": {
"type": "string",
"description": "The status of the incident retrospective",
"enum": [
"draft",
"published"
]
},
"started_at": {
"type": "string",
"description": "Date of started at",
"nullable": true
},
"mitigated_at": {
"type": "string",
"description": "Date of mitigation",
"nullable": true
},
"resolved_at": {
"type": "string",
"description": "Date of resolution",
"nullable": true
},
"show_timeline": {
"type": "boolean",
"description": "Show events timeline of the incident retrospective"
},
"show_timeline_trail": {
"type": "boolean",
"description": "Show trail events in the timeline of the incident retrospective"
},
"show_timeline_genius": {
"type": "boolean",
"description": "Show workflow events in the timeline of the incident retrospective"
},
"show_timeline_tasks": {
"type": "boolean",
"description": "Show tasks in the timeline of the incident retrospective"
},
"show_timeline_action_items": {
"type": "boolean",
"description": "Show action items in the timeline of the incident retrospective"
},
"show_timeline_order": {
"type": "string",
"description": "The order of the incident retrospective timeline",
"enum": [
"asc",
"desc"
],
"default": "desc"
},
"show_services_impacted": {
"type": "boolean",
"description": "Show functionalities impacted of the incident retrospective"
},
"show_functionalities_impacted": {
"type": "boolean",
"description": "Show services impacted of the incident retrospective"
},
"show_groups_impacted": {
"type": "boolean",
"description": "Show groups impacted of the incident retrospective"
},
"show_alerts_attached": {
"type": "boolean",
"description": "Show alerts attached to the incident"
},
"url": {
"type": "string",
"description": "The url to the incident retrospective"
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"title",
"created_at",
"updated_at"
]
},
"incident_post_mortem_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident retrospective"
},
"type": {
"type": "string",
"enum": [
"incident_post_mortems"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_post_mortem"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"incident_post_mortem_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident retrospective"
},
"type": {
"type": "string",
"enum": [
"incident_post_mortems"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_post_mortem"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"update_incident_retrospective_step": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_retrospective_steps"
]
},
"attributes": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The name of the incident retrospective step"
},
"description": {
"type": "string",
"description": "The description of the incident retrospective step",
"nullable": true
},
"due_date": {
"type": "string",
"description": "Due date",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the step",
"nullable": true
},
"skippable": {
"type": "boolean",
"description": "Is the step skippable?",
"nullable": false
},
"status": {
"type": "string",
"description": "Status of the incident retrospective step",
"enum": [
"todo",
"in_progress",
"completed",
"skipped"
],
"nullable": false
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"incident_retrospective_step": {
"type": "object",
"properties": {
"retrospective_step_id": {
"type": "string"
},
"incident_id": {
"type": "string"
},
"title": {
"type": "string",
"description": "The name of the step"
},
"description": {
"type": "string",
"description": "The description of the step",
"nullable": true
},
"status": {
"type": "string",
"description": "Status of the incident retrospective step",
"enum": [
"todo",
"in_progress",
"completed",
"skipped"
],
"nullable": false
},
"kind": {
"type": "string",
"description": "Due date",
"nullable": true
},
"due_date": {
"type": "string",
"description": "Due date",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the step"
},
"skippable": {
"type": "boolean",
"description": "Is the step skippable?"
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"retrospective_step_id",
"incident_id",
"title",
"created_at",
"updated_at"
]
},
"incident_retrospective_step_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the step"
},
"type": {
"type": "string",
"enum": [
"incident_retrospective_steps"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_retrospective_step"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"new_incident_role_task": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_role_tasks"
]
},
"attributes": {
"type": "object",
"properties": {
"incident_role_id": {
"type": "string"
},
"task": {
"type": "string",
"description": "The task of the incident task"
},
"description": {
"type": "string",
"description": "The description of the incident task",
"nullable": true
},
"priority": {
"type": "string",
"description": "The priority of the incident task",
"enum": [
"high",
"medium",
"low"
]
}
},
"additionalProperties": false,
"required": [
"task"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_incident_role_task": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_role_tasks"
]
},
"attributes": {
"type": "object",
"properties": {
"task": {
"type": "string",
"description": "The task of the incident task"
},
"description": {
"type": "string",
"description": "The description of the incident task",
"nullable": true
},
"priority": {
"type": "string",
"description": "The priority of the incident task",
"enum": [
"high",
"medium",
"low"
]
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"incident_role_task": {
"type": "object",
"properties": {
"incident_role_id": {
"type": "string"
},
"task": {
"type": "string",
"description": "The task of the incident task"
},
"description": {
"type": "string",
"description": "The description of incident task",
"nullable": true
},
"priority": {
"type": "string",
"description": "The priority of the incident task",
"enum": [
"high",
"medium",
"low"
]
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"task",
"created_at",
"updated_at"
]
},
"incident_role_task_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident task"
},
"type": {
"type": "string",
"enum": [
"incident_role_tasks"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_role_task"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"incident_role_task_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident task"
},
"type": {
"type": "string",
"enum": [
"incident_role_tasks"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_role_task"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_incident_role": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_roles"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the incident role"
},
"summary": {
"type": "string",
"description": "The summary of the incident role",
"nullable": true
},
"description": {
"type": "string",
"description": "The description of the incident role",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the incident role",
"nullable": true
},
"optional": {
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"allow_multi_user_assignment": {
"type": "boolean"
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_incident_role": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_roles"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the incident role"
},
"summary": {
"type": "string",
"description": "The summary of the incident role",
"nullable": true
},
"description": {
"type": "string",
"description": "The description of the incident role",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the incident role",
"nullable": true
},
"optional": {
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"allow_multi_user_assignment": {
"type": "boolean"
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"incident_role": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the incident role"
},
"slug": {
"type": "string",
"description": "The slug of the incident role"
},
"summary": {
"type": "string",
"description": "The summary of the incident role",
"nullable": true
},
"description": {
"type": "string",
"description": "The description of the incident role",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the incident role",
"nullable": true
},
"optional": {
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"allow_multi_user_assignment": {
"type": "boolean"
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"name",
"created_at",
"updated_at"
]
},
"incident_role_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident role"
},
"type": {
"type": "string",
"enum": [
"incident_roles"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_role"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"incident_role_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident role"
},
"type": {
"type": "string",
"enum": [
"incident_roles"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_role"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_incident_status_page_event": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_status_page_events"
]
},
"attributes": {
"type": "object",
"properties": {
"event": {
"type": "string",
"description": "The summary of the incident event"
},
"status_page_id": {
"type": "string",
"description": "Unique ID of the status page you wish to post the event to"
},
"status": {
"type": "string",
"description": "The status of the incident event",
"enum": [
"investigating",
"identified",
"monitoring",
"resolved",
"scheduled",
"in_progress",
"completed"
]
},
"notify_subscribers": {
"type": "boolean",
"description": "Notify all status pages subscribers",
"default": false,
"nullable": true
},
"should_tweet": {
"type": "boolean",
"description": "For Statuspage.io integrated pages auto publishes a tweet for your update",
"default": false,
"nullable": true
},
"started_at": {
"type": "string",
"format": "date-time",
"description": "When the event started. Defaults to the time of creation.",
"nullable": true
}
},
"additionalProperties": false,
"required": [
"event"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_incident_status_page_event": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_status_page_events"
]
},
"attributes": {
"type": "object",
"properties": {
"event": {
"type": "string",
"description": "The summary of the incident event"
},
"status_page_id": {
"type": "string",
"description": "Unique ID of the status page you wish to post the event to"
},
"status": {
"type": "string",
"description": "The status of the incident event",
"enum": [
"investigating",
"identified",
"monitoring",
"resolved",
"scheduled",
"in_progress",
"completed"
]
},
"notify_subscribers": {
"type": "boolean",
"description": "Notify all status pages subscribers",
"default": false,
"nullable": true
},
"should_tweet": {
"type": "boolean",
"description": "For Statuspage.io integrated pages auto publishes a tweet for your update",
"default": false,
"nullable": true
},
"started_at": {
"type": "string",
"format": "date-time",
"description": "When the event started.",
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"incident_status_page_event": {
"type": "object",
"properties": {
"event": {
"type": "string",
"description": "The summary of the incident event"
},
"status_page_id": {
"type": "string",
"description": "Unique ID of the status page you wish to post the event to"
},
"status": {
"type": "string",
"description": "The status of the incident event",
"enum": [
"investigating",
"identified",
"monitoring",
"resolved",
"scheduled",
"in_progress",
"completed"
]
},
"notify_subscribers": {
"type": "boolean",
"description": "Notify all status pages subscribers"
},
"should_tweet": {
"type": "boolean",
"description": "For Statuspage.io integrated pages auto publishes a tweet for your update"
},
"started_at": {
"type": "string",
"description": "Date of start"
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"event",
"started_at",
"created_at",
"updated_at"
]
},
"incident_status_page_event_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident event"
},
"type": {
"type": "string",
"enum": [
"incident_status_page_events"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_status_page_event"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"incident_status_page_event_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident event"
},
"type": {
"type": "string",
"enum": [
"incident_status_page_events"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_status_page_event"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_incident_type": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_types"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the incident type"
},
"description": {
"type": "string",
"description": "The description of the incident type",
"nullable": true
},
"color": {
"type": "string",
"description": "The hex color of the incident type",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the incident type",
"nullable": true
},
"notify_emails": {
"type": "array",
"description": "Emails to attach to the incident type",
"items": {
"type": "string"
},
"nullable": true
},
"slack_channels": {
"type": "array",
"description": "Slack Channels associated with this incident type",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack channel ID"
},
"name": {
"type": "string",
"description": "Slack channel name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
},
"slack_aliases": {
"type": "array",
"description": "Slack Aliases associated with this incident type",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack alias ID"
},
"name": {
"type": "string",
"description": "Slack alias name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
},
"properties": {
"type": "array",
"items": {
"type": "object",
"description": "Set a value for a catalog property",
"properties": {
"catalog_property_id": {
"type": "string",
"description": "Catalog property ID"
},
"value": {
"type": "string",
"description": "The property value"
}
},
"required": [
"catalog_property_id",
"value"
]
},
"description": "Array of property values for this incident type."
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_incident_type": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_types"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the incident type"
},
"description": {
"type": "string",
"description": "The description of the incident type",
"nullable": true
},
"color": {
"type": "string",
"description": "The hex color of the incident type",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the incident type",
"nullable": true
},
"notify_emails": {
"type": "array",
"description": "Emails to attach to the incident type",
"items": {
"type": "string"
},
"nullable": true
},
"slack_channels": {
"type": "array",
"description": "Slack Channels associated with this incident type",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack channel ID"
},
"name": {
"type": "string",
"description": "Slack channel name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
},
"slack_aliases": {
"type": "array",
"description": "Slack Aliases associated with this incident type",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack alias ID"
},
"name": {
"type": "string",
"description": "Slack alias name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
},
"properties": {
"type": "array",
"items": {
"type": "object",
"description": "Set a value for a catalog property",
"properties": {
"catalog_property_id": {
"type": "string",
"description": "Catalog property ID"
},
"value": {
"type": "string",
"description": "The property value"
}
},
"required": [
"catalog_property_id",
"value"
]
},
"description": "Array of property values for this incident type."
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"incident_type": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the incident type"
},
"slug": {
"type": "string",
"description": "The slug of the incident type"
},
"description": {
"type": "string",
"description": "The description of the incident type",
"nullable": true
},
"color": {
"type": "string",
"description": "The hex color of the incident type",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the incident type",
"nullable": true
},
"notify_emails": {
"type": "array",
"description": "Emails to attach to the incident type",
"items": {
"type": "string"
},
"nullable": true
},
"slack_channels": {
"type": "array",
"description": "Slack Channels associated with this incident type",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack channel ID"
},
"name": {
"type": "string",
"description": "Slack channel name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
},
"slack_aliases": {
"type": "array",
"description": "Slack Aliases associated with this incident type",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack alias ID"
},
"name": {
"type": "string",
"description": "Slack alias name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
},
"properties": {
"type": "array",
"items": {
"type": "object",
"description": "Set a value for a catalog property",
"properties": {
"catalog_property_id": {
"type": "string",
"description": "Catalog property ID"
},
"value": {
"type": "string",
"description": "The property value"
}
},
"required": [
"catalog_property_id",
"value"
]
},
"description": "Array of property values for this incident type."
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"name",
"created_at",
"updated_at"
]
},
"incident_type_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident type"
},
"type": {
"type": "string",
"enum": [
"incident_types"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_type"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"incident_type_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident type"
},
"type": {
"type": "string",
"enum": [
"incident_types"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_type"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_incident": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incidents"
]
},
"attributes": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the incident. We will autogenerate one if null",
"nullable": true
},
"kind": {
"type": "string",
"description": "The kind of the incident",
"enum": [
"test",
"test_sub",
"example",
"example_sub",
"normal",
"normal_sub",
"backfilled",
"scheduled",
"scheduled_sub"
],
"default": "normal",
"nullable": true
},
"parent_incident_id": {
"type": "string",
"description": "ID of parent incident",
"nullable": true
},
"duplicate_incident_id": {
"type": "string",
"description": "ID of duplicated incident",
"nullable": true
},
"private": {
"type": "boolean",
"description": "Create an incident as private. Once an incident is made as private it cannot be undone",
"default": false,
"nullable": true
},
"summary": {
"type": "string",
"description": "The summary of the incident",
"nullable": true
},
"user_id": {
"type": "string",
"description": "User ID of the creator of the incident. Default to the user attached to the Api Key",
"nullable": true
},
"severity_id": {
"type": "string",
"description": "The Severity ID to attach to the incident",
"nullable": true
},
"public_title": {
"type": "string",
"description": "The public title of the incident",
"nullable": true
},
"alert_ids": {
"type": "array",
"description": "The Alert IDs to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
},
"environment_ids": {
"type": "array",
"description": "The Environment IDs to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
},
"incident_type_ids": {
"type": "array",
"description": "The Incident Type IDs to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
},
"service_ids": {
"type": "array",
"description": "The Service IDs to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
},
"functionality_ids": {
"type": "array",
"description": "The Functionality IDs to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
},
"group_ids": {
"type": "array",
"description": "The Team IDs to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
},
"cause_ids": {
"type": "array",
"description": "The Cause IDs to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
},
"muted_service_ids": {
"type": "array",
"description": "The Service IDs to mute alerts for during maintenance. Alerts for these services will still be triggered and attached to the incident, but won't page responders.",
"items": {
"type": "string"
},
"nullable": true
},
"labels": {
"type": "object",
"description": "Labels to attach to the incidents. eg: {\"platform\":\"osx\", \"version\": \"1.29\"}",
"nullable": true
},
"slack_channel_name": {
"type": "string",
"description": "Slack channel name",
"nullable": true
},
"slack_channel_id": {
"type": "string",
"description": "Slack channel id",
"nullable": true
},
"slack_channel_url": {
"type": "string",
"description": "Slack channel url",
"nullable": true
},
"slack_channel_archived": {
"type": "boolean",
"description": "Whether the Slack channel is archived",
"nullable": true
},
"google_drive_parent_id": {
"type": "string",
"description": "Google Drive parent folder ID",
"nullable": true
},
"google_drive_url": {
"type": "string",
"description": "Google Drive URL",
"nullable": true
},
"jira_issue_key": {
"type": "string",
"description": "Jira issue key",
"nullable": true
},
"jira_issue_id": {
"type": "string",
"description": "Jira issue ID",
"nullable": true
},
"jira_issue_url": {
"type": "string",
"description": "Jira issue URL",
"nullable": true
},
"notify_emails": {
"type": "array",
"description": "Emails you want to notify",
"items": {
"type": "string"
},
"nullable": true
},
"status": {
"type": "string",
"description": "The status of the incident",
"enum": [
"in_triage",
"started",
"detected",
"acknowledged",
"mitigated",
"resolved",
"closed",
"cancelled",
"scheduled",
"in_progress",
"completed"
]
},
"url": {
"type": "string",
"description": "The url to the incident"
},
"scheduled_for": {
"type": "string",
"description": "Date of when the maintenance begins",
"nullable": true
},
"scheduled_until": {
"type": "string",
"description": "Date of when the maintenance ends",
"nullable": true
},
"in_triage_at": {
"type": "string",
"description": "Date of triage",
"nullable": true
},
"started_at": {
"type": "string",
"description": "Date of start",
"nullable": true
},
"detected_at": {
"type": "string",
"description": "Date of detection",
"nullable": true
},
"acknowledged_at": {
"type": "string",
"description": "Date of acknowledgment",
"nullable": true
},
"mitigated_at": {
"type": "string",
"description": "Date of mitigation",
"nullable": true
},
"resolved_at": {
"type": "string",
"description": "Date of resolution",
"nullable": true
},
"closed_at": {
"type": "string",
"description": "Date of closure",
"nullable": true
},
"cancelled_at": {
"type": "string",
"description": "Date of cancellation",
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_incident": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incidents"
]
},
"attributes": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the incident",
"nullable": true
},
"kind": {
"type": "string",
"description": "The kind of the incident",
"enum": [
"test",
"test_sub",
"example",
"example_sub",
"normal",
"normal_sub",
"backfilled",
"scheduled",
"scheduled_sub"
],
"default": "normal",
"nullable": true
},
"parent_incident_id": {
"type": "string",
"description": "ID of parent incident",
"nullable": true
},
"duplicate_incident_id": {
"type": "string",
"description": "ID of duplicated incident",
"nullable": true
},
"summary": {
"type": "string",
"description": "The summary of the incident",
"nullable": true
},
"status": {
"type": "string",
"description": "The status of the incident",
"enum": [
"in_triage",
"started",
"detected",
"acknowledged",
"mitigated",
"resolved",
"closed",
"cancelled",
"scheduled",
"in_progress",
"completed"
],
"nullable": true
},
"private": {
"type": "boolean",
"description": "Convert the incident as private. Once an incident is updated as private it cannot be undone",
"default": false,
"nullable": true
},
"severity_id": {
"type": "string",
"description": "The Severity ID to attach to the incident",
"nullable": true
},
"public_title": {
"type": "string",
"description": "The public title of the incident",
"nullable": true
},
"alert_ids": {
"type": "array",
"description": "The Alert IDs to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
},
"environment_ids": {
"type": "array",
"description": "The Environment IDs to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
},
"incident_type_ids": {
"type": "array",
"description": "The Incident Type IDs to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
},
"service_ids": {
"type": "array",
"description": "The Service IDs to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
},
"functionality_ids": {
"type": "array",
"description": "The Functionality IDs to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
},
"muted_service_ids": {
"type": "array",
"description": "The Service IDs to mute alerts for during maintenance. Alerts for these services will still be triggered and attached to the incident, but won't page responders.",
"items": {
"type": "string"
},
"nullable": true
},
"group_ids": {
"type": "array",
"description": "The Team IDs to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
},
"cause_ids": {
"type": "array",
"description": "The Cause IDs to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
},
"labels": {
"type": "object",
"description": "Labels to attach to the incidents. eg: {\"platform\":\"osx\", \"version\": \"1.29\"}",
"nullable": true
},
"slack_channel_id": {
"type": "string",
"description": "Slack channel id",
"nullable": true
},
"slack_channel_name": {
"type": "string",
"description": "Slack channel name",
"nullable": true
},
"slack_channel_url": {
"type": "string",
"description": "Slack channel url",
"nullable": true
},
"slack_channel_archived": {
"type": "boolean",
"description": "Whether the Slack channel is archived",
"nullable": true
},
"google_drive_parent_id": {
"type": "string",
"description": "Google Drive parent folder ID",
"nullable": true
},
"google_drive_url": {
"type": "string",
"description": "Google Drive URL",
"nullable": true
},
"jira_issue_key": {
"type": "string",
"description": "Jira issue key",
"nullable": true
},
"jira_issue_id": {
"type": "string",
"description": "Jira issue ID",
"nullable": true
},
"jira_issue_url": {
"type": "string",
"description": "Jira issue URL",
"nullable": true
},
"scheduled_for": {
"type": "string",
"description": "Date of when the maintenance begins",
"nullable": true
},
"scheduled_until": {
"type": "string",
"description": "Date of when the maintenance ends",
"nullable": true
},
"in_triage_at": {
"type": "string",
"description": "Date of triage",
"nullable": true
},
"started_at": {
"type": "string",
"description": "Date of start",
"nullable": true
},
"detected_at": {
"type": "string",
"description": "Date of detection",
"nullable": true
},
"acknowledged_at": {
"type": "string",
"description": "Date of acknowledgment",
"nullable": true
},
"mitigated_at": {
"type": "string",
"description": "Date of mitigation",
"nullable": true
},
"resolved_at": {
"type": "string",
"description": "Date of resolution",
"nullable": true
},
"closed_at": {
"type": "string",
"description": "Date of closure",
"nullable": true
},
"cancelled_at": {
"type": "string",
"description": "Date of cancellation",
"nullable": true
},
"mitigation_message": {
"type": "string",
"description": "How was the incident mitigated?",
"nullable": true
},
"resolution_message": {
"type": "string",
"description": "How was the incident resolved?",
"nullable": true
},
"cancellation_message": {
"type": "string",
"description": "Why was the incident cancelled?",
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"in_triage_incident": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incidents"
]
}
},
"required": [
"type"
]
}
},
"required": [
"data"
]
},
"restart_incident": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incidents"
]
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": false
}
},
"required": [
"type"
]
}
},
"required": [
"data"
]
},
"mitigate_incident": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incidents"
]
},
"attributes": {
"type": "object",
"properties": {
"mitigation_message": {
"type": "string",
"description": "How was the incident mitigated?",
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"resolve_incident": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incidents"
]
},
"attributes": {
"type": "object",
"properties": {
"resolution_message": {
"type": "string",
"description": "How was the incident resolved?",
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"cancel_incident": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incidents"
]
},
"attributes": {
"type": "object",
"properties": {
"cancellation_message": {
"type": "string",
"description": "Why was the incident cancelled?",
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"duplicate_incident": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incidents"
]
},
"attributes": {
"type": "object",
"properties": {
"duplicate_incident_id": {
"type": "string"
},
"auto_cancel_incident": {
"type": "boolean",
"default": true,
"nullable": true
},
"reason_for_cancellation": {
"type": "string",
"description": "Why was the incident cancelled?",
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"add_subscribers": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incidents"
]
},
"attributes": {
"type": "object",
"properties": {
"user_ids": {
"type": "array",
"description": "IDs of users you wish to add to list of subscribers for this incident",
"items": {
"type": "string"
},
"nullable": true
},
"remove_users_with_no_private_incident_access": {
"description": "Users without read permissions for private incidents will be removed from the subscriber list of this incident",
"type": "boolean",
"default": false,
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"remove_subscribers": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incidents"
]
},
"attributes": {
"type": "object",
"properties": {
"user_ids": {
"type": "array",
"description": "IDs of users you wish to remove from the list of subscribers for this incident",
"items": {
"type": "string"
},
"nullable": true
},
"remove_users_with_no_private_incident_access": {
"description": "Users without read permissions for private incidents will be removed from the subscriber list of this incident",
"type": "boolean",
"default": false,
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"assign_role_to_user": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incidents"
]
},
"attributes": {
"type": "object",
"properties": {
"user_id": {
"type": "string",
"description": "ID of user you wish to assign this incident",
"nullable": false
},
"incident_role_id": {
"type": "string",
"description": "ID of the incident role",
"nullable": false
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"unassign_role_from_user": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incidents"
]
},
"attributes": {
"type": "object",
"properties": {
"user_id": {
"type": "string",
"description": "ID of user you wish to remove as assigned user from this incident",
"nullable": false
},
"incident_role_id": {
"type": "string",
"description": "ID of the incident role",
"nullable": false
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"incident": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident"
},
"sequential_id": {
"type": "integer",
"description": "Sequential ID of the incident"
},
"title": {
"type": "string",
"description": "The title of the incident"
},
"kind": {
"type": "string",
"description": "The kind of the incident"
},
"slug": {
"type": "string",
"description": "The slug of the incident"
},
"parent_incident_id": {
"type": "string",
"description": "ID of parent incident",
"nullable": true
},
"duplicate_incident_id": {
"type": "string",
"description": "ID of duplicated incident",
"nullable": true
},
"summary": {
"type": "string",
"description": "The summary of the incident",
"nullable": true
},
"private": {
"type": "boolean",
"description": "The visibility of the incident",
"default": false
},
"source": {
"type": "string",
"description": "The source of the incident",
"nullable": true
},
"status": {
"type": "string",
"description": "The status of the incident",
"nullable": true
},
"url": {
"type": "string",
"description": "The url to the incident",
"nullable": true
},
"short_url": {
"type": "string",
"description": "The short url to the incident",
"nullable": true
},
"public_title": {
"type": "string",
"description": "The public title of the incident",
"nullable": true
},
"user": {
"type": "object",
"description": "The user who created the incident",
"nullable": true
},
"severity": {
"type": "object",
"description": "The Severity of the incident",
"allOf": [
{
"$ref": "#/components/schemas/severity_response"
}
],
"nullable": true
},
"environments": {
"type": "array",
"description": "The Environments of the incident",
"items": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/environment_response"
}
]
},
"nullable": true
},
"incident_types": {
"type": "array",
"description": "The Incident Types of the incident",
"items": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_type_response"
}
]
},
"nullable": true
},
"services": {
"type": "array",
"description": "The Services of the incident",
"items": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/service_response"
}
]
},
"nullable": true
},
"functionalities": {
"type": "array",
"description": "The Functionalities of the incident",
"items": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/functionality_response"
}
]
},
"nullable": true
},
"groups": {
"type": "array",
"description": "The Teams of to the incident",
"items": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/team_response"
}
]
},
"nullable": true
},
"labels": {
"type": "object",
"description": "Labels to attach to the incidents. eg: {\"platform\":\"osx\", \"version\": \"1.29\"}",
"nullable": true
},
"slack_channel_id": {
"type": "string",
"description": "Slack channel id",
"nullable": true
},
"slack_channel_name": {
"type": "string",
"description": "Slack channel name",
"nullable": true
},
"slack_channel_url": {
"type": "string",
"description": "Slack channel url",
"nullable": true
},
"slack_channel_short_url": {
"type": "string",
"description": "Slack channel short url",
"nullable": true
},
"slack_channel_deep_link": {
"type": "string",
"description": "Slack channel deep link",
"nullable": true
},
"slack_channel_archived": {
"type": "boolean",
"description": "Whether the Slack channel is archived",
"nullable": true
},
"slack_last_message_ts": {
"type": "string",
"description": "Timestamp of last Slack message",
"nullable": true
},
"zoom_meeting_id": {
"type": "string",
"description": "Zoom meeting ID",
"nullable": true
},
"zoom_meeting_start_url": {
"type": "string",
"description": "Zoom meeting start URL",
"nullable": true
},
"zoom_meeting_join_url": {
"type": "string",
"description": "Zoom meeting join URL",
"nullable": true
},
"zoom_meeting_password": {
"type": "string",
"description": "Zoom meeting password",
"nullable": true
},
"zoom_meeting_pstn_password": {
"type": "string",
"description": "Zoom meeting PSTN password",
"nullable": true
},
"zoom_meeting_h323_password": {
"type": "string",
"description": "Zoom meeting H323 password",
"nullable": true
},
"zoom_meeting_global_dial_in_numbers": {
"type": "array",
"description": "Zoom meeting global dial-in numbers",
"items": {
"type": "object",
"properties": {
"country": {
"type": "string"
},
"country_name": {
"type": "string"
},
"city": {
"type": "string"
},
"number": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"nullable": true
},
"google_drive_id": {
"type": "string",
"description": "Google Drive document ID",
"nullable": true
},
"google_drive_parent_id": {
"type": "string",
"description": "Google Drive parent folder ID",
"nullable": true
},
"google_drive_url": {
"type": "string",
"description": "Google Drive URL",
"nullable": true
},
"google_meeting_id": {
"type": "string",
"description": "Google meeting ID",
"nullable": true
},
"google_meeting_url": {
"type": "string",
"description": "Google meeting URL",
"nullable": true
},
"microsoft_teams_meeting_id": {
"type": "string",
"description": "Microsoft Teams meeting ID",
"nullable": true
},
"microsoft_teams_meeting_url": {
"type": "string",
"description": "Microsoft Teams meeting URL",
"nullable": true
},
"microsoft_teams_channel_id": {
"type": "string",
"description": "Microsoft Teams channel ID",
"nullable": true
},
"microsoft_teams_channel_name": {
"type": "string",
"description": "Microsoft Teams channel name",
"nullable": true
},
"microsoft_teams_channel_url": {
"type": "string",
"description": "Microsoft Teams channel URL",
"nullable": true
},
"microsoft_teams_channel_short_url": {
"type": "string",
"description": "Microsoft Teams channel short URL",
"nullable": true
},
"microsoft_teams_chat_id": {
"type": "string",
"description": "Microsoft Teams chat ID",
"nullable": true
},
"microsoft_teams_chat_url": {
"type": "string",
"description": "Microsoft Teams chat URL",
"nullable": true
},
"microsoft_teams_team_id": {
"type": "string",
"description": "Microsoft Teams team ID",
"nullable": true
},
"google_chat_space_id": {
"type": "string",
"description": "Google Chat space ID",
"nullable": true
},
"google_chat_space_name": {
"type": "string",
"description": "Google Chat space name",
"nullable": true
},
"google_chat_space_url": {
"type": "string",
"description": "Google Chat space URL",
"nullable": true
},
"google_chat_space_short_url": {
"type": "string",
"description": "Google Chat space short URL",
"nullable": true
},
"google_chat_space_archived": {
"type": "boolean",
"description": "Whether the Google Chat space is archived",
"nullable": true
},
"google_chat_space_domain_id": {
"type": "string",
"description": "Google Chat space domain ID",
"nullable": true
},
"webex_meeting_id": {
"type": "string",
"description": "Webex meeting ID",
"nullable": true
},
"webex_meeting_url": {
"type": "string",
"description": "Webex meeting URL",
"nullable": true
},
"jira_issue_key": {
"type": "string",
"description": "Jira issue key",
"nullable": true
},
"jira_issue_id": {
"type": "string",
"description": "Jira issue ID",
"nullable": true
},
"jira_issue_url": {
"type": "string",
"description": "Jira issue URL",
"nullable": true
},
"github_issue_id": {
"type": "string",
"description": "GitHub issue ID",
"nullable": true
},
"github_issue_url": {
"type": "string",
"description": "GitHub issue URL",
"nullable": true
},
"gitlab_issue_id": {
"type": "string",
"description": "GitLab issue ID",
"nullable": true
},
"gitlab_issue_url": {
"type": "string",
"description": "GitLab issue URL",
"nullable": true
},
"asana_task_id": {
"type": "string",
"description": "Asana task ID",
"nullable": true
},
"asana_task_url": {
"type": "string",
"description": "Asana task URL",
"nullable": true
},
"linear_issue_id": {
"type": "string",
"description": "Linear issue ID",
"nullable": true
},
"linear_issue_url": {
"type": "string",
"description": "Linear issue URL",
"nullable": true
},
"trello_card_id": {
"type": "string",
"description": "Trello card ID",
"nullable": true
},
"trello_card_url": {
"type": "string",
"description": "Trello card URL",
"nullable": true
},
"zendesk_ticket_id": {
"type": "string",
"description": "Zendesk ticket ID",
"nullable": true
},
"zendesk_ticket_url": {
"type": "string",
"description": "Zendesk ticket URL",
"nullable": true
},
"pagerduty_incident_id": {
"type": "string",
"description": "PagerDuty incident ID",
"nullable": true
},
"pagerduty_incident_number": {
"type": "string",
"description": "PagerDuty incident number",
"nullable": true
},
"pagerduty_incident_url": {
"type": "string",
"description": "PagerDuty incident URL",
"nullable": true
},
"opsgenie_incident_id": {
"type": "string",
"description": "Opsgenie incident ID",
"nullable": true
},
"opsgenie_incident_url": {
"type": "string",
"description": "Opsgenie incident URL",
"nullable": true
},
"opsgenie_alert_id": {
"type": "string",
"description": "Opsgenie alert ID",
"nullable": true
},
"opsgenie_alert_url": {
"type": "string",
"description": "Opsgenie alert URL",
"nullable": true
},
"service_now_incident_id": {
"type": "string",
"description": "ServiceNow incident ID",
"nullable": true
},
"service_now_incident_key": {
"type": "string",
"description": "ServiceNow incident key",
"nullable": true
},
"service_now_incident_url": {
"type": "string",
"description": "ServiceNow incident URL",
"nullable": true
},
"mattermost_channel_id": {
"type": "string",
"description": "Mattermost channel ID",
"nullable": true
},
"mattermost_channel_name": {
"type": "string",
"description": "Mattermost channel name",
"nullable": true
},
"mattermost_channel_url": {
"type": "string",
"description": "Mattermost channel URL",
"nullable": true
},
"confluence_page_id": {
"type": "string",
"description": "Confluence page ID",
"nullable": true
},
"confluence_page_url": {
"type": "string",
"description": "Confluence page URL",
"nullable": true
},
"datadog_notebook_id": {
"type": "string",
"description": "Datadog notebook ID",
"nullable": true
},
"datadog_notebook_url": {
"type": "string",
"description": "Datadog notebook URL",
"nullable": true
},
"shortcut_story_id": {
"type": "string",
"description": "Shortcut story ID",
"nullable": true
},
"shortcut_story_url": {
"type": "string",
"description": "Shortcut story URL",
"nullable": true
},
"shortcut_task_id": {
"type": "string",
"description": "Shortcut task ID",
"nullable": true
},
"shortcut_task_url": {
"type": "string",
"description": "Shortcut task URL",
"nullable": true
},
"motion_task_id": {
"type": "string",
"description": "Motion task ID",
"nullable": true
},
"motion_task_url": {
"type": "string",
"description": "Motion task URL",
"nullable": true
},
"clickup_task_id": {
"type": "string",
"description": "ClickUp task ID",
"nullable": true
},
"clickup_task_url": {
"type": "string",
"description": "ClickUp task URL",
"nullable": true
},
"victor_ops_incident_id": {
"type": "string",
"description": "VictorOps incident ID",
"nullable": true
},
"victor_ops_incident_url": {
"type": "string",
"description": "VictorOps incident URL",
"nullable": true
},
"quip_page_id": {
"type": "string",
"description": "Quip page ID",
"nullable": true
},
"quip_page_url": {
"type": "string",
"description": "Quip page URL",
"nullable": true
},
"sharepoint_page_id": {
"type": "string",
"description": "SharePoint page ID",
"nullable": true
},
"sharepoint_page_url": {
"type": "string",
"description": "SharePoint page URL",
"nullable": true
},
"airtable_base_key": {
"type": "string",
"description": "Airtable base key",
"nullable": true
},
"airtable_table_name": {
"type": "string",
"description": "Airtable table name",
"nullable": true
},
"airtable_record_id": {
"type": "string",
"description": "Airtable record ID",
"nullable": true
},
"airtable_record_url": {
"type": "string",
"description": "Airtable record URL",
"nullable": true
},
"freshservice_ticket_id": {
"type": "string",
"description": "Freshservice ticket ID",
"nullable": true
},
"freshservice_ticket_url": {
"type": "string",
"description": "Freshservice ticket URL",
"nullable": true
},
"freshservice_task_id": {
"type": "string",
"description": "Freshservice task ID",
"nullable": true
},
"freshservice_task_url": {
"type": "string",
"description": "Freshservice task URL",
"nullable": true
},
"mitigation_message": {
"type": "string",
"description": "How was the incident mitigated?",
"nullable": true
},
"resolution_message": {
"type": "string",
"description": "How was the incident resolved?",
"nullable": true
},
"cancellation_message": {
"type": "string",
"description": "Why was the incident cancelled?",
"nullable": true
},
"scheduled_for": {
"type": "string",
"description": "Date of when the maintenance begins",
"nullable": true
},
"scheduled_until": {
"type": "string",
"description": "Date of when the maintenance ends",
"nullable": true
},
"muted_service_ids": {
"type": "array",
"description": "The Service IDs to mute alerts for during maintenance. Alerts for these services will still be triggered and attached to the incident, but won't page responders.",
"items": {
"type": "string"
},
"nullable": true
},
"retrospective_progress_status": {
"type": "string",
"description": "The status of the retrospective progress",
"nullable": true,
"enum": [
"not_started",
"active",
"completed",
"skipped"
]
},
"in_triage_by": {
"type": "object",
"description": "The user who triaged the incident",
"nullable": true
},
"started_by": {
"type": "object",
"description": "The user who started the incident",
"nullable": true
},
"mitigated_by": {
"type": "object",
"description": "The user who mitigated the incident",
"nullable": true
},
"resolved_by": {
"type": "object",
"description": "The user who resolved the incident",
"nullable": true
},
"closed_by": {
"type": "object",
"description": "The user who closed the incident",
"nullable": true
},
"cancelled_by": {
"type": "object",
"description": "The user who cancelled the incident",
"nullable": true
},
"in_triage_at": {
"type": "string",
"description": "Date of triage",
"nullable": true
},
"started_at": {
"type": "string",
"description": "Date of start",
"nullable": true
},
"detected_at": {
"type": "string",
"description": "Date of detection",
"nullable": true
},
"acknowledged_at": {
"type": "string",
"description": "Date of acknowledgment",
"nullable": true
},
"mitigated_at": {
"type": "string",
"description": "Date of mitigation",
"nullable": true
},
"resolved_at": {
"type": "string",
"description": "Date of resolution",
"nullable": true
},
"closed_at": {
"type": "string",
"description": "Date of closure",
"nullable": true
},
"cancelled_at": {
"type": "string",
"description": "Date of cancellation",
"nullable": true
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"title",
"created_at",
"updated_at"
]
},
"incident_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident"
},
"type": {
"type": "string",
"enum": [
"incidents"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"incident_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident"
},
"type": {
"type": "string",
"enum": [
"incidents"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"ip_ranges": {
"type": "object",
"properties": {
"integrations_ipv4": {
"type": "array",
"description": "IPv4 addresses associated with Rootly integrations.",
"items": {
"type": "string"
}
},
"integrations_ipv6": {
"type": "array",
"description": "IPv6 addresses associated with Rootly integrations.",
"items": {
"type": "string"
}
},
"webhooks_ipv4": {
"type": "array",
"description": "IPv4 addresses associated with Rootly webhooks.",
"items": {
"type": "string"
}
},
"webhooks_ipv6": {
"type": "array",
"description": "IPv6 addresses associated with Rootly webhooks.",
"items": {
"type": "string"
}
}
},
"required": [
"integrations_ipv4",
"integrations_ipv6",
"webhooks_ipv4",
"webhooks_ipv6"
]
},
"ip_ranges_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the ip_ranges"
},
"type": {
"type": "string",
"enum": [
"ip_ranges"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ip_ranges"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
},
"first": {
"type": "string"
},
"prev": {
"type": "string",
"nullable": true
},
"next": {
"type": "string",
"nullable": true
},
"last": {
"type": "string",
"nullable": true
}
},
"required": [
"self",
"first",
"prev",
"next",
"last"
]
},
"import_meeting_recording": {
"type": "object",
"properties": {
"source": {
"type": "string",
"description": "Import source (currently only \"recall_desktop_sdk\")",
"enum": [
"recall_desktop_sdk"
]
},
"recall_recording_id": {
"type": "string",
"format": "uuid",
"description": "External recording UUID (required when source is recall_desktop_sdk)"
},
"platform": {
"type": "string",
"description": "Meeting platform",
"enum": [
"zoom",
"google_meet",
"microsoft_teams",
"webex"
]
},
"started_at": {
"type": "string",
"format": "date-time",
"description": "When the recording started",
"nullable": true
},
"ended_at": {
"type": "string",
"format": "date-time",
"description": "When the recording ended",
"nullable": true
},
"meeting_url": {
"type": "string",
"description": "Original meeting URL",
"nullable": true
}
},
"required": [
"source",
"recall_recording_id",
"platform"
]
},
"start_session_request": {
"type": "object",
"properties": {
"platform": {
"type": "string",
"description": "Meeting platform",
"enum": [
"zoom",
"google_meet",
"microsoft_teams",
"webex"
]
},
"title": {
"type": "string",
"description": "Human-readable label for the recording session",
"nullable": true
}
}
},
"start_session_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"session_id": {
"type": "string",
"format": "uuid",
"description": "Meeting recording UUID"
},
"stream_token": {
"type": "string",
"description": "Token for the desktop client to stream audio"
},
"meeting_recording_id": {
"type": "string",
"format": "uuid",
"description": "Meeting recording UUID"
}
},
"required": [
"session_id",
"stream_token",
"meeting_recording_id"
]
}
}
},
"meeting_recording": {
"type": "object",
"properties": {
"platform": {
"type": "string",
"description": "Meeting platform",
"enum": [
"zoom",
"google_meet",
"microsoft_teams",
"webex"
]
},
"session_number": {
"type": "integer",
"description": "Session number within the incident for this platform (starts at 1, increments on re-invite)"
},
"status": {
"type": "string",
"description": "Current recording lifecycle status",
"enum": [
"pending",
"recording",
"paused",
"call_ended",
"analyzing",
"completed",
"failed"
]
},
"started_at": {
"type": "string",
"format": "date-time",
"description": "When the bot started recording (null if bot never joined)",
"nullable": true
},
"ended_at": {
"type": "string",
"format": "date-time",
"description": "When the recording ended",
"nullable": true
},
"duration_minutes": {
"type": "number",
"description": "Recording duration in minutes (null if not started)",
"nullable": true
},
"speaker_count": {
"type": "integer",
"description": "Number of unique speakers detected in the transcript"
},
"word_count": {
"type": "integer",
"description": "Total word count across all transcript segments"
},
"transcript_summary": {
"type": "string",
"description": "AI-generated summary of the meeting transcript (null if no transcript or not yet analyzed)",
"nullable": true
},
"title": {
"type": "string",
"description": "Human-readable label for the recording session",
"nullable": true
},
"video_url": {
"type": "string",
"nullable": true,
"description": "Signed URL to stream/download the video recording"
},
"created_by": {
"type": "string",
"description": "Source that created the recording (e.g. desktop_sdk, recall_bot)",
"nullable": true
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "When the recording session was created"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "When the recording session was last updated"
}
},
"required": [
"platform",
"session_number",
"status",
"created_at",
"updated_at"
]
},
"meeting_recording_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique UUID of the meeting recording"
},
"type": {
"type": "string",
"enum": [
"meeting_recordings"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meeting_recording"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"meta": {
"type": "object",
"properties": {
"next_cursor": {
"type": "string",
"nullable": true
},
"current_page": {
"type": "integer",
"nullable": true
},
"next_page": {
"type": "integer",
"nullable": true
},
"prev_page": {
"type": "integer",
"nullable": true
},
"total_count": {
"type": "integer"
},
"total_pages": {
"type": "integer"
}
},
"required": [
"current_page",
"next_page",
"prev_page",
"total_count",
"total_pages"
]
},
"oncall": {
"type": "object",
"properties": {
"escalation_policy_id": {
"type": "string",
"description": "ID of the escalation policy"
},
"escalation_policy_name": {
"type": "string",
"description": "Name of the escalation policy"
},
"escalation_policy_path_id": {
"type": "string",
"nullable": true,
"description": "ID of the escalation policy path"
},
"escalation_policy_path_name": {
"type": "string",
"nullable": true,
"description": "Name of the escalation policy path"
},
"notification_type": {
"type": "string",
"enum": [
"audible",
"quiet"
],
"nullable": true,
"description": "Notification type of the escalation path (audible or quiet)"
},
"is_default_path": {
"type": "boolean",
"nullable": true,
"description": "Whether this is the default escalation path"
},
"escalation_level": {
"type": "integer",
"description": "Level within the escalation policy"
},
"schedule_id": {
"type": "string",
"description": "ID of the schedule",
"nullable": true
},
"schedule_name": {
"type": "string",
"description": "Name of the schedule",
"nullable": true
},
"user_id": {
"type": "integer",
"description": "ID of the on-call user"
},
"starts_at": {
"type": "string",
"format": "date-time",
"description": "Start datetime of the on-call shift"
},
"ends_at": {
"type": "string",
"format": "date-time",
"description": "End datetime of the on-call shift"
}
},
"required": [
"escalation_policy_id",
"escalation_policy_name",
"user_id",
"starts_at",
"ends_at"
]
},
"oncall_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the on-call entry"
},
"type": {
"type": "string",
"enum": [
"on_call_resources"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/oncall"
}
]
},
"relationships": {
"$ref": "#/components/schemas/oncall_relationships"
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"oncall_relationships": {
"type": "object",
"properties": {
"user": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"users"
]
}
},
"nullable": true
}
}
},
"schedule": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"schedules"
]
}
},
"nullable": true
}
}
},
"escalation_policy": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"escalation_policies"
]
}
},
"nullable": true
}
}
}
}
},
"new_on_call_pay_report": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"on_call_pay_reports"
]
},
"attributes": {
"type": "object",
"properties": {
"start_date": {
"type": "string",
"format": "date",
"description": "The start date for the report period."
},
"end_date": {
"type": "string",
"format": "date",
"description": "The end date for the report period."
},
"schedule_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of schedule UUIDs to scope the report."
},
"time_zone": {
"type": "string",
"description": "IANA timezone used to compute day and weekend boundaries. Defaults to the team's timezone."
},
"use_responders_time_zone": {
"type": "boolean",
"description": "When true, day and weekend boundaries are computed in each responder's personal timezone instead of the report-wide timezone."
}
},
"additionalProperties": false,
"required": [
"start_date",
"end_date"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_on_call_pay_report": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"on_call_pay_reports"
]
},
"attributes": {
"type": "object",
"properties": {
"start_date": {
"type": "string",
"format": "date",
"description": "The start date for the report period."
},
"end_date": {
"type": "string",
"format": "date",
"description": "The end date for the report period."
},
"schedule_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of schedule UUIDs to scope the report."
},
"time_zone": {
"type": "string",
"description": "IANA timezone used to compute day and weekend boundaries."
},
"use_responders_time_zone": {
"type": "boolean",
"description": "When true, day and weekend boundaries are computed in each responder's personal timezone instead of the report-wide timezone."
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"on_call_pay_report": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"processing",
"generated",
"downloaded"
],
"description": "The current status of the report."
},
"start_date": {
"type": "string",
"format": "date",
"description": "The start date of the report period."
},
"end_date": {
"type": "string",
"format": "date",
"description": "The end date of the report period."
},
"total_duration": {
"type": "integer",
"description": "Total on-call duration in seconds."
},
"users_count": {
"type": "integer",
"description": "Number of users included in the report."
},
"currency": {
"type": "string",
"description": "The currency code for monetary values."
},
"pay_type": {
"type": "string",
"enum": [
"hourly",
"daily"
],
"description": "The pay calculation type."
},
"hourly_rate_cents": {
"type": "integer",
"description": "Hourly pay rate in cents."
},
"daily_rate_cents": {
"type": "integer",
"description": "Daily pay rate in cents."
},
"total_pay_cents": {
"type": "integer",
"description": "Total pay amount in cents."
},
"include_shadow": {
"type": "boolean",
"description": "Whether shadow shifts are included."
},
"show_individual_shift_data": {
"type": "boolean",
"description": "Whether individual shift data is shown."
},
"has_single_rate": {
"type": "boolean",
"description": "Whether a single rate is applied to all users."
},
"enabled_granular_time_breakdown": {
"type": "boolean",
"description": "Whether granular time breakdown is enabled."
},
"last_generated_at": {
"type": "string",
"format": "date-time",
"description": "When the report was last generated.",
"nullable": true
},
"time_zone": {
"type": "string",
"description": "The IANA timezone used to compute day and weekend boundaries for this report. Defaults to the team's timezone.",
"nullable": true
},
"use_responders_time_zone": {
"type": "boolean",
"description": "When true, each responder's personal timezone is used for their pay calculation; otherwise the report-wide time_zone is used."
},
"csv_file_url": {
"type": "string",
"format": "uri",
"description": "Download URL for the generated CSV report. Null until the report is generated.",
"nullable": true
},
"xlsx_file_url": {
"type": "string",
"format": "uri",
"description": "Download URL for the generated XLSX report. Null until the report is generated.",
"nullable": true
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
}
},
"required": [
"status",
"start_date",
"end_date",
"created_at",
"updated_at"
]
},
"on_call_pay_report_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the on_call_pay_report"
},
"type": {
"type": "string",
"enum": [
"on_call_pay_reports"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/on_call_pay_report"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"on_call_pay_report_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the on_call_pay_report"
},
"type": {
"type": "string",
"enum": [
"on_call_pay_reports"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/on_call_pay_report"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_on_call_shadow": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"on_call_shadows"
]
},
"attributes": {
"type": "object",
"properties": {
"shadowable_type": {
"type": "string",
"enum": [
"User",
"Schedule"
]
},
"shadowable_id": {
"type": "string",
"description": "ID of schedule or user the shadow user is shadowing",
"nullable": false
},
"shadow_user_id": {
"type": "integer",
"description": "Which user the shadow shift belongs to.",
"nullable": false
},
"starts_at": {
"type": "string",
"description": "Start datetime of shadow shift",
"format": "date-time",
"nullable": false
},
"ends_at": {
"type": "string",
"description": "End datetime for shadow shift",
"format": "date-time",
"nullable": false
}
},
"additionalProperties": false,
"required": [
"shadowable_type",
"shadow_user_id",
"shadowable_id",
"starts_at",
"ends_at"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_on_call_shadow": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"on_call_shadows"
]
},
"attributes": {
"type": "object",
"properties": {
"schedule_id": {
"type": "string",
"description": "ID of schedule the shadow shift belongs to",
"nullable": false
},
"shadowable_type": {
"type": "string",
"enum": [
"User",
"Schedule"
]
},
"shadowable_id": {
"type": "string",
"description": "ID of schedule or user the shadow user is shadowing",
"nullable": false
},
"shadow_user_id": {
"type": "integer",
"description": "Which user the shadow shift belongs to.",
"nullable": false
},
"starts_at": {
"type": "string",
"description": "Start datetime of shadow shift",
"format": "date-time",
"nullable": false
},
"ends_at": {
"type": "string",
"description": "End datetime for shadow shift",
"format": "date-time",
"nullable": false
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"on_call_shadow": {
"type": "object",
"properties": {
"schedule_id": {
"type": "string",
"description": "ID of schedule the shadow shift belongs to",
"nullable": false
},
"shadowable_type": {
"type": "string",
"enum": [
"User",
"Schedule"
]
},
"shadowable_id": {
"type": "string",
"description": "ID of schedule or user the shadow user is shadowing",
"nullable": false
},
"shadow_user_id": {
"type": "integer",
"description": "Which user the shadow shift belongs to.",
"nullable": false
},
"starts_at": {
"type": "string",
"description": "Start datetime of shadow shift",
"format": "date-time",
"nullable": false
},
"ends_at": {
"type": "string",
"description": "End datetime for shadow shift",
"format": "date-time",
"nullable": false
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"schedule_id",
"shadowable_type",
"shadow_user_id",
"shadowable_id",
"starts_at",
"ends_at"
]
},
"on_call_shadow_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of shadow shift"
},
"type": {
"type": "string",
"enum": [
"on_call_shadows"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/on_call_shadow"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"on_call_shadows_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique id of the on-call shadow shift"
},
"type": {
"type": "string",
"enum": [
"on_call_shadows"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/on_call_shadow"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_on_call_role": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"on_call_roles"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The role name."
},
"system_role": {
"type": "string",
"description": "The kind of role (user and custom type roles are only editable)",
"items": {
"type": "string",
"enum": [
"admin",
"user",
"custom",
"observer",
"no_access"
]
},
"default": "custom"
},
"alert_fields_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"alert_groups_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"alert_routing_rules_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"on_call_readiness_report_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"read"
]
}
},
"on_call_roles_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"alert_sources_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"alert_urgency_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"alerts_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"update",
"read",
"delete"
]
}
},
"api_keys_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"audits_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"contacts_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"read"
]
}
},
"escalation_policies_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"groups_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"heartbeats_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"integrations_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"invitations_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"live_call_routing_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"schedule_override_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"update"
]
}
},
"schedules_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"services_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"functionalities_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"webhooks_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"workflows_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"catalogs_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_on_call_role": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"on_call_roles"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The role name."
},
"system_role": {
"type": "string",
"description": "The kind of role (user and custom type roles are only editable)",
"items": {
"type": "string",
"enum": [
"admin",
"user",
"custom",
"observer",
"no_access"
]
},
"default": "custom"
},
"alert_sources_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"alert_urgency_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"alert_fields_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"alert_groups_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"alert_routing_rules_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"on_call_readiness_report_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"read"
]
}
},
"on_call_roles_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"alerts_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"update",
"read",
"delete"
]
}
},
"api_keys_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"audits_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"contacts_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"read"
]
}
},
"escalation_policies_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"groups_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"heartbeats_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"integrations_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"invitations_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"live_call_routing_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"schedule_override_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"update"
]
}
},
"schedules_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"services_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"functionalities_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"webhooks_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"workflows_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"catalogs_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"on_call_role": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The role name."
},
"slug": {
"type": "string",
"description": "The role slug."
},
"system_role": {
"type": "string",
"description": "The kind of role",
"items": {
"type": "string",
"enum": [
"admin",
"user",
"custom",
"observer",
"no_access"
]
},
"default": "custom"
},
"alert_sources_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"alert_urgency_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"alert_fields_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"alert_groups_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"alert_routing_rules_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"on_call_readiness_report_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"read"
]
}
},
"on_call_roles_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"alerts_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"update",
"read",
"delete"
]
}
},
"api_keys_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"audits_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"contacts_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"read"
]
}
},
"escalation_policies_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"groups_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"heartbeats_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"integrations_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"invitations_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"live_call_routing_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"schedule_override_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"update"
]
}
},
"schedules_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"services_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"functionalities_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"webhooks_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"workflows_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"catalogs_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"name",
"created_at",
"updated_at"
]
},
"on_call_role_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the on_call_role"
},
"type": {
"type": "string",
"enum": [
"on_call_roles"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/on_call_role"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"on_call_role_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the on_call_role"
},
"type": {
"type": "string",
"enum": [
"on_call_roles"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/on_call_role"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_override_shift": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"shifts"
]
},
"attributes": {
"type": "object",
"properties": {
"starts_at": {
"type": "string",
"description": "Start datetime of override shift",
"format": "date-time",
"nullable": false
},
"ends_at": {
"type": "string",
"description": "End datetime of override shift",
"format": "date-time",
"nullable": false
},
"user_id": {
"type": "integer",
"description": "Override shift user",
"nullable": false
}
},
"additionalProperties": false,
"required": [
"starts_at",
"ends_at",
"user_id"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_override_shift": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"shifts"
]
},
"attributes": {
"type": "object",
"properties": {
"user_id": {
"type": "integer",
"description": "Override shift user",
"nullable": false
}
},
"additionalProperties": false,
"required": [
"user_id"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"override_shift": {
"type": "object",
"properties": {
"schedule_id": {
"type": "string",
"description": "ID of schedule",
"nullable": false
},
"rotation_id": {
"type": "string",
"description": "ID of rotation",
"nullable": true
},
"starts_at": {
"type": "string",
"description": "Start datetime of shift",
"nullable": false
},
"ends_at": {
"type": "string",
"description": "End datetime of shift",
"nullable": false
},
"is_override": {
"type": "boolean",
"description": "Denotes shift is an override shift"
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
},
"shift_override": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/shift_override_response"
}
],
"description": "Override metadata",
"nullable": true
},
"user_id": {
"type": "integer",
"description": "Override shift user",
"nullable": false
},
"user": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/user_response"
}
],
"description": "User metadata",
"nullable": false
}
},
"required": [
"schedule_id",
"rotation_id",
"starts_at",
"ends_at",
"is_override"
]
},
"override_shift_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the shift"
},
"type": {
"type": "string",
"enum": [
"shifts"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/override_shift"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"override_shift_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the shift"
},
"type": {
"type": "string",
"enum": [
"shifts"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/override_shift"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"shift_override": {
"type": "object",
"properties": {
"shift_id": {
"type": "string",
"description": "ID of shift",
"nullable": false
},
"created_by_user_id": {
"type": "integer",
"description": "User who created the override",
"nullable": false
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"shift_id",
"created_by_user_id"
]
},
"shift_override_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the shift override"
},
"type": {
"type": "string",
"enum": [
"shift_override"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/shift_override"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"new_playbook_task": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"playbook_tasks"
]
},
"attributes": {
"type": "object",
"properties": {
"task": {
"type": "string",
"description": "The task of the task"
},
"description": {
"type": "string",
"description": "The description of the task",
"nullable": true
},
"position": {
"type": "integer",
"description": "The position of the task",
"nullable": true
}
},
"additionalProperties": false,
"required": [
"task"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_playbook_task": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"playbook_tasks"
]
},
"attributes": {
"type": "object",
"properties": {
"task": {
"type": "string",
"description": "The task of the task"
},
"description": {
"type": "string",
"description": "The description of the task",
"nullable": true
},
"position": {
"type": "integer",
"description": "The position of the task",
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"playbook_task": {
"type": "object",
"properties": {
"playbook_id": {
"type": "string"
},
"task": {
"type": "string",
"description": "The task of the task"
},
"description": {
"type": "string",
"description": "The description of task",
"nullable": true
},
"position": {
"type": "integer",
"description": "The position of the task",
"nullable": true
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"task",
"created_at",
"updated_at"
]
},
"playbook_task_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the task"
},
"type": {
"type": "string",
"enum": [
"playbook_tasks"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/playbook_task"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"playbook_task_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the task"
},
"type": {
"type": "string",
"enum": [
"playbook_tasks"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/playbook_task"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_playbook": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"playbooks"
]
},
"attributes": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the playbook"
},
"summary": {
"type": "string",
"description": "The summary of the playbook",
"nullable": true
},
"external_url": {
"type": "string",
"description": "The external url of the playbook",
"nullable": true
},
"severity_ids": {
"type": "array",
"description": "The Severity IDs to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
},
"environment_ids": {
"type": "array",
"description": "The Environment IDs to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
},
"service_ids": {
"type": "array",
"description": "The Service IDs to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
},
"functionality_ids": {
"type": "array",
"description": "The Functionality IDs to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
},
"group_ids": {
"type": "array",
"description": "The Team IDs to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
},
"incident_type_ids": {
"type": "array",
"description": "The Incident Type IDs to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false,
"required": [
"title"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_playbook": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"playbooks"
]
},
"attributes": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the playbook"
},
"summary": {
"type": "string",
"description": "The summary of the playbook",
"nullable": true
},
"external_url": {
"type": "string",
"description": "The external url of the playbook",
"nullable": true
},
"severity_ids": {
"type": "array",
"description": "The Severity IDs to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
},
"environment_ids": {
"type": "array",
"description": "The Environment IDs to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
},
"service_ids": {
"type": "array",
"description": "The Service IDs to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
},
"functionality_ids": {
"type": "array",
"description": "The Functionality IDs to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
},
"group_ids": {
"type": "array",
"description": "The Team IDs to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
},
"incident_type_ids": {
"type": "array",
"description": "The Incident Type IDs to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"playbook": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the playbook"
},
"summary": {
"type": "string",
"description": "The summary of the playbook",
"nullable": true
},
"external_url": {
"type": "string",
"description": "The external url of the playbook",
"nullable": true
},
"severity_ids": {
"type": "array",
"description": "The Severity IDs to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
},
"environment_ids": {
"type": "array",
"description": "The Environment IDs to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
},
"functionality_ids": {
"type": "array",
"description": "The Functionality IDs to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
},
"service_ids": {
"type": "array",
"description": "The Service IDs to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
},
"group_ids": {
"type": "array",
"description": "The Team IDs to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
},
"incident_type_ids": {
"type": "array",
"description": "The Incident Type IDs to attach to the incident",
"items": {
"type": "string"
},
"nullable": true
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"title",
"created_at",
"updated_at"
]
},
"playbook_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the playbook"
},
"type": {
"type": "string",
"enum": [
"playbooks"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/playbook"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"playbook_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the playbook"
},
"type": {
"type": "string",
"enum": [
"playbooks"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/playbook"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_post_mortem_template": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"post_mortem_templates"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the postmortem template"
},
"default": {
"type": "boolean",
"description": "Default selected template when editing a postmortem",
"nullable": true
},
"content": {
"type": "string",
"description": "The postmortem template. Supports TipTap blocks (followup and timeline components), Liquid syntax, and HTML. Will be sanitized and applied to both content and content_html fields."
},
"format": {
"type": "string",
"description": "The format of the input",
"enum": [
"html",
"markdown"
],
"default": "html",
"nullable": true
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_post_mortem_template": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"post_mortem_templates"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the postmortem template"
},
"default": {
"type": "boolean",
"description": "Default selected template when editing a postmortem",
"nullable": true
},
"content": {
"type": "string",
"description": "The postmortem template. Supports TipTap blocks (followup and timeline components), Liquid syntax, and HTML. Will be sanitized and applied to both content and content_html fields."
},
"format": {
"type": "string",
"description": "The format of the input",
"enum": [
"html",
"markdown"
],
"default": "html",
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"post_mortem_template": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the postmortem template"
},
"slug": {
"type": "string",
"description": "The slugified name of the postmortem template"
},
"default": {
"type": "boolean",
"description": "Default selected template when editing a postmortem",
"nullable": true
},
"content": {
"type": "string",
"description": "The postmortem template. Liquid syntax and markdown are supported"
},
"content_html": {
"type": "string",
"description": "The postmortem template in HTML format with TipTap blocks support. Supports followup and timeline components. Liquid syntax is supported.",
"nullable": true
},
"content_json": {
"type": "object",
"description": "The postmortem template in TipTap JSON format",
"nullable": true
},
"format": {
"type": "string",
"description": "The format of the input",
"enum": [
"html",
"markdown"
]
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"name",
"created_at",
"updated_at"
]
},
"tiptap_block_schema": {
"type": "object",
"description": "TipTap block component schema for post mortem templates",
"properties": {
"followup_component": {
"type": "object",
"description": "Followup component block",
"properties": {
"html": {
"type": "string",
"description": "HTML representation: ",
"example": ""
},
"data_sort": {
"type": "string",
"enum": [
"due_date",
"status",
"priority"
],
"description": "Sort order for followups. Valid values: due_date, status, priority",
"default": "due_date"
}
},
"required": [
"html"
]
},
"timeline_component": {
"type": "object",
"description": "Timeline component block",
"properties": {
"html": {
"type": "string",
"description": "HTML representation: ",
"example": ""
}
},
"required": [
"html"
]
}
}
},
"post_mortem_template_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the post_mortem_template"
},
"type": {
"type": "string",
"enum": [
"post_mortem_templates"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/post_mortem_template"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"post_mortem_template_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the post_mortem_template"
},
"type": {
"type": "string",
"enum": [
"post_mortem_templates"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/post_mortem_template"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_pulse": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"pulses"
]
},
"attributes": {
"type": "object",
"properties": {
"source": {
"type": "string",
"description": "The source of the pulse (eg: k8s)",
"nullable": true
},
"summary": {
"type": "string",
"description": "The summary of the pulse"
},
"service_ids": {
"type": "array",
"description": "The Service IDs to attach to the pulse",
"items": {
"type": "string"
},
"nullable": true
},
"environment_ids": {
"type": "array",
"description": "The Environment IDs to attach to the pulse",
"items": {
"type": "string"
},
"nullable": true
},
"started_at": {
"type": "string",
"description": "Pulse start datetime",
"format": "date-time",
"nullable": true
},
"ended_at": {
"type": "string",
"description": "Pulse end datetime",
"format": "date-time",
"nullable": true
},
"external_url": {
"type": "string",
"description": "The external url of the pulse",
"nullable": true
},
"labels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Key of the tag"
},
"value": {
"type": "string",
"description": "Value of the tag"
}
},
"required": [
"key",
"value"
],
"nullable": true
}
},
"refs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Key of the ref"
},
"value": {
"type": "string",
"description": "Value of the ref"
}
},
"required": [
"key",
"value"
],
"nullable": true
}
},
"data": {
"type": "object",
"description": "Additional data",
"nullable": true
}
},
"additionalProperties": false,
"required": [
"summary"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_pulse": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"pulses"
]
},
"attributes": {
"type": "object",
"properties": {
"source": {
"type": "string",
"description": "The source of the pulse (eg: k8s)",
"nullable": true
},
"summary": {
"type": "string",
"description": "The summary of the pulse"
},
"service_ids": {
"type": "array",
"description": "The Service IDs to attach to the pulse",
"items": {
"type": "string"
},
"nullable": true
},
"environment_ids": {
"type": "array",
"description": "The Environment IDs to attach to the pulse",
"items": {
"type": "string"
},
"nullable": true
},
"started_at": {
"type": "string",
"description": "Pulse start datetime",
"format": "date-time",
"nullable": true
},
"ended_at": {
"type": "string",
"description": "Pulse end datetime",
"format": "date-time",
"nullable": true
},
"external_url": {
"type": "string",
"description": "The external url of the pulse",
"nullable": true
},
"labels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Key of the tag"
},
"value": {
"type": "string",
"description": "Value of the tag"
}
},
"required": [
"key",
"value"
],
"nullable": true
}
},
"refs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Key of the ref"
},
"value": {
"type": "string",
"description": "Value of the ref"
}
},
"required": [
"key",
"value"
],
"nullable": true
}
},
"data": {
"type": "object",
"description": "Additional data",
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"pulse": {
"type": "object",
"properties": {
"source": {
"type": "string",
"description": "The source of the pulse (eg: k8s)",
"nullable": true
},
"summary": {
"type": "string",
"description": "The summary of the pulse"
},
"services": {
"type": "array",
"description": "Services attached to the pulse",
"items": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/service"
}
]
}
},
"environments": {
"type": "array",
"description": "Environments attached to the pulse",
"items": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/environment"
}
]
}
},
"external_url": {
"type": "string",
"description": "The external url of the pulse",
"nullable": true
},
"labels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Key of the tag"
},
"value": {
"type": "string",
"description": "Value of the tag"
}
},
"required": [
"key",
"value"
],
"nullable": true
}
},
"refs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Key of the ref"
},
"value": {
"type": "string",
"description": "Value of the ref"
}
},
"required": [
"key",
"value"
],
"nullable": true
}
},
"data": {
"type": "object",
"description": "Additional data",
"nullable": true
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"summary",
"created_at",
"updated_at"
]
},
"pulse_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the pulse"
},
"type": {
"type": "string",
"enum": [
"pulses"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/pulse"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"pulse_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the pulse"
},
"type": {
"type": "string",
"enum": [
"pulses"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/pulse"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"receipt": {
"type": "object",
"properties": {
"state": {
"type": "string",
"description": "Delivery state of the receipt.",
"enum": [
"pending",
"done",
"failed"
]
},
"reason": {
"type": "string",
"description": "Reason a receipt failed. Present when state is failed.",
"enum": [
"no_route_matched",
"deduplicated",
"suppressed",
"validation_error"
]
},
"resource_type": {
"type": "string",
"description": "Type of the referenced resource (present when set)."
},
"resource_id": {
"type": "string",
"description": "ID of the referenced resource (present when set)."
}
},
"required": [
"state"
]
},
"update_retrospective_configuration": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"retrospective_configurations"
]
},
"attributes": {
"type": "object",
"properties": {
"severity_ids": {
"type": "array",
"description": "The Severity IDs to attach to the retrospective configuration",
"items": {
"type": "string"
},
"nullable": true
},
"group_ids": {
"type": "array",
"description": "The Team IDs to attach to the retrospective configuration",
"items": {
"type": "string"
},
"nullable": true
},
"incident_type_ids": {
"type": "array",
"description": "The Incident Type IDs to attach to the retrospective configuration",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"retrospective_configuration": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "The kind of the configuration.",
"enum": [
"skip",
"mandatory"
]
},
"severity_ids": {
"type": "array",
"description": "The Severity IDs to attach to the retrospective configuration",
"items": {
"type": "string"
},
"nullable": true
},
"group_ids": {
"type": "array",
"description": "The Team IDs to attach to the retrospective configuration",
"items": {
"type": "string"
},
"nullable": true
},
"incident_type_ids": {
"type": "array",
"description": "The Incident Type IDs to attach to the retrospective configuration",
"items": {
"type": "string"
},
"nullable": true
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
}
},
"retrospective_configuration_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the retrospective configuration"
},
"type": {
"type": "string",
"enum": [
"retrospective_configurations"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/retrospective_configuration"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"retrospective_configuration_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the configuration"
},
"type": {
"type": "string",
"enum": [
"retrospective_configurations"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/retrospective_configuration"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"new_retrospective_process": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"retrospective_processes"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the retrospective process"
},
"copy_from": {
"type": "string",
"description": "Retrospective process ID from which retrospective steps have to be copied. To use starter template for retrospective steps provide value: 'starter_template'"
},
"description": {
"type": "string",
"description": "The description of the retrospective process",
"nullable": true
},
"retrospective_process_matching_criteria": {
"type": "object",
"oneOf": [
{
"type": "object",
"properties": {
"severity_ids": {
"type": "array",
"description": "Severity IDs for retrospective process matching criteria",
"items": {
"type": "string"
}
}
},
"additionalProperties": false,
"required": [
"severity_ids"
]
},
{
"type": "object",
"properties": {
"group_ids": {
"type": "array",
"description": "Team IDs for retrospective process matching criteria",
"items": {
"type": "string"
}
}
},
"additionalProperties": false,
"required": [
"group_ids"
]
},
{
"type": "object",
"properties": {
"incident_type_ids": {
"type": "array",
"description": "Incident type IDs for retrospective process matching criteria",
"items": {
"type": "string"
}
}
},
"additionalProperties": false,
"required": [
"incident_type_ids"
]
}
]
}
},
"additionalProperties": false,
"required": [
"name",
"copy_from"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_retrospective_process": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"retrospective_processes"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the retrospective process"
},
"description": {
"type": "string",
"description": "The description of the retrospective process",
"nullable": true
},
"retrospective_process_matching_criteria": {
"type": "object",
"oneOf": [
{
"type": "object",
"properties": {
"severity_ids": {
"type": "array",
"description": "Severity IDs for retrospective process matching criteria",
"items": {
"type": "string"
}
}
},
"additionalProperties": false,
"required": [
"severity_ids"
]
},
{
"type": "object",
"properties": {
"group_ids": {
"type": "array",
"description": "Team IDs for retrospective process matching criteria",
"items": {
"type": "string"
}
}
},
"additionalProperties": false,
"required": [
"group_ids"
]
},
{
"type": "object",
"properties": {
"incident_type_ids": {
"type": "array",
"description": "Incident type IDs for retrospective process matching criteria",
"items": {
"type": "string"
}
}
},
"additionalProperties": false,
"required": [
"incident_type_ids"
]
}
]
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"retrospective_process": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the retrospective process"
},
"description": {
"type": "string",
"description": "The description of the retrospective process",
"nullable": true
},
"is_default": {
"type": "boolean",
"description": "Indicates the default process that Rootly created. This will be used as a fallback if no processes match the incident's conditions. The default process cannot have conditions and cannot be changed.",
"nullable": true
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
},
"retrospective_process_matching_criteria": {
"type": "object",
"oneOf": [
{
"type": "object",
"properties": {
"severity_ids": {
"type": "array",
"description": "Severity IDs for retrospective process matching criteria",
"items": {
"type": "string"
}
}
},
"additionalProperties": false,
"required": [
"severity_ids"
]
},
{
"type": "object",
"properties": {
"group_ids": {
"type": "array",
"description": "Team IDs for retrospective process matching criteria",
"items": {
"type": "string"
}
}
},
"additionalProperties": false,
"required": [
"group_ids"
]
},
{
"type": "object",
"properties": {
"incident_type_ids": {
"type": "array",
"description": "Incident type IDs for retrospective process matching criteria",
"items": {
"type": "string"
}
}
},
"additionalProperties": false,
"required": [
"incident_type_ids"
]
}
]
}
}
},
"retrospective_process_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique id of retrospective process"
},
"type": {
"type": "string",
"enum": [
"retrospective_processes"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/retrospective_process"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"retrospective_process_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the retrospective process"
},
"type": {
"type": "string",
"enum": [
"retrospective_processes"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/retrospective_process"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_retrospective_step": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"retrospective_steps"
]
},
"attributes": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The name of the step"
},
"description": {
"type": "string",
"description": "The description of the step",
"nullable": true
},
"due_after_days": {
"type": "integer",
"description": "Due date in days",
"nullable": true
},
"incident_role_id": {
"type": "string",
"description": "Users assigned to the selected incident role will be the default owners for this step",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the step",
"nullable": true
},
"skippable": {
"type": "boolean",
"description": "Is the step skippable?",
"nullable": false
}
},
"additionalProperties": false,
"required": [
"title"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_retrospective_step": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"retrospective_steps"
]
},
"attributes": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The name of the step"
},
"description": {
"type": "string",
"description": "The description of the step",
"nullable": true
},
"incident_role_id": {
"type": "string",
"description": "Users assigned to the selected incident role will be the default owners for this step",
"nullable": true
},
"due_after_days": {
"type": "integer",
"description": "Due date in days",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the step",
"nullable": true
},
"skippable": {
"type": "boolean",
"description": "Is the step skippable?",
"nullable": false
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"retrospective_step": {
"type": "object",
"properties": {
"retrospective_process_id": {
"type": "string"
},
"title": {
"type": "string",
"description": "The name of the step"
},
"slug": {
"type": "string",
"description": "The slug of the step"
},
"description": {
"type": "string",
"description": "The description of the step",
"nullable": true
},
"incident_role_id": {
"type": "string",
"description": "Users assigned to the selected incident role will be the default owners for this step",
"nullable": true
},
"due_after_days": {
"type": "integer",
"description": "Due date in days",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the step"
},
"skippable": {
"type": "boolean",
"description": "Is the step skippable?"
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"retrospective_process_id",
"title",
"created_at",
"updated_at"
]
},
"retrospective_step_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the step"
},
"type": {
"type": "string",
"enum": [
"retrospective_steps"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/retrospective_step"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"retrospective_step_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the step"
},
"type": {
"type": "string",
"enum": [
"retrospective_steps"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/retrospective_step"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_role": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"roles"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The role name."
},
"incident_permission_set_id": {
"type": "string",
"description": "Associated incident permissions set.",
"nullable": true
},
"alerts_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read"
]
}
},
"api_keys_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"audits_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"billing_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"environments_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"form_fields_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"functionalities_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"groups_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"incident_causes_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"incident_feedbacks_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"incident_roles_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"incident_types_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"incidents_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"integrations_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"invitations_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"playbooks_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"private_incidents_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"pulses_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"update",
"read"
]
}
},
"retrospective_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"roles_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"secrets_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"services_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"severities_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"status_pages_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"webhooks_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"workflows_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"catalogs_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"sub_statuses_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"edge_connector_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"slas_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"paging_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"incident_communication_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete",
"send"
]
}
},
"communication_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_role": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"roles"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The role name."
},
"incident_permission_set_id": {
"type": "string",
"description": "Associated incident permissions set.",
"nullable": true
},
"is_deletable": {
"type": "boolean",
"description": "Whether the role can be deleted."
},
"is_editable": {
"type": "boolean",
"description": "Whether the role can be edited."
},
"api_keys_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"audits_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"billing_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"environments_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"form_fields_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"functionalities_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"groups_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"incident_causes_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"incident_feedbacks_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"incident_roles_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"incident_types_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"incidents_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"integrations_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"invitations_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"playbooks_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"private_incidents_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"retrospective_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"roles_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"secrets_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"services_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"severities_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"status_pages_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"webhooks_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"workflows_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"catalogs_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"sub_statuses_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"edge_connector_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"slas_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"paging_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"incident_communication_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete",
"send"
]
}
},
"communication_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"role": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The role name."
},
"slug": {
"type": "string",
"description": "The role slug."
},
"incident_permission_set_id": {
"type": "string",
"description": "Associated incident permissions set.",
"nullable": true
},
"is_deletable": {
"type": "boolean",
"description": "Whether the role can be deleted."
},
"is_editable": {
"type": "boolean",
"description": "Whether the role can be edited."
},
"alerts_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read"
]
}
},
"api_keys_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"audits_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"billing_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"environments_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"form_fields_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"functionalities_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"groups_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"incident_causes_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"incident_feedbacks_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"incident_roles_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"incident_types_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"incidents_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"integrations_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"invitations_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"playbooks_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"private_incidents_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"pulses_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"update",
"read"
]
}
},
"retrospective_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"roles_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"secrets_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"services_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"severities_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"status_pages_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"webhooks_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"workflows_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"catalogs_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"sub_statuses_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"edge_connector_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"slas_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"paging_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"incident_communication_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete",
"send"
]
}
},
"communication_permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"create",
"read",
"update",
"delete"
]
}
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"name",
"created_at",
"updated_at"
]
},
"role_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the role"
},
"type": {
"type": "string",
"enum": [
"roles"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/role"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"role_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the role"
},
"type": {
"type": "string",
"enum": [
"roles"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/role"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_schedule_rotation_active_day": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"schedule_rotation_active_days"
]
},
"attributes": {
"type": "object",
"properties": {
"day_name": {
"type": "string",
"description": "Schedule rotation day name for which active times to be created",
"enum": [
"S",
"M",
"T",
"W",
"R",
"F",
"U"
]
},
"active_time_attributes": {
"type": "array",
"description": "Schedule rotation active times per day",
"items": {
"type": "object",
"properties": {
"start_time": {
"type": "string",
"description": "Start time for schedule rotation active time",
"format": "time"
},
"end_time": {
"type": "string",
"description": "End time for schedule rotation active time",
"format": "time"
}
}
}
}
},
"additionalProperties": false,
"required": [
"day_name",
"active_time_attributes"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_schedule_rotation_active_day": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"schedule_rotation_active_days"
]
},
"attributes": {
"type": "object",
"properties": {
"day_name": {
"type": "string",
"description": "Schedule rotation day name for which active times to be created",
"enum": [
"S",
"M",
"T",
"W",
"R",
"F",
"U"
]
},
"active_time_attributes": {
"type": "array",
"description": "Schedule rotation active times per day",
"items": {
"type": "object",
"properties": {
"start_time": {
"type": "string",
"description": "Start time for schedule rotation active time",
"format": "time"
},
"end_time": {
"type": "string",
"description": "End time for schedule rotation active time",
"format": "time"
}
}
}
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"schedule_rotation_active_day": {
"properties": {
"schedule_rotation_id": {
"type": "string"
},
"day_name": {
"type": "string",
"description": "Schedule rotation day name for which active times to be created",
"enum": [
"S",
"M",
"T",
"W",
"R",
"F",
"U"
]
},
"active_time_attributes": {
"type": "array",
"description": "Schedule rotation active times per day",
"items": {
"type": "object",
"properties": {
"start_time": {
"type": "string",
"description": "Start time for schedule rotation active time",
"format": "time"
},
"end_time": {
"type": "string",
"description": "End time for schedule rotation active time",
"format": "time"
}
}
}
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"schedule_rotation_id",
"day_name",
"active_time_attributes",
"created_at",
"updated_at"
]
},
"schedule_rotation_active_day_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the schedule rotation active time"
},
"type": {
"type": "string",
"enum": [
"schedule_rotation_active_days"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/schedule_rotation_active_day"
}
]
}
}
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
}
},
"schedule_rotation_active_day_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the schedule rotation active time"
},
"type": {
"type": "string",
"enum": [
"schedule_rotation_active_days"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/schedule_rotation_active_day"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_schedule_rotation_user": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"schedule_rotation_users"
]
},
"attributes": {
"type": "object",
"properties": {
"user_id": {
"type": "integer",
"description": "Schedule rotation user"
},
"position": {
"type": "integer",
"description": "Position of the user inside rotation"
}
},
"additionalProperties": false,
"required": [
"user_id"
]
}
}
}
}
},
"update_schedule_rotation_user": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"schedule_rotation_users"
]
},
"attributes": {
"type": "object",
"properties": {
"user_id": {
"type": "integer",
"description": "Schedule rotation user"
},
"position": {
"type": "integer",
"description": "Position of the user inside rotation"
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"schedule_rotation_user": {
"type": "object",
"properties": {
"schedule_rotation_id": {
"type": "string"
},
"user_id": {
"type": "integer",
"description": "Schedule rotation user"
},
"position": {
"type": "integer",
"description": "Position of the user inside rotation"
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"schedule_rotation_id",
"user_id",
"position",
"created_at",
"updated_at"
]
},
"schedule_rotation_user_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the schedule rotation user"
},
"type": {
"type": "string",
"enum": [
"schedule_rotation_users"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/schedule_rotation_user"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"schedule_rotation_user_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the schedule rotation user"
},
"type": {
"type": "string",
"enum": [
"schedule_rotation_users"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/schedule_rotation_user"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"new_schedule_rotation": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"schedule_rotations"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the schedule rotation"
},
"position": {
"type": "integer",
"description": "Position of the schedule rotation"
},
"schedule_rotationable_type": {
"type": "string",
"description": "Schedule rotation type",
"enum": [
"ScheduleDailyRotation",
"ScheduleWeeklyRotation",
"ScheduleBiweeklyRotation",
"ScheduleMonthlyRotation",
"ScheduleCustomRotation"
]
},
"active_all_week": {
"type": "boolean",
"description": "Schedule rotation active all week?",
"default": true
},
"active_days": {
"type": "array",
"items": {
"type": "string",
"description": "Schedule rotation active days",
"enum": [
"S",
"M",
"T",
"W",
"R",
"F",
"U"
]
}
},
"active_time_type": {
"type": "string",
"items": {
"type": "string",
"description": "Schedule rotation active time type",
"enum": [
"all_day",
"same_time",
"custom"
],
"default": "all_day"
}
},
"active_time_attributes": {
"type": "array",
"description": "Schedule rotation's active times",
"items": {
"type": "object",
"properties": {
"start_time": {
"type": "string",
"description": "Start time for schedule rotation active time",
"format": "time"
},
"end_time": {
"type": "string",
"description": "End time for schedule rotation active time",
"format": "time"
}
},
"required": [
"start_time",
"end_time"
]
}
},
"time_zone": {
"type": "string",
"description": "A valid IANA time zone name.",
"default": "Etc/UTC"
},
"schedule_rotationable_attributes": {
"type": "object",
"oneOf": [
{
"type": "object",
"properties": {
"handoff_time": {
"type": "string",
"description": "Hand off time for daily rotation",
"format": "time"
}
},
"additionalProperties": false,
"required": [
"handoff_time"
]
},
{
"type": "object",
"properties": {
"handoff_time": {
"type": "string",
"description": "Hand off time for weekly/biweekly rotation",
"format": "time"
},
"handoff_day": {
"type": "string",
"description": "Hand off day for weekly/biweekly rotation",
"enum": [
"S",
"M",
"T",
"W",
"R",
"F",
"U"
]
}
},
"additionalProperties": false,
"required": [
"handoff_time",
"handoff_day"
]
},
{
"type": "object",
"properties": {
"handoff_time": {
"type": "string",
"description": "Hand off time for monthly rotation",
"format": "time"
},
"handoff_day": {
"type": "string",
"description": "Hand off day for monthly rotation",
"enum": [
"first_day_of_month",
"last_day_of_month"
]
}
},
"additionalProperties": false,
"required": [
"handoff_time",
"handoff_day"
]
},
{
"type": "object",
"properties": {
"shift_length": {
"type": "integer",
"description": "Shift length for custom rotation"
},
"shift_length_unit": {
"type": "string",
"description": "Shift length unit for custom rotation",
"enum": [
"hours",
"days",
"weeks"
]
},
"handoff_time": {
"type": "string",
"description": "Hand off time for custom rotation. Use minutes for hourly rotation.",
"format": "time"
}
},
"additionalProperties": false,
"required": [
"shift_length_unit",
"shift_length",
"handoff_time"
]
}
]
},
"start_time": {
"type": "string",
"format": "date-time",
"description": "RFC3339 date-time when rotation starts. Shifts will only be created after this time.",
"nullable": true
},
"end_time": {
"type": "string",
"format": "date-time",
"description": "RFC3339 date-time when rotation ends. Shifts will only be created before this time.",
"nullable": true
},
"schedule_rotation_members": {
"type": "array",
"description": "You can only add schedule rotation members if your account has schedule nesting feature enabled",
"nullable": true,
"items": {
"type": "object",
"properties": {
"member_type": {
"type": "string",
"description": "Type of member",
"enum": [
"User",
"Schedule"
]
},
"member_id": {
"type": "string",
"description": "ID of the member"
},
"position": {
"type": "integer",
"description": "Position of the member in rotation"
}
},
"required": [
"member_type",
"member_id"
]
}
}
},
"additionalProperties": false,
"required": [
"name",
"schedule_rotationable_type",
"schedule_rotationable_attributes"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_schedule_rotation": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"schedule_rotations"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the schedule rotation"
},
"position": {
"type": "integer",
"description": "Position of the schedule rotation"
},
"schedule_rotationable_type": {
"type": "string",
"description": "Schedule rotation type",
"enum": [
"ScheduleDailyRotation",
"ScheduleWeeklyRotation",
"ScheduleBiweeklyRotation",
"ScheduleMonthlyRotation",
"ScheduleCustomRotation"
]
},
"active_all_week": {
"type": "boolean",
"description": "Schedule rotation active all week?",
"default": true
},
"active_days": {
"type": "array",
"items": {
"type": "string",
"description": "Schedule rotation active days",
"enum": [
"S",
"M",
"T",
"W",
"R",
"F",
"U"
]
}
},
"active_time_type": {
"type": "string",
"items": {
"type": "string",
"description": "Schedule rotation active time type",
"enum": [
"all_day",
"same_time",
"custom"
],
"default": "all_day"
}
},
"active_time_attributes": {
"type": "array",
"description": "Schedule rotation's active times",
"items": {
"type": "object",
"properties": {
"start_time": {
"type": "string",
"description": "Start time for schedule rotation active time",
"format": "time"
},
"end_time": {
"type": "string",
"description": "End time for schedule rotation active time",
"format": "time"
}
},
"required": [
"start_time",
"end_time"
]
}
},
"time_zone": {
"type": "string",
"description": "A valid IANA time zone name.",
"default": "Etc/UTC"
},
"schedule_rotationable_attributes": {
"type": "object",
"oneOf": [
{
"type": "object",
"properties": {
"handoff_time": {
"type": "string",
"description": "Hand off time for daily rotation",
"format": "time"
}
},
"additionalProperties": false,
"required": [
"handoff_time"
]
},
{
"type": "object",
"properties": {
"handoff_time": {
"type": "string",
"description": "Hand off time for weekly/biweekly rotation",
"format": "time"
},
"handoff_day": {
"type": "string",
"description": "Hand off day for weekly/biweekly rotation",
"enum": [
"S",
"M",
"T",
"W",
"R",
"F",
"U"
]
}
},
"additionalProperties": false,
"required": [
"handoff_time",
"handoff_day"
]
},
{
"type": "object",
"properties": {
"handoff_time": {
"type": "string",
"description": "Hand off time for monthly rotation",
"format": "time"
},
"handoff_day": {
"type": "string",
"description": "Hand off day for monthly rotation",
"enum": [
"first_day_of_month",
"last_day_of_month"
]
}
},
"additionalProperties": false,
"required": [
"handoff_time",
"handoff_day"
]
},
{
"type": "object",
"properties": {
"shift_length": {
"type": "integer",
"description": "Shift length for custom rotation"
},
"shift_length_unit": {
"type": "string",
"description": "Shift length unit for custom rotation",
"enum": [
"hours",
"days",
"weeks"
]
},
"handoff_time": {
"type": "string",
"description": "Hand off time for custom rotation. Use minutes for hourly rotation.",
"format": "time"
}
},
"additionalProperties": false,
"required": [
"shift_length_unit",
"shift_length",
"handoff_time"
]
}
]
},
"start_time": {
"type": "string",
"format": "date-time",
"description": "RFC3339 date-time when rotation starts. Shifts will only be created after this time.",
"nullable": true
},
"end_time": {
"type": "string",
"format": "date-time",
"description": "RFC3339 date-time when rotation ends. Shifts will only be created before this time.",
"nullable": true
},
"schedule_rotation_members": {
"type": "array",
"description": "You can only update schedule rotation members if your account has schedule nesting feature enabled",
"nullable": true,
"items": {
"type": "object",
"properties": {
"member_type": {
"type": "string",
"description": "Type of member",
"enum": [
"User",
"Schedule"
]
},
"member_id": {
"type": "string",
"description": "ID of the member"
},
"position": {
"type": "integer",
"description": "Position of the member in rotation"
}
},
"required": [
"member_type",
"member_id"
]
}
}
},
"additionalProperties": false,
"required": [
"schedule_rotationable_type"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"schedule_rotation": {
"type": "object",
"properties": {
"schedule_id": {
"type": "string",
"description": "The ID of parent schedule"
},
"name": {
"type": "string",
"description": "The name of the schedule rotation"
},
"position": {
"type": "integer",
"description": "Position of the schedule rotation"
},
"schedule_rotationable_type": {
"type": "string",
"description": "Schedule rotation type",
"enum": [
"ScheduleDailyRotation",
"ScheduleWeeklyRotation",
"ScheduleBiweeklyRotation",
"ScheduleMonthlyRotation",
"ScheduleCustomRotation"
]
},
"active_all_week": {
"type": "boolean",
"description": "Schedule rotation active all week?",
"default": true
},
"active_days": {
"type": "array",
"items": {
"type": "string",
"description": "Schedule rotation active days",
"enum": [
"S",
"M",
"T",
"W",
"R",
"F",
"U"
]
}
},
"active_time_type": {
"type": "string",
"items": {
"type": "string",
"description": "Schedule rotation active time type",
"enum": [
"all_day",
"same_time",
"custom"
],
"default": "all_day"
}
},
"active_time_attributes": {
"type": "array",
"description": "Schedule rotation's active times",
"items": {
"type": "object",
"properties": {
"start_time": {
"type": "string",
"description": "Start time for schedule rotation active time",
"format": "time"
},
"end_time": {
"type": "string",
"description": "End time for schedule rotation active time",
"format": "time"
}
},
"required": [
"start_time",
"end_time"
]
}
},
"time_zone": {
"type": "string",
"description": "A valid IANA time zone name.",
"default": "Etc/UTC"
},
"schedule_rotationable_attributes": {
"type": "object",
"oneOf": [
{
"type": "object",
"properties": {
"handoff_time": {
"type": "string",
"description": "Hand off time for daily rotation",
"format": "time"
}
},
"additionalProperties": false,
"required": [
"handoff_time"
]
},
{
"type": "object",
"properties": {
"handoff_time": {
"type": "string",
"description": "Hand off time for weekly/biweekly rotation",
"format": "time"
},
"handoff_day": {
"type": "string",
"description": "Hand off day for weekly/biweekly rotation",
"enum": [
"S",
"M",
"T",
"W",
"R",
"F",
"U"
]
}
},
"additionalProperties": false,
"required": [
"handoff_time",
"handoff_day"
]
},
{
"type": "object",
"properties": {
"handoff_time": {
"type": "string",
"description": "Hand off time for monthly rotation",
"format": "time"
},
"handoff_day": {
"type": "string",
"description": "Hand off day for monthly rotation",
"enum": [
"first_day_of_month",
"last_day_of_month"
]
}
},
"additionalProperties": false,
"required": [
"handoff_time",
"handoff_day"
]
},
{
"type": "object",
"properties": {
"shift_length": {
"type": "integer",
"description": "Shift length for custom rotation"
},
"shift_length_unit": {
"type": "string",
"description": "Shift length unit for custom rotation",
"enum": [
"hours",
"days",
"weeks"
]
},
"handoff_time": {
"type": "string",
"description": "Hand off time for custom rotation. Use minutes for hourly rotation.",
"format": "time"
}
},
"additionalProperties": false,
"required": [
"shift_length_unit",
"shift_length",
"handoff_time"
]
}
]
},
"start_time": {
"type": "string",
"format": "date-time",
"description": "RFC3339 date-time when rotation starts. Shifts will only be created after this time.",
"nullable": true
},
"end_time": {
"type": "string",
"format": "date-time",
"description": "RFC3339 date-time when rotation ends. Shifts will only be created before this time.",
"nullable": true
}
},
"required": [
"schedule_id",
"name",
"schedule_rotationable_type",
"schedule_rotationable_attributes"
]
},
"schedule_rotation_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the schedule rotation"
},
"type": {
"type": "string",
"enum": [
"schedule_rotations"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/schedule_rotation"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"schedule_rotation_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the schedule rotation"
},
"type": {
"type": "string",
"enum": [
"schedule_rotations"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/schedule_rotation"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_schedule": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"schedules"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the schedule"
},
"description": {
"type": "string",
"description": "The description of the schedule",
"nullable": true
},
"all_time_coverage": {
"type": "boolean",
"description": "24/7 coverage of the schedule",
"nullable": true
},
"slack_user_group": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack user group ID"
},
"name": {
"type": "string",
"description": "Slack user group name"
}
}
},
"slack_channel": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack channel ID"
},
"name": {
"type": "string",
"description": "Slack channel name"
}
},
"nullable": true
},
"owner_group_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Owning teams."
},
"owner_user_id": {
"type": "integer",
"description": "ID of the owner of the schedule"
},
"sync_linear_enabled": {
"type": "boolean",
"description": "Whether the schedule is synced with Linear",
"nullable": true
},
"include_shadows_in_slack_notifications": {
"type": "boolean",
"description": "Whether shadow users are included in Slack notifications and user group syncing. Requires `slack_channel` to be set; otherwise this value is forced to false on save.",
"nullable": true
},
"shift_start_notifications_enabled": {
"type": "boolean",
"description": "Whether shift-start notifications are enabled. Requires `slack_channel` to be set; otherwise this value is forced to false on save.",
"nullable": true
},
"shift_update_notifications_enabled": {
"type": "boolean",
"description": "Whether shift-update notifications are enabled. Requires `slack_channel` to be set; otherwise this value is forced to false on save.",
"nullable": true
},
"shift_report_enabled": {
"type": "boolean",
"description": "Whether the weekly shift summary report is enabled. Requires `slack_channel` to be set; otherwise this value is forced to false on save.",
"nullable": true
},
"shift_report_day_of_week": {
"type": "string",
"enum": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday",
"sunday"
],
"description": "Day of week the weekly shift summary is sent",
"nullable": true
},
"shift_report_time_of_day": {
"type": "string",
"description": "Time of day the weekly shift summary is sent, in HH:MM 24-hour format",
"nullable": true
},
"shift_report_time_zone": {
"type": "string",
"description": "IANA time zone used for the weekly shift summary",
"nullable": true
}
},
"additionalProperties": false,
"required": [
"name",
"owner_user_id"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_schedule": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"schedules"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the schedule"
},
"description": {
"type": "string",
"description": "The description of the schedule",
"nullable": true
},
"all_time_coverage": {
"type": "boolean",
"description": "24/7 coverage of the schedule",
"nullable": true
},
"slack_user_group": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack user group ID"
},
"name": {
"type": "string",
"description": "Slack user group name"
}
}
},
"slack_channel": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack channel ID"
},
"name": {
"type": "string",
"description": "Slack channel name"
}
},
"nullable": true
},
"owner_group_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Owning teams."
},
"owner_user_id": {
"type": "integer",
"description": "ID of the owner of the schedule",
"nullable": true
},
"sync_linear_enabled": {
"type": "boolean",
"description": "Whether the schedule is synced with Linear",
"nullable": true
},
"include_shadows_in_slack_notifications": {
"type": "boolean",
"description": "Whether shadow users are included in Slack notifications and user group syncing. Requires `slack_channel` to be set; otherwise this value is forced to false on save.",
"nullable": true
},
"shift_start_notifications_enabled": {
"type": "boolean",
"description": "Whether shift-start notifications are enabled. Requires `slack_channel` to be set; otherwise this value is forced to false on save.",
"nullable": true
},
"shift_update_notifications_enabled": {
"type": "boolean",
"description": "Whether shift-update notifications are enabled. Requires `slack_channel` to be set; otherwise this value is forced to false on save.",
"nullable": true
},
"shift_report_enabled": {
"type": "boolean",
"description": "Whether the weekly shift summary report is enabled. Requires `slack_channel` to be set; otherwise this value is forced to false on save.",
"nullable": true
},
"shift_report_day_of_week": {
"type": "string",
"enum": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday",
"sunday"
],
"description": "Day of week the weekly shift summary is sent",
"nullable": true
},
"shift_report_time_of_day": {
"type": "string",
"description": "Time of day the weekly shift summary is sent, in HH:MM 24-hour format",
"nullable": true
},
"shift_report_time_zone": {
"type": "string",
"description": "IANA time zone used for the weekly shift summary",
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"schedule": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the schedule"
},
"description": {
"type": "string",
"description": "The description of the schedule",
"nullable": true
},
"all_time_coverage": {
"type": "boolean",
"description": "24/7 coverage of the schedule",
"nullable": true
},
"slack_user_group": {
"type": "object",
"description": "Synced slack group of the schedule",
"nullable": true,
"properties": {
"id": {
"type": "string",
"description": "Slack user group ID"
},
"name": {
"type": "string",
"description": "Slack user group name"
}
}
},
"slack_channel": {
"type": "object",
"description": "Synced slack channel of the schedule",
"properties": {
"id": {
"type": "string",
"description": "Slack channel ID"
},
"name": {
"type": "string",
"description": "Slack channel name"
}
},
"nullable": true
},
"owner_group_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Owning teams."
},
"owner_user_id": {
"type": "integer",
"description": "ID of user assigned as owner of the schedule"
},
"sync_linear_enabled": {
"type": "boolean",
"description": "Whether the schedule is synced with Linear"
},
"include_shadows_in_slack_notifications": {
"type": "boolean",
"description": "Whether shadow users are included in Slack notifications and user group syncing. Requires `slack_channel` to be set; otherwise this value is forced to false on save."
},
"shift_start_notifications_enabled": {
"type": "boolean",
"description": "Whether shift-start notifications are enabled. Requires `slack_channel` to be set; otherwise this value is forced to false on save."
},
"shift_update_notifications_enabled": {
"type": "boolean",
"description": "Whether shift-update notifications are enabled. Requires `slack_channel` to be set; otherwise this value is forced to false on save."
},
"shift_report_enabled": {
"type": "boolean",
"description": "Whether the weekly shift summary report is enabled. Requires `slack_channel` to be set; otherwise this value is forced to false on save."
},
"shift_report_day_of_week": {
"type": "string",
"enum": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday",
"sunday"
],
"description": "Day of week the weekly shift summary is sent"
},
"shift_report_time_of_day": {
"type": "string",
"description": "Time of day the weekly shift summary is sent, in HH:MM 24-hour format"
},
"shift_report_time_zone": {
"type": "string",
"description": "IANA time zone used for the weekly shift summary"
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"name",
"owner_user_id",
"created_at",
"updated_at"
]
},
"schedule_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique id of schedule"
},
"type": {
"type": "string",
"enum": [
"schedules"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/schedule"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"schedule_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the schedule"
},
"type": {
"type": "string",
"enum": [
"schedules"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/schedule"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_secret": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"secrets"
]
},
"attributes": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "The kind of the secret",
"enum": [
"built_in",
"hashicorp_vault"
]
},
"name": {
"type": "string",
"description": "The name of the secret"
},
"secret": {
"type": "string",
"description": "The secret"
},
"hashicorp_vault_mount": {
"type": "string",
"description": "The HashiCorp Vault secret mount path",
"nullable": true,
"default": "secret"
},
"hashicorp_vault_path": {
"type": "string",
"description": "The HashiCorp Vault secret path",
"nullable": true
},
"hashicorp_vault_version": {
"type": "string",
"description": "The HashiCorp Vault secret version",
"nullable": true,
"default": 0
}
},
"additionalProperties": false,
"required": [
"name",
"secret"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_secret": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"secrets"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the secret"
},
"secret": {
"type": "string",
"description": "The secret"
},
"hashicorp_vault_mount": {
"type": "string",
"description": "The HashiCorp Vault secret mount path",
"nullable": true,
"default": "secret"
},
"hashicorp_vault_path": {
"type": "string",
"description": "The HashiCorp Vault secret path",
"nullable": true
},
"hashicorp_vault_version": {
"type": "integer",
"description": "The HashiCorp Vault secret version",
"nullable": true,
"default": 0
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"secret": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the secret"
},
"secret": {
"type": "string",
"description": "The redacted secret"
},
"hashicorp_vault_mount": {
"type": "string",
"description": "The HashiCorp Vault secret mount path"
},
"hashicorp_vault_path": {
"type": "string",
"description": "The HashiCorp Vault secret path",
"nullable": true
},
"hashicorp_vault_version": {
"type": "integer",
"description": "The HashiCorp Vault secret version"
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"name",
"created_at",
"updated_at"
]
},
"secret_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the secret"
},
"type": {
"type": "string",
"enum": [
"secrets"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/secret"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"secret_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the secret"
},
"type": {
"type": "string",
"enum": [
"secrets"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/secret"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
}
},
"required": [
"data"
]
},
"new_service": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"services"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the service"
},
"description": {
"type": "string",
"description": "The description of the service",
"nullable": true
},
"public_description": {
"type": "string",
"description": "The public description of the service",
"nullable": true
},
"notify_emails": {
"type": "array",
"description": "Emails to attach to the service",
"items": {
"type": "string"
},
"nullable": true
},
"color": {
"type": "string",
"description": "The hex color of the service",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the service",
"nullable": true
},
"show_uptime": {
"type": "boolean",
"description": "Show uptime",
"nullable": true
},
"show_uptime_last_days": {
"type": "integer",
"description": "Show uptime over x days",
"enum": [
30,
60,
90
],
"nullable": true,
"default": 60
},
"backstage_id": {
"type": "string",
"description": "The Backstage entity id associated to this service. eg: :namespace/:kind/:entity_name",
"nullable": true
},
"pagerduty_id": {
"type": "string",
"description": "The PagerDuty service id associated to this service",
"nullable": true
},
"external_id": {
"type": "string",
"description": "The external id associated to this service",
"nullable": true
},
"opsgenie_id": {
"type": "string",
"description": "The Opsgenie service id associated to this service",
"nullable": true
},
"opsgenie_team_id": {
"type": "string",
"description": "The Opsgenie team id associated to this service",
"nullable": true
},
"cortex_id": {
"type": "string",
"description": "The Cortex group id associated to this service",
"nullable": true
},
"service_now_ci_sys_id": {
"type": "string",
"description": "The Service Now CI sys id associated to this service",
"nullable": true
},
"github_repository_name": {
"type": "string",
"description": "The GitHub repository name associated to this service. eg: rootlyhq/my-service",
"nullable": true
},
"github_repository_branch": {
"type": "string",
"description": "The GitHub repository branch associated to this service. eg: main",
"nullable": true
},
"gitlab_repository_name": {
"type": "string",
"description": "The GitLab repository name associated to this service. eg: rootlyhq/my-service",
"nullable": true
},
"gitlab_repository_branch": {
"type": "string",
"description": "The GitLab repository branch associated to this service. eg: main",
"nullable": true
},
"environment_ids": {
"type": "array",
"description": "Environments associated with this service",
"items": {
"type": "string"
},
"nullable": true
},
"service_ids": {
"type": "array",
"description": "Services dependent on this service",
"items": {
"type": "string"
},
"nullable": true
},
"owner_group_ids": {
"type": "array",
"description": "Owner Teams associated with this service",
"items": {
"type": "string"
},
"nullable": true
},
"owner_user_ids": {
"type": "array",
"description": "Owner Users associated with this service",
"items": {
"type": "integer"
},
"nullable": true
},
"kubernetes_deployment_name": {
"type": "string",
"description": "The Kubernetes deployment name associated to this service. eg: namespace/deployment-name",
"nullable": true
},
"alerts_email_enabled": {
"type": "boolean",
"description": "Enable alerts through email",
"nullable": true
},
"alert_urgency_id": {
"type": "string",
"description": "The alert urgency id of the service",
"nullable": true
},
"escalation_policy_id": {
"type": "string",
"description": "The escalation policy id of the service",
"nullable": true
},
"slack_channels": {
"type": "array",
"description": "Slack Channels associated with this service",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack channel ID"
},
"name": {
"type": "string",
"description": "Slack channel name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
},
"slack_aliases": {
"type": "array",
"description": "Slack Aliases associated with this service",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack alias ID"
},
"name": {
"type": "string",
"description": "Slack alias name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
},
"alert_broadcast_enabled": {
"type": "boolean",
"description": "Enable alerts to be broadcasted to a specific channel",
"nullable": true
},
"alert_broadcast_channel": {
"type": "object",
"description": "Slack channel to broadcast alerts to",
"properties": {
"id": {
"type": "string",
"description": "Slack channel ID"
},
"name": {
"type": "string",
"description": "Slack channel name"
}
},
"required": [
"id"
],
"nullable": true
},
"incident_broadcast_enabled": {
"type": "boolean",
"description": "Enable incidents to be broadcasted to a specific channel",
"nullable": true
},
"incident_broadcast_channel": {
"type": "object",
"description": "Slack channel to broadcast incidents to",
"properties": {
"id": {
"type": "string",
"description": "Slack channel ID"
},
"name": {
"type": "string",
"description": "Slack channel name"
}
},
"required": [
"id"
],
"nullable": true
},
"properties": {
"type": "array",
"items": {
"type": "object",
"description": "Set a value for a catalog property",
"properties": {
"catalog_property_id": {
"type": "string",
"description": "Catalog property ID"
},
"value": {
"type": "string",
"description": "The property value"
}
},
"required": [
"catalog_property_id",
"value"
]
},
"description": "Array of property values for this service."
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_service": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"services"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the service"
},
"description": {
"type": "string",
"description": "The description of the service",
"nullable": true
},
"public_description": {
"type": "string",
"description": "The public description of the service",
"nullable": true
},
"notify_emails": {
"type": "array",
"description": "Emails to attach to the service",
"items": {
"type": "string"
},
"nullable": true
},
"color": {
"type": "string",
"description": "The hex color of the service",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the service",
"nullable": true
},
"backstage_id": {
"type": "string",
"description": "The Backstage entity id associated to this service. eg: :namespace/:kind/:entity_name",
"nullable": true
},
"external_id": {
"type": "string",
"description": "The external id associated to this service",
"nullable": true
},
"pagerduty_id": {
"type": "string",
"description": "The PagerDuty service id associated to this service",
"nullable": true
},
"opsgenie_id": {
"type": "string",
"description": "The Opsgenie service id associated to this service",
"nullable": true
},
"cortex_id": {
"type": "string",
"description": "The Cortex group id associated to this service",
"nullable": true
},
"service_now_ci_sys_id": {
"type": "string",
"description": "The Service Now CI sys id associated to this service",
"nullable": true
},
"github_repository_name": {
"type": "string",
"description": "The GitHub repository name associated to this service. eg: rootlyhq/my-service",
"nullable": true
},
"github_repository_branch": {
"type": "string",
"description": "The GitHub repository branch associated to this service. eg: main",
"nullable": true
},
"gitlab_repository_name": {
"type": "string",
"description": "The GitLab repository name associated to this service. eg: rootlyhq/my-service",
"nullable": true
},
"gitlab_repository_branch": {
"type": "string",
"description": "The GitLab repository branch associated to this service. eg: main",
"nullable": true
},
"environment_ids": {
"type": "array",
"description": "Environments associated with this service",
"items": {
"type": "string"
},
"nullable": true
},
"service_ids": {
"type": "array",
"description": "Services dependent on this service",
"items": {
"type": "string"
},
"nullable": true
},
"owner_group_ids": {
"type": "array",
"description": "Owner Teams associated with this service",
"items": {
"type": "string"
},
"nullable": true
},
"owner_user_ids": {
"type": "array",
"description": "Owner Users associated with this service",
"items": {
"type": "integer"
},
"nullable": true
},
"alerts_email_enabled": {
"type": "boolean",
"description": "Enable alerts through email",
"nullable": true
},
"alert_urgency_id": {
"type": "string",
"description": "The alert urgency id of the service",
"nullable": true
},
"escalation_policy_id": {
"type": "string",
"description": "The escalation policy id of the service",
"nullable": true
},
"kubernetes_deployment_name": {
"type": "string",
"description": "The Kubernetes deployment name associated to this service. eg: namespace/deployment-name",
"nullable": true
},
"slack_channels": {
"type": "array",
"description": "Slack Channels associated with this service",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack channel ID"
},
"name": {
"type": "string",
"description": "Slack channel name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
},
"slack_aliases": {
"type": "array",
"description": "Slack Aliases associated with this service",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack alias ID"
},
"name": {
"type": "string",
"description": "Slack alias name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
},
"alert_broadcast_enabled": {
"type": "boolean",
"description": "Enable alerts to be broadcasted to a specific channel",
"nullable": true
},
"alert_broadcast_channel": {
"type": "object",
"description": "Slack channel to broadcast alerts to",
"properties": {
"id": {
"type": "string",
"description": "Slack channel ID"
},
"name": {
"type": "string",
"description": "Slack channel name"
}
},
"required": [
"id"
],
"nullable": true
},
"incident_broadcast_enabled": {
"type": "boolean",
"description": "Enable incidents to be broadcasted to a specific channel",
"nullable": true
},
"incident_broadcast_channel": {
"type": "object",
"description": "Slack channel to broadcast incidents to",
"properties": {
"id": {
"type": "string",
"description": "Slack channel ID"
},
"name": {
"type": "string",
"description": "Slack channel name"
}
},
"required": [
"id"
],
"nullable": true
},
"properties": {
"type": "array",
"items": {
"type": "object",
"description": "Set a value for a catalog property",
"properties": {
"catalog_property_id": {
"type": "string",
"description": "Catalog property ID"
},
"value": {
"type": "string",
"description": "The property value"
}
},
"required": [
"catalog_property_id",
"value"
]
},
"description": "Array of property values for this service."
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"service": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the service"
},
"slug": {
"type": "string",
"description": "The slug of the service"
},
"description": {
"type": "string",
"description": "The description of the service",
"nullable": true
},
"public_description": {
"type": "string",
"description": "The public description of the service",
"nullable": true
},
"notify_emails": {
"type": "array",
"description": "Emails attached to the service",
"items": {
"type": "string"
},
"nullable": true
},
"color": {
"type": "string",
"description": "The hex color of the service",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the service",
"nullable": true
},
"backstage_id": {
"type": "string",
"description": "The Backstage entity id associated to this service. eg: :namespace/:kind/:entity_name",
"nullable": true
},
"external_id": {
"type": "string",
"description": "The external id associated to this service",
"nullable": true
},
"pagerduty_id": {
"type": "string",
"description": "The PagerDuty service id associated to this service",
"nullable": true
},
"opsgenie_id": {
"type": "string",
"description": "The Opsgenie service id associated to this service",
"nullable": true
},
"cortex_id": {
"type": "string",
"description": "The Cortex group id associated to this service",
"nullable": true
},
"service_now_ci_sys_id": {
"type": "string",
"description": "The Service Now CI sys id associated to this service",
"nullable": true
},
"github_repository_name": {
"type": "string",
"description": "The GitHub repository name associated to this service. eg: rootlyhq/my-service",
"nullable": true
},
"github_repository_branch": {
"type": "string",
"description": "The GitHub repository branch associated to this service. eg: main",
"nullable": true
},
"gitlab_repository_name": {
"type": "string",
"description": "The GitLab repository name associated to this service. eg: rootlyhq/my-service",
"nullable": true
},
"gitlab_repository_branch": {
"type": "string",
"description": "The GitLab repository branch associated to this service. eg: main",
"nullable": true
},
"kubernetes_deployment_name": {
"type": "string",
"description": "The Kubernetes deployment name associated to this service. eg: namespace/deployment-name",
"nullable": true
},
"environment_ids": {
"type": "array",
"description": "Environments associated with this service",
"items": {
"type": "string"
},
"nullable": true
},
"service_ids": {
"type": "array",
"description": "Services dependent on this service",
"items": {
"type": "string"
},
"nullable": true
},
"owner_group_ids": {
"type": "array",
"description": "Owner Teams associated with this service",
"items": {
"type": "string"
},
"nullable": true
},
"owner_user_ids": {
"type": "array",
"description": "Owner Users associated with this service",
"items": {
"type": "integer"
},
"nullable": true
},
"alert_urgency_id": {
"type": "string",
"description": "The alert urgency id of the service",
"nullable": true
},
"escalation_policy_id": {
"type": "string",
"description": "The escalation policy id of the service",
"nullable": true
},
"alerts_email_enabled": {
"type": "boolean",
"description": "Enable alerts through email",
"nullable": true
},
"alerts_email_address": {
"type": "string",
"description": "Email generated to send alerts to",
"nullable": true
},
"slack_channels": {
"type": "array",
"description": "Slack Channels associated with this service",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack channel ID"
},
"name": {
"type": "string",
"description": "Slack channel name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
},
"slack_aliases": {
"type": "array",
"description": "Slack Aliases associated with this service",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack alias ID"
},
"name": {
"type": "string",
"description": "Slack alias name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
},
"alert_broadcast_enabled": {
"type": "boolean",
"description": "Enable alerts to be broadcasted to a specific channel",
"nullable": true
},
"alert_broadcast_channel": {
"type": "object",
"description": "Slack channel to broadcast alerts to",
"properties": {
"id": {
"type": "string",
"description": "Slack channel ID"
},
"name": {
"type": "string",
"description": "Slack channel name"
}
},
"nullable": true
},
"incident_broadcast_enabled": {
"type": "boolean",
"description": "Enable incidents to be broadcasted to a specific channel",
"nullable": true
},
"incident_broadcast_channel": {
"type": "object",
"description": "Slack channel to broadcast incidents to",
"properties": {
"id": {
"type": "string",
"description": "Slack channel ID"
},
"name": {
"type": "string",
"description": "Slack channel name"
}
},
"nullable": true
},
"properties": {
"type": "array",
"items": {
"type": "object",
"description": "Set a value for a catalog property",
"properties": {
"catalog_property_id": {
"type": "string",
"description": "Catalog property ID"
},
"value": {
"type": "string",
"description": "The property value"
}
},
"required": [
"catalog_property_id",
"value"
]
},
"description": "Array of property values for this service.",
"nullable": true
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"name",
"created_at",
"updated_at"
]
},
"service_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the service"
},
"type": {
"type": "string",
"enum": [
"services"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/service"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"service_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the service"
},
"type": {
"type": "string",
"enum": [
"services"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/service"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_severity": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"severities"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the severity"
},
"description": {
"type": "string",
"description": "The description of the severity",
"nullable": true
},
"severity": {
"type": "string",
"description": "The severity of the severity",
"enum": [
"critical",
"high",
"medium",
"low"
]
},
"color": {
"type": "string",
"description": "The hex color of the severity",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the severity",
"nullable": true
},
"notify_emails": {
"type": "array",
"description": "Emails to attach to the severity",
"items": {
"type": "string"
},
"nullable": true
},
"slack_channels": {
"type": "array",
"description": "Slack Channels associated with this severity",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack channel ID"
},
"name": {
"type": "string",
"description": "Slack channel name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
},
"slack_aliases": {
"type": "array",
"description": "Slack Aliases associated with this severity",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack alias ID"
},
"name": {
"type": "string",
"description": "Slack alias name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_severity": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"severities"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the severity"
},
"description": {
"type": "string",
"description": "The description of the severity",
"nullable": true
},
"severity": {
"type": "string",
"description": "The severity of the severity",
"enum": [
"critical",
"high",
"medium",
"low"
]
},
"color": {
"type": "string",
"description": "The hex color of the severity",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the severity",
"nullable": true
},
"notify_emails": {
"type": "array",
"description": "Emails to attach to the severity",
"items": {
"type": "string"
},
"nullable": true
},
"slack_channels": {
"type": "array",
"description": "Slack Channels associated with this severity",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack channel ID"
},
"name": {
"type": "string",
"description": "Slack channel name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
},
"slack_aliases": {
"type": "array",
"description": "Slack Aliases associated with this severity",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack alias ID"
},
"name": {
"type": "string",
"description": "Slack alias name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"severity": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the severity"
},
"slug": {
"type": "string",
"description": "The slug of the severity"
},
"description": {
"type": "string",
"description": "The description of the severity",
"nullable": true
},
"severity": {
"type": "string",
"description": "The severity of the severity",
"enum": [
"critical",
"high",
"medium",
"low"
]
},
"color": {
"type": "string",
"description": "The hex color of the severity",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the severity",
"nullable": true
},
"notify_emails": {
"type": "array",
"description": "Emails to attach to the severity",
"items": {
"type": "string"
},
"nullable": true
},
"slack_channels": {
"type": "array",
"description": "Slack Channels associated with this severity",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack channel ID"
},
"name": {
"type": "string",
"description": "Slack channel name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
},
"slack_aliases": {
"type": "array",
"description": "Slack Aliases associated with this severity",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack alias ID"
},
"name": {
"type": "string",
"description": "Slack alias name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"name",
"created_at",
"updated_at"
]
},
"severity_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the severity"
},
"type": {
"type": "string",
"enum": [
"severities"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/severity"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"severity_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the severity"
},
"type": {
"type": "string",
"enum": [
"severities"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/severity"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"shift": {
"type": "object",
"properties": {
"schedule_id": {
"type": "string",
"description": "ID of schedule",
"nullable": false
},
"rotation_id": {
"type": "string",
"description": "ID of rotation",
"nullable": true
},
"starts_at": {
"type": "string",
"description": "Start datetime of shift",
"nullable": false
},
"ends_at": {
"type": "string",
"description": "End datetime of shift",
"nullable": false
},
"is_override": {
"type": "boolean",
"description": "Denotes shift is an override shift"
},
"is_shadow": {
"type": "boolean",
"description": "Denotes shift is a shadow shift"
},
"user_id": {
"type": "integer",
"description": "ID of user on shift",
"nullable": true
}
},
"required": [
"schedule_id",
"rotation_id",
"starts_at",
"ends_at",
"is_override",
"is_shadow"
]
},
"shift_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the shift"
},
"type": {
"type": "string",
"enum": [
"shifts"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/shift"
}
]
},
"relationships": {
"$ref": "#/components/schemas/shift_relationships"
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"shift_relationships": {
"type": "object",
"properties": {
"shift_override": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"shift_overrides"
]
}
},
"nullable": true
}
}
},
"user": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"users"
]
}
},
"nullable": true
}
}
},
"assignee": {
"type": "object",
"description": "Assignee can be either a User or Schedule",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
}
},
"nullable": true
}
}
}
}
},
"new_shift_coverage_request": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"shift_coverage_requests"
]
},
"attributes": {
"type": "object",
"properties": {
"starts_at": {
"type": "string",
"description": "Start datetime of the time range to request coverage for",
"format": "date-time",
"nullable": false
},
"ends_at": {
"type": "string",
"description": "End datetime of the time range to request coverage for",
"format": "date-time",
"nullable": false
},
"user_id": {
"type": "integer",
"description": "Optional. Restrict coverage to shifts assigned to this user. When omitted, every shift overlapping the time range is covered.",
"nullable": false
}
},
"additionalProperties": false,
"required": [
"starts_at",
"ends_at"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"shift_coverage_request": {
"type": "object",
"properties": {
"schedule_id": {
"type": "string",
"description": "ID of schedule",
"nullable": false
},
"shift_id": {
"type": "string",
"description": "ID of the shift being covered",
"nullable": false
},
"original_shift_user_id": {
"type": "integer",
"description": "ID of the user whose shift is being covered",
"nullable": false
},
"created_by_user_id": {
"type": "integer",
"description": "ID of the user who created the coverage request",
"nullable": false
},
"starts_at": {
"type": "string",
"description": "Start datetime of the coverage request",
"nullable": false
},
"ends_at": {
"type": "string",
"description": "End datetime of the coverage request",
"nullable": false
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
},
"schedule": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/schedule_response"
}
],
"description": "Schedule metadata",
"nullable": false
},
"shift": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/shift"
}
],
"description": "Shift metadata",
"nullable": false
},
"original_shift_user": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/user_response"
}
],
"description": "User whose shift is being covered",
"nullable": false
},
"created_by_user": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/user_response"
}
],
"description": "User who created the coverage request",
"nullable": false
}
},
"required": [
"schedule_id",
"shift_id",
"original_shift_user_id",
"created_by_user_id",
"starts_at",
"ends_at"
]
},
"shift_coverage_request_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the coverage request"
},
"type": {
"type": "string",
"enum": [
"shift_coverage_requests"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/shift_coverage_request"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"shift_coverage_request_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the coverage request"
},
"type": {
"type": "string",
"enum": [
"shift_coverage_requests"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/shift_coverage_request"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"slack_channel": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"slack_channel_name": {
"type": "string"
},
"slack_channel_id": {
"type": "string"
},
"slack_team_id": {
"type": "string"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"id",
"slack_channel_name",
"slack_channel_id",
"slack_team_id",
"created_at",
"updated_at"
]
},
"new_status_page_template": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"status_page_templates"
]
},
"attributes": {
"type": "object",
"properties": {
"status_page_id": {
"type": "string"
},
"title": {
"type": "string",
"description": "Title of the template"
},
"update_title": {
"type": "string",
"description": "Title that will be used for the status page update",
"nullable": true
},
"body": {
"type": "string",
"description": "Description of the event the template will populate"
},
"update_status": {
"type": "string",
"description": "Status of the event the template will populate",
"enum": [
"investigating",
"identified",
"monitoring",
"resolved",
"scheduled",
"in_progress",
"completed"
],
"nullable": true
},
"kind": {
"type": "string",
"description": "The kind of the status page template",
"nullable": false,
"enum": [
"normal",
"scheduled"
]
},
"should_notify_subscribers": {
"type": "boolean",
"description": "Controls if incident subscribers should be notified",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the status page template"
},
"enabled": {
"type": "boolean",
"description": "Enable / Disable the status page template",
"nullable": true
}
},
"additionalProperties": false,
"required": [
"title",
"body"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_status_page_template": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"status_page_templates"
]
},
"attributes": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Title of the template"
},
"update_title": {
"type": "string",
"description": "Title that will be used for the status page update",
"nullable": true
},
"body": {
"type": "string",
"description": "Description of the event the template will populate"
},
"update_status": {
"type": "string",
"description": "Status of the event the template will populate",
"enum": [
"investigating",
"identified",
"monitoring",
"resolved",
"scheduled",
"in_progress",
"completed"
],
"nullable": true
},
"kind": {
"type": "string",
"description": "The kind of the status page template",
"nullable": false,
"enum": [
"normal",
"scheduled"
]
},
"should_notify_subscribers": {
"type": "boolean",
"description": "Controls if incident subscribers should be notified",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the workflow task"
},
"enabled": {
"type": "boolean",
"description": "Enable / Disable the status page template",
"nullable": true
}
},
"additionalProperties": false,
"required": [
"title",
"body"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"status_page_template": {
"type": "object",
"properties": {
"status_page_id": {
"type": "string"
},
"title": {
"type": "string",
"description": "Title of the template"
},
"update_title": {
"type": "string",
"description": "Title that will be used for the status page update",
"nullable": true
},
"body": {
"type": "string",
"description": "Description of the event the template will populate"
},
"update_status": {
"type": "string",
"description": "Status of the event the template will populate",
"nullable": true
},
"kind": {
"type": "string",
"description": "The kind of the status page template",
"nullable": false,
"enum": [
"normal",
"scheduled"
]
},
"should_notify_subscribers": {
"type": "boolean",
"description": "Controls if incident subscribers should be notified",
"nullable": true
},
"enabled": {
"type": "boolean",
"description": "Enable / Disable the status page template",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the workflow task"
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"status_page_id",
"title",
"body",
"created_at",
"updated_at"
]
},
"status_page_template_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the status page template"
},
"type": {
"type": "string",
"enum": [
"status_page_templates"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/status_page_template"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"status_page_template_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the template"
},
"type": {
"type": "string",
"enum": [
"status_page_templates"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/status_page_template"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_status_page": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"status_pages"
]
},
"attributes": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the status page"
},
"public_title": {
"type": "string",
"description": "The public title of the status page",
"nullable": true
},
"description": {
"type": "string",
"description": "The description of the status page",
"nullable": true
},
"public_description": {
"type": "string",
"description": "The public description of the status page",
"nullable": true
},
"header_color": {
"type": "string",
"description": "The color of the header. Eg. \"#0061F2\"",
"nullable": true
},
"footer_color": {
"type": "string",
"description": "The color of the footer. Eg. \"#1F2F41\"",
"nullable": true
},
"allow_search_engine_index": {
"type": "boolean",
"description": "Allow search engines to include your public status page in search results",
"nullable": true
},
"show_uptime": {
"type": "boolean",
"description": "Show uptime",
"nullable": true
},
"show_uptime_last_days": {
"type": "integer",
"description": "Show uptime over x days",
"enum": [
30,
60,
90
],
"nullable": true
},
"success_message": {
"type": "string",
"description": "Message showing when all components are operational",
"nullable": true
},
"failure_message": {
"type": "string",
"description": "Message showing when at least one component is not operational",
"nullable": true
},
"authentication_method": {
"type": "string",
"description": "Authentication method",
"enum": [
"none",
"password",
"saml"
],
"default": "none",
"nullable": true
},
"authentication_enabled": {
"type": "boolean",
"description": "Enable authentication (deprecated - use authentication_method instead)",
"nullable": true,
"default": false,
"deprecated": true
},
"authentication_password": {
"type": "string",
"description": "Authentication password",
"nullable": true
},
"saml_idp_sso_service_url": {
"type": "string",
"description": "SAML IdP SSO service URL",
"nullable": true
},
"saml_idp_slo_service_url": {
"type": "string",
"description": "SAML IdP SLO service URL",
"nullable": true
},
"saml_idp_cert": {
"type": "string",
"description": "SAML IdP certificate",
"nullable": true
},
"saml_name_identifier_format": {
"type": "string",
"description": "SAML name identifier format",
"enum": [
"urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress",
"urn:oasis:names:tc:SAML:2.0:nameid-format:persistent",
"urn:oasis:names:tc:SAML:2.0:nameid-format:transient",
"urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified"
],
"nullable": true
},
"section_order": {
"type": "array",
"description": "Order of sections on the status page",
"items": {
"type": "string",
"enum": [
"maintenance",
"system_status",
"incidents"
]
},
"default": [
"maintenance",
"system_status",
"incidents"
],
"nullable": true
},
"external_domain_names": {
"type": "array",
"items": {
"type": "string"
},
"description": "External domain names attached to the status page",
"nullable": true
},
"website_url": {
"type": "string",
"description": "Website URL",
"nullable": true
},
"website_privacy_url": {
"type": "string",
"description": "Website Privacy URL",
"nullable": true
},
"website_support_url": {
"type": "string",
"description": "Website Support URL",
"nullable": true
},
"ga_tracking_id": {
"type": "string",
"description": "Google Analytics tracking ID",
"nullable": true
},
"time_zone": {
"type": "string",
"description": "A valid IANA time zone name.",
"default": "Etc/UTC",
"nullable": true
},
"public": {
"type": "boolean",
"description": "Make the status page accessible to the public",
"nullable": true
},
"service_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Services attached to the status page"
},
"functionality_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Functionalities attached to the status page"
},
"enabled": {
"type": "boolean",
"description": "Enabled / Disable the status page",
"nullable": true
}
},
"additionalProperties": false,
"required": [
"title"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_status_page": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"status_pages"
]
},
"attributes": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the status page"
},
"public_title": {
"type": "string",
"description": "The public title of the status page",
"nullable": true
},
"description": {
"type": "string",
"description": "The description of the status page",
"nullable": true
},
"public_description": {
"type": "string",
"description": "The public description of the status page",
"nullable": true
},
"header_color": {
"type": "string",
"description": "The color of the header. Eg. \"#0061F2\"",
"nullable": true
},
"footer_color": {
"type": "string",
"description": "The color of the footer. Eg. \"#1F2F41\"",
"nullable": true
},
"allow_search_engine_index": {
"type": "boolean",
"description": "Allow search engines to include your public status page in search results",
"nullable": true
},
"show_uptime": {
"type": "boolean",
"description": "Show uptime",
"nullable": true
},
"show_uptime_last_days": {
"type": "integer",
"description": "Show uptime over x days",
"enum": [
30,
60,
90
],
"nullable": true
},
"success_message": {
"type": "string",
"description": "Message showing when all components are operational",
"nullable": true
},
"failure_message": {
"type": "string",
"description": "Message showing when at least one component is not operational",
"nullable": true
},
"authentication_method": {
"type": "string",
"description": "Authentication method",
"enum": [
"none",
"password",
"saml"
],
"default": "none",
"nullable": true
},
"authentication_enabled": {
"type": "boolean",
"description": "Enable authentication (deprecated - use authentication_method instead)",
"nullable": true,
"default": false,
"deprecated": true
},
"authentication_password": {
"type": "string",
"description": "Authentication password",
"nullable": true
},
"saml_idp_sso_service_url": {
"type": "string",
"description": "SAML IdP SSO service URL",
"nullable": true
},
"saml_idp_slo_service_url": {
"type": "string",
"description": "SAML IdP SLO service URL",
"nullable": true
},
"saml_idp_cert": {
"type": "string",
"description": "SAML IdP certificate",
"nullable": true
},
"saml_name_identifier_format": {
"type": "string",
"description": "SAML name identifier format",
"enum": [
"urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress",
"urn:oasis:names:tc:SAML:2.0:nameid-format:persistent",
"urn:oasis:names:tc:SAML:2.0:nameid-format:transient",
"urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified"
],
"nullable": true
},
"section_order": {
"type": "array",
"description": "Order of sections on the status page",
"items": {
"type": "string",
"enum": [
"maintenance",
"system_status",
"incidents"
]
},
"nullable": true
},
"external_domain_names": {
"type": "array",
"items": {
"type": "string"
},
"description": "External domain names attached to the status page",
"nullable": true
},
"website_url": {
"type": "string",
"description": "Website URL",
"nullable": true
},
"website_privacy_url": {
"type": "string",
"description": "Website Privacy URL",
"nullable": true
},
"website_support_url": {
"type": "string",
"description": "Website Support URL",
"nullable": true
},
"ga_tracking_id": {
"type": "string",
"description": "Google Analytics tracking ID",
"nullable": true
},
"time_zone": {
"type": "string",
"description": "A valid IANA time zone name.",
"default": "Etc/UTC",
"nullable": true
},
"public": {
"type": "boolean",
"description": "Make the status page accessible to the public",
"nullable": true
},
"service_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Services attached to the status page"
},
"functionality_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Functionalities attached to the status page"
},
"enabled": {
"type": "boolean",
"description": "Enabled / Disable the status page",
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"status_page": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the status page"
},
"slug": {
"type": "string",
"description": "The slug of the status page"
},
"public_title": {
"type": "string",
"description": "The public title of the status page",
"nullable": true
},
"description": {
"type": "string",
"description": "The description of the status page",
"nullable": true
},
"public_description": {
"type": "string",
"description": "The public description of the status page",
"nullable": true
},
"header_color": {
"type": "string",
"description": "The color of the header. Eg. \"#0061F2\"",
"nullable": true
},
"footer_color": {
"type": "string",
"description": "The color of the footer. Eg. \"#1F2F41\"",
"nullable": true
},
"allow_search_engine_index": {
"type": "boolean",
"description": "Allow search engines to include your public status page in search results",
"nullable": true
},
"show_uptime": {
"type": "boolean",
"description": "Show uptime",
"nullable": true
},
"show_uptime_last_days": {
"type": "integer",
"description": "Show uptime over x days",
"enum": [
30,
60,
90
],
"nullable": true
},
"success_message": {
"type": "string",
"description": "Message showing when all components are operational",
"nullable": true
},
"failure_message": {
"type": "string",
"description": "Message showing when at least one component is not operational",
"nullable": true
},
"authentication_method": {
"type": "string",
"description": "Authentication method",
"enum": [
"none",
"password",
"saml"
],
"default": "none",
"nullable": true
},
"authentication_enabled": {
"type": "boolean",
"description": "Enable authentication (deprecated - use authentication_method instead)",
"nullable": true,
"default": false,
"deprecated": true
},
"authentication_password": {
"type": "string",
"description": "Authentication password",
"nullable": true
},
"saml_idp_sso_service_url": {
"type": "string",
"description": "SAML IdP SSO service URL",
"nullable": true
},
"saml_idp_slo_service_url": {
"type": "string",
"description": "SAML IdP SLO service URL",
"nullable": true
},
"saml_idp_cert": {
"type": "string",
"description": "SAML IdP certificate",
"nullable": true
},
"saml_idp_cert_fingerprint": {
"type": "string",
"description": "SAML IdP certificate fingerprint",
"nullable": true
},
"saml_name_identifier_format": {
"type": "string",
"description": "SAML name identifier format",
"enum": [
"urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress",
"urn:oasis:names:tc:SAML:2.0:nameid-format:persistent",
"urn:oasis:names:tc:SAML:2.0:nameid-format:transient",
"urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified"
],
"nullable": true
},
"section_order": {
"type": "array",
"description": "Order of sections on the status page",
"items": {
"type": "string",
"enum": [
"maintenance",
"system_status",
"incidents"
]
},
"nullable": true
},
"website_url": {
"type": "string",
"description": "Website URL",
"nullable": true
},
"website_privacy_url": {
"type": "string",
"description": "Website Privacy URL",
"nullable": true
},
"website_support_url": {
"type": "string",
"description": "Website Support URL",
"nullable": true
},
"ga_tracking_id": {
"type": "string",
"description": "Google Analytics tracking ID",
"nullable": true
},
"time_zone": {
"type": "string",
"description": "A valid IANA time zone name.",
"default": "Etc/UTC",
"nullable": true
},
"public": {
"type": "boolean",
"description": "Make the status page accessible to the public",
"nullable": true
},
"service_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Services attached to the status page"
},
"functionality_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Functionalities attached to the status page"
},
"external_domain_names": {
"type": "array",
"items": {
"type": "string"
},
"description": "External domain names attached to the status page"
},
"cname_records": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "CNAME records mapping external domain names to their DNS target values. These are populated asynchronously after setting external_domain_names.",
"nullable": true,
"readOnly": true
},
"enabled": {
"type": "boolean",
"description": "Enabled / Disable the status page",
"nullable": true
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"title",
"created_at",
"updated_at"
]
},
"status_page_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the status page"
},
"type": {
"type": "string",
"enum": [
"status_pages"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/status_page"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"status_page_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the status page"
},
"type": {
"type": "string",
"enum": [
"status_pages"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/status_page"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_team": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"groups"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the team"
},
"description": {
"type": "string",
"description": "The description of the team",
"nullable": true
},
"notify_emails": {
"type": "array",
"description": "Emails to attach to the team",
"items": {
"type": "string"
},
"nullable": true
},
"color": {
"type": "string",
"description": "The hex color of the team",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the team",
"nullable": true
},
"backstage_id": {
"type": "string",
"description": "The Backstage entity id associated to this team. eg: :namespace/:kind/:entity_name",
"nullable": true
},
"external_id": {
"type": "string",
"description": "The external id associated to this team",
"nullable": true
},
"pagerduty_id": {
"type": "string",
"description": "The PagerDuty group id associated to this team",
"nullable": true
},
"pagerduty_service_id": {
"type": "string",
"description": "The PagerDuty service id associated to this team",
"nullable": true
},
"opsgenie_id": {
"type": "string",
"description": "The Opsgenie group id associated to this team",
"nullable": true
},
"opsgenie_team_id": {
"type": "string",
"description": "The Opsgenie team id associated to this team",
"nullable": true
},
"victor_ops_id": {
"type": "string",
"description": "The VictorOps group id associated to this team",
"nullable": true
},
"pagertree_id": {
"type": "string",
"description": "The PagerTree group id associated to this team",
"nullable": true
},
"cortex_id": {
"type": "string",
"description": "The Cortex group id associated to this team",
"nullable": true
},
"service_now_ci_sys_id": {
"type": "string",
"description": "The Service Now CI sys id associated to this team",
"nullable": true
},
"user_ids": {
"type": "array",
"description": "The user ids of the members of this team.",
"items": {
"type": "integer"
},
"nullable": true
},
"admin_ids": {
"type": "array",
"description": "The user ids of the admins of this team. These users must also be present in user_ids attribute.",
"items": {
"type": "integer"
},
"nullable": true
},
"alerts_email_enabled": {
"type": "boolean",
"description": "Enable alerts through email",
"nullable": true
},
"alert_urgency_id": {
"type": "string",
"description": "The alert urgency id of the team",
"nullable": true
},
"slack_channels": {
"type": "array",
"description": "Slack Channels associated with this team",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack channel ID"
},
"name": {
"type": "string",
"description": "Slack channel name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
},
"slack_aliases": {
"type": "array",
"description": "Slack Aliases associated with this team",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack alias ID"
},
"name": {
"type": "string",
"description": "Slack alias name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
},
"alert_broadcast_enabled": {
"type": "boolean",
"description": "Enable alerts to be broadcasted to a specific channel",
"nullable": true
},
"alert_broadcast_channel": {
"type": "object",
"description": "Slack channel to broadcast alerts to",
"properties": {
"id": {
"type": "string",
"description": "Slack channel ID"
},
"name": {
"type": "string",
"description": "Slack channel name"
}
},
"required": [
"id"
],
"nullable": true
},
"incident_broadcast_enabled": {
"type": "boolean",
"description": "Enable incidents to be broadcasted to a specific channel",
"nullable": true
},
"incident_broadcast_channel": {
"type": "object",
"description": "Slack channel to broadcast incidents to",
"properties": {
"id": {
"type": "string",
"description": "Slack channel ID"
},
"name": {
"type": "string",
"description": "Slack channel name"
}
},
"required": [
"id"
],
"nullable": true
},
"auto_add_members_when_attached": {
"type": "boolean",
"description": "Auto add members to incident channel when team is attached",
"nullable": true
},
"auto_add_members_scope": {
"type": "string",
"enum": [
"off",
"public_only",
"public_and_test",
"all"
],
"description": "Visibility-scoped auto-add behavior. Only present when the `enable_scoped_incident_channel_auto_add` feature flag is on for the organization. When set, it overrides `auto_add_members_when_attached`.",
"nullable": true
},
"properties": {
"type": "array",
"items": {
"type": "object",
"description": "Set a value for a catalog property",
"properties": {
"catalog_property_id": {
"type": "string",
"description": "Catalog property ID"
},
"value": {
"type": "string",
"description": "The property value"
}
},
"required": [
"catalog_property_id",
"value"
]
},
"description": "Array of property values for this team."
}
},
"additionalProperties": false,
"required": [
"name"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_team": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"groups"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the team"
},
"description": {
"type": "string",
"description": "The description of the team",
"nullable": true
},
"notify_emails": {
"type": "array",
"description": "Emails to attach to the team",
"items": {
"type": "string"
},
"nullable": true
},
"color": {
"type": "string",
"description": "The hex color of the team",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the team",
"nullable": true
},
"backstage_id": {
"type": "string",
"description": "The Backstage entity id associated to this team. eg: :namespace/:kind/:entity_name",
"nullable": true
},
"external_id": {
"type": "string",
"description": "The external id associated to this team",
"nullable": true
},
"pagerduty_id": {
"type": "string",
"description": "The PagerDuty group id associated to this team",
"nullable": true
},
"pagerduty_service_id": {
"type": "string",
"description": "The PagerDuty service id associated to this team",
"nullable": true
},
"opsgenie_id": {
"type": "string",
"description": "The Opsgenie group id associated to this team",
"nullable": true
},
"victor_ops_id": {
"type": "string",
"description": "The VictorOps group id associated to this team",
"nullable": true
},
"pagertree_id": {
"type": "string",
"description": "The PagerTree group id associated to this team",
"nullable": true
},
"cortex_id": {
"type": "string",
"description": "The Cortex group id associated to this team",
"nullable": true
},
"service_now_ci_sys_id": {
"type": "string",
"description": "The Service Now CI sys id associated to this team",
"nullable": true
},
"user_ids": {
"type": "array",
"description": "The user ids of the members of this team.",
"items": {
"type": "integer"
},
"nullable": true
},
"admin_ids": {
"type": "array",
"description": "The user ids of the admins of this team. These users must also be present in user_ids attribute.",
"items": {
"type": "integer"
},
"nullable": true
},
"alerts_email_enabled": {
"type": "boolean",
"description": "Enable alerts through email",
"nullable": true
},
"alert_urgency_id": {
"type": "string",
"description": "The alert urgency id of the team",
"nullable": true
},
"slack_channels": {
"type": "array",
"description": "Slack Channels associated with this team",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack channel ID"
},
"name": {
"type": "string",
"description": "Slack channel name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
},
"slack_aliases": {
"type": "array",
"description": "Slack Aliases associated with this team",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack alias ID"
},
"name": {
"type": "string",
"description": "Slack alias name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
},
"alert_broadcast_enabled": {
"type": "boolean",
"description": "Enable alerts to be broadcasted to a specific channel",
"nullable": true
},
"alert_broadcast_channel": {
"type": "object",
"description": "Slack channel to broadcast alerts to",
"properties": {
"id": {
"type": "string",
"description": "Slack channel ID"
},
"name": {
"type": "string",
"description": "Slack channel name"
}
},
"required": [
"id"
],
"nullable": true
},
"incident_broadcast_enabled": {
"type": "boolean",
"description": "Enable incidents to be broadcasted to a specific channel",
"nullable": true
},
"incident_broadcast_channel": {
"type": "object",
"description": "Slack channel to broadcast incidents to",
"properties": {
"id": {
"type": "string",
"description": "Slack channel ID"
},
"name": {
"type": "string",
"description": "Slack channel name"
}
},
"required": [
"id"
],
"nullable": true
},
"auto_add_members_when_attached": {
"type": "boolean",
"description": "Auto add members to incident channel when team is attached",
"nullable": true
},
"auto_add_members_scope": {
"type": "string",
"enum": [
"off",
"public_only",
"public_and_test",
"all"
],
"description": "Visibility-scoped auto-add behavior. Only present when the `enable_scoped_incident_channel_auto_add` feature flag is on for the organization. When set, it overrides `auto_add_members_when_attached`.",
"nullable": true
},
"properties": {
"type": "array",
"items": {
"type": "object",
"description": "Set a value for a catalog property",
"properties": {
"catalog_property_id": {
"type": "string",
"description": "Catalog property ID"
},
"value": {
"type": "string",
"description": "The property value"
}
},
"required": [
"catalog_property_id",
"value"
]
},
"description": "Array of property values for this team."
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"team": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the team"
},
"slug": {
"type": "string"
},
"description": {
"type": "string",
"description": "The description of the team",
"nullable": true
},
"notify_emails": {
"type": "array",
"description": "Emails to attach to the team",
"items": {
"type": "string"
},
"nullable": true
},
"color": {
"type": "string",
"description": "The hex color of the team",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the team",
"nullable": true
},
"backstage_id": {
"type": "string",
"description": "The Backstage entity id associated to this team. eg: :namespace/:kind/:entity_name",
"nullable": true
},
"external_id": {
"type": "string",
"description": "The external id associated to this team",
"nullable": true
},
"pagerduty_id": {
"type": "string",
"description": "The PagerDuty group id associated to this team",
"nullable": true
},
"pagerduty_service_id": {
"type": "string",
"description": "The PagerDuty service id associated to this team",
"nullable": true
},
"opsgenie_id": {
"type": "string",
"description": "The Opsgenie group id associated to this team",
"nullable": true
},
"victor_ops_id": {
"type": "string",
"description": "The VictorOps group id associated to this team",
"nullable": true
},
"pagertree_id": {
"type": "string",
"description": "The PagerTree group id associated to this team",
"nullable": true
},
"cortex_id": {
"type": "string",
"description": "The Cortex group id associated to this team",
"nullable": true
},
"service_now_ci_sys_id": {
"type": "string",
"description": "The Service Now CI sys id associated to this team",
"nullable": true
},
"user_ids": {
"type": "array",
"description": "The user ids of the members of this team.",
"items": {
"type": "integer"
},
"nullable": true
},
"admin_ids": {
"type": "array",
"description": "The user ids of the admins of this team. These users must also be present in user_ids attribute.",
"items": {
"type": "integer"
},
"nullable": true
},
"alerts_email_enabled": {
"type": "boolean",
"description": "Enable alerts through email",
"nullable": true
},
"alerts_email_address": {
"type": "string",
"description": "Email generated to send alerts to",
"nullable": true
},
"alert_urgency_id": {
"type": "string",
"description": "The alert urgency id of the team",
"nullable": true
},
"slack_channels": {
"type": "array",
"description": "Slack Channels associated with this team",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack channel ID"
},
"name": {
"type": "string",
"description": "Slack channel name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
},
"slack_aliases": {
"type": "array",
"description": "Slack Aliases associated with this team",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Slack alias ID"
},
"name": {
"type": "string",
"description": "Slack alias name"
}
},
"required": [
"id",
"name"
]
},
"nullable": true
},
"alert_broadcast_enabled": {
"type": "boolean",
"description": "Enable alerts to be broadcasted to a specific channel",
"nullable": true
},
"alert_broadcast_channel": {
"type": "object",
"description": "Slack channel to broadcast alerts to",
"properties": {
"id": {
"type": "string",
"description": "Slack channel ID"
},
"name": {
"type": "string",
"description": "Slack channel name"
}
},
"nullable": true
},
"incident_broadcast_enabled": {
"type": "boolean",
"description": "Enable incidents to be broadcasted to a specific channel",
"nullable": true
},
"incident_broadcast_channel": {
"type": "object",
"description": "Slack channel to broadcast incidents to",
"properties": {
"id": {
"type": "string",
"description": "Slack channel ID"
},
"name": {
"type": "string",
"description": "Slack channel name"
}
},
"nullable": true
},
"auto_add_members_when_attached": {
"type": "boolean",
"description": "Auto add members to incident channel when team is attached",
"nullable": true
},
"auto_add_members_scope": {
"type": "string",
"enum": [
"off",
"public_only",
"public_and_test",
"all"
],
"description": "Visibility-scoped auto-add behavior. Only present when the `enable_scoped_incident_channel_auto_add` feature flag is on for the organization. When set, it overrides `auto_add_members_when_attached`.",
"nullable": true
},
"properties": {
"type": "array",
"items": {
"type": "object",
"description": "Set a value for a catalog property",
"properties": {
"catalog_property_id": {
"type": "string",
"description": "Catalog property ID"
},
"value": {
"type": "string",
"description": "The property value"
}
},
"required": [
"catalog_property_id",
"value"
]
},
"description": "Array of property values for this team.",
"nullable": true
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"name",
"created_at",
"updated_at"
]
},
"team_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the team"
},
"type": {
"type": "string",
"enum": [
"groups"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/team"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"team_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the team"
},
"type": {
"type": "string",
"enum": [
"groups"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/team"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_user_notification_rule": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"user_notification_rules"
]
},
"attributes": {
"type": "object",
"properties": {
"delay": {
"type": "integer",
"description": "Delay after which rule gets triggered",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the rule",
"nullable": true
},
"user_email_address_id": {
"type": "string",
"description": "User email address to which notification to be sent",
"nullable": true
},
"user_call_number_id": {
"type": "string",
"description": "User phone number to which notification to be sent",
"nullable": true
},
"user_sms_number_id": {
"type": "string",
"description": "User sms number to which notification to be sent",
"nullable": true
},
"user_device_id": {
"type": "string",
"description": "User device to which notification to be sent",
"nullable": true
},
"enabled_contact_types": {
"type": "array",
"description": "Contact types for which notification needs to be enabled",
"items": {
"type": "string",
"enum": [
"email",
"sms",
"call",
"device",
"non_critical_device",
"slack",
"google_chat"
]
},
"nullable": false
}
},
"additionalProperties": false,
"required": [
"enabled_contact_types"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_user_notification_rule": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"user_notification_rules"
]
},
"attributes": {
"type": "object",
"properties": {
"delay": {
"type": "integer",
"description": "Delay after which rule gets triggered",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the rule",
"nullable": true
},
"user_email_address_id": {
"type": "string",
"description": "User email address to which notification to be sent",
"nullable": true
},
"user_call_number_id": {
"type": "string",
"description": "User phone number to which notification to be sent",
"nullable": true
},
"user_sms_number_id": {
"type": "string",
"description": "User sms number to which notification to be sent",
"nullable": true
},
"user_device_id": {
"type": "string",
"description": "User device to which notification to be sent",
"nullable": true
},
"enabled_contact_types": {
"type": "array",
"description": "Contact types for which notification needs to be enabled",
"items": {
"type": "string",
"enum": [
"email",
"sms",
"call",
"device",
"non_critical_device",
"slack",
"google_chat"
]
},
"nullable": false
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"user_notification_rule": {
"type": "object",
"properties": {
"user_id": {
"type": "integer"
},
"delay": {
"type": "integer",
"description": "Delay after which rule gets triggered",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the rule",
"nullable": true
},
"user_email_address_id": {
"type": "string",
"description": "User email address to which notification to be sent",
"nullable": true
},
"user_call_number_id": {
"type": "string",
"description": "User phone number to which notification to be sent",
"nullable": true
},
"user_sms_number_id": {
"type": "string",
"description": "User sms number to which notification to be sent",
"nullable": true
},
"user_device_id": {
"type": "string",
"description": "User device to which notification to be sent",
"nullable": true
},
"enabled_contact_types": {
"type": "array",
"description": "Contact types for which notification needs to be enabled",
"items": {
"type": "string",
"enum": [
"email",
"sms",
"call",
"device",
"non_critical_device",
"slack",
"google_chat"
]
},
"nullable": false
},
"notification_type": {
"type": "string",
"description": "Type of notification rule (audible or quiet). Audible notifications use sound/vibration to alert users, while quiet notifications are silent.",
"enum": [
"audible",
"quiet"
],
"nullable": false
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
}
},
"user_notification_rule_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the rule"
},
"type": {
"type": "string",
"enum": [
"user_notification_rules"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/user_notification_rule"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"user_notification_rule_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the rule"
},
"type": {
"type": "string",
"enum": [
"user_notification_rules"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/user_notification_rule"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_user_phone_number": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"user_phone_numbers"
]
},
"attributes": {
"type": "object",
"properties": {
"phone": {
"type": "string",
"description": "Phone number in international format"
}
},
"additionalProperties": false,
"required": [
"phone"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_user_phone_number": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"user_phone_numbers"
]
},
"attributes": {
"type": "object",
"properties": {
"phone": {
"type": "string",
"description": "Phone number in international format"
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"user_phone_number": {
"type": "object",
"properties": {
"user_id": {
"type": "integer"
},
"phone": {
"type": "string",
"description": "Phone number in international format"
},
"primary": {
"type": "boolean",
"description": "Whether this is the primary phone number"
},
"verified_at": {
"type": "string",
"format": "date-time",
"description": "Date when phone number was verified",
"nullable": true
},
"verification_attempts_today": {
"type": "integer",
"description": "Number of verification attempts made today"
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
}
},
"user_phone_number_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the phone number"
},
"type": {
"type": "string",
"enum": [
"user_phone_numbers"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/user_phone_number"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"user_phone_number_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the phone number"
},
"type": {
"type": "string",
"enum": [
"user_phone_numbers"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/user_phone_number"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"verify_phone_number_request": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "6-digit verification code",
"pattern": "^[0-9]{6}$"
}
},
"required": [
"code"
]
},
"phone_verification_response": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Success message"
},
"error": {
"type": "string",
"description": "Error message"
}
}
},
"new_user_email_address": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"user_email_addresses"
]
},
"attributes": {
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "Email address"
}
},
"additionalProperties": false,
"required": [
"email"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_user_email_address": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"user_email_addresses"
]
},
"attributes": {
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "Email address"
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"user_email_address": {
"type": "object",
"properties": {
"user_id": {
"type": "integer"
},
"email": {
"type": "string",
"description": "Email address"
},
"primary": {
"type": "boolean",
"description": "Whether this is the primary email address"
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
}
},
"user_email_address_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the email address"
},
"type": {
"type": "string",
"enum": [
"user_email_addresses"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/user_email_address"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"user_email_address_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the email address"
},
"type": {
"type": "string",
"enum": [
"user_email_addresses"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/user_email_address"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"user": {
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "The email of the user"
},
"first_name": {
"type": "string",
"description": "First name of the user",
"nullable": true
},
"last_name": {
"type": "string",
"description": "Last name of the user",
"nullable": true
},
"full_name": {
"type": "string",
"description": "The full name of the user",
"nullable": true
},
"full_name_with_team": {
"type": "string",
"description": "The full name with team of the user",
"nullable": true
},
"time_zone": {
"type": "string",
"description": "Configured time zone",
"nullable": true
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"email",
"created_at",
"updated_at"
]
},
"user_flat_response": {
"type": "object",
"description": "Flat user attributes as returned by UserFlatSerializer (no nested associations)",
"properties": {
"id": {
"type": "integer",
"description": "User ID"
},
"name": {
"type": "string",
"description": "Display name"
},
"email": {
"type": "string",
"description": "Email address"
},
"phone": {
"type": "string",
"description": "Primary phone number",
"nullable": true
},
"phone_2": {
"type": "string",
"description": "Secondary phone number",
"nullable": true
},
"first_name": {
"type": "string",
"description": "First name",
"nullable": true
},
"last_name": {
"type": "string",
"description": "Last name",
"nullable": true
},
"preferred_name": {
"type": "string",
"description": "Preferred name",
"nullable": true
},
"full_name": {
"type": "string",
"description": "Full name",
"nullable": true
},
"full_name_with_team": {
"type": "string",
"description": "Full name with team context",
"nullable": true
},
"slack_id": {
"type": "string",
"description": "Slack user ID",
"nullable": true
},
"time_zone": {
"type": "string",
"description": "IANA time zone",
"nullable": true
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"id",
"email",
"created_at",
"updated_at"
]
},
"role_relationship": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"roles"
]
}
},
"nullable": true
}
}
},
"on_call_role_relationship": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"on_call_roles"
]
}
},
"nullable": true
}
}
},
"user_relationships": {
"type": "object",
"properties": {
"role": {
"$ref": "#/components/schemas/role_relationship"
},
"on_call_role": {
"$ref": "#/components/schemas/on_call_role_relationship"
}
}
},
"update_user": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"users"
]
},
"attributes": {
"type": "object",
"properties": {
"first_name": {
"type": "string",
"description": "First name of the user",
"nullable": true
},
"last_name": {
"type": "string",
"description": "Last name of the user",
"nullable": true
},
"role_id": {
"type": "string",
"description": "ID of the role to assign",
"nullable": true
},
"on_call_role_id": {
"type": "string",
"description": "ID of the on-call role to assign",
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"user_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the user"
},
"type": {
"type": "string",
"enum": [
"users"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/user"
}
]
},
"relationships": {
"$ref": "#/components/schemas/user_relationships"
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"user_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the user"
},
"type": {
"type": "string",
"enum": [
"users"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/user"
}
]
},
"relationships": {
"$ref": "#/components/schemas/user_relationships"
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"webhooks_delivery": {
"type": "object",
"properties": {
"endpoint_id": {
"type": "string"
},
"payload": {
"type": "string"
},
"delivered_at": {
"type": "string",
"nullable": true
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"endpoint_id",
"payload",
"delivered_at",
"created_at",
"updated_at"
]
},
"webhooks_delivery_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the webhooks_delivery"
},
"type": {
"type": "string",
"enum": [
"webhooks_deliveries"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/webhooks_delivery"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"webhooks_delivery_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the webhooks_delivery"
},
"type": {
"type": "string",
"enum": [
"webhooks_deliveries"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/webhooks_delivery"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"new_webhooks_endpoint": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"webhooks_endpoints"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the endpoint"
},
"url": {
"type": "string",
"description": "The URL of the endpoint."
},
"secret": {
"type": "string",
"description": "The webhook signing secret used to verify webhook requests."
},
"event_types": {
"type": "array",
"items": {
"type": "string",
"enum": [
"incident.created",
"incident.updated",
"incident.in_triage",
"incident.mitigated",
"incident.resolved",
"incident.cancelled",
"incident.deleted",
"incident.scheduled.created",
"incident.scheduled.updated",
"incident.scheduled.in_progress",
"incident.scheduled.completed",
"incident.scheduled.deleted",
"incident_post_mortem.created",
"incident_post_mortem.updated",
"incident_post_mortem.published",
"incident_post_mortem.deleted",
"incident_status_page_event.created",
"incident_status_page_event.updated",
"incident_status_page_event.deleted",
"incident_event.created",
"incident_event.updated",
"incident_event.deleted",
"alert.created",
"pulse.created",
"shift.started",
"genius_workflow_run.queued",
"genius_workflow_run.started",
"genius_workflow_run.completed",
"genius_workflow_run.failed",
"genius_workflow_run.canceled",
"audit_log.created"
]
}
},
"enabled": {
"type": "boolean"
},
"custom_headers": {
"type": "array",
"maxItems": 10,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 256
},
"value": {
"type": "string",
"maxLength": 8192
}
},
"required": [
"name",
"value"
],
"additionalProperties": false
},
"description": "Custom HTTP headers sent with each delivery. Max 10. Reserved names (Content-Type, X-Rootly-Signature, Host, etc.) are rejected."
}
},
"additionalProperties": false,
"required": [
"name",
"url"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_webhooks_endpoint": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"webhooks_endpoints"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the endpoint"
},
"event_types": {
"type": "array",
"items": {
"type": "string",
"enum": [
"incident.created",
"incident.updated",
"incident.in_triage",
"incident.mitigated",
"incident.resolved",
"incident.cancelled",
"incident.deleted",
"incident.scheduled.created",
"incident.scheduled.updated",
"incident.scheduled.in_progress",
"incident.scheduled.completed",
"incident.scheduled.deleted",
"incident_post_mortem.created",
"incident_post_mortem.updated",
"incident_post_mortem.published",
"incident_post_mortem.deleted",
"incident_status_page_event.created",
"incident_status_page_event.updated",
"incident_status_page_event.deleted",
"incident_event.created",
"incident_event.updated",
"incident_event.deleted",
"alert.created",
"pulse.created",
"shift.started",
"genius_workflow_run.queued",
"genius_workflow_run.started",
"genius_workflow_run.completed",
"genius_workflow_run.failed",
"genius_workflow_run.canceled",
"audit_log.created"
]
}
},
"enabled": {
"type": "boolean"
},
"custom_headers": {
"type": "array",
"maxItems": 10,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 256
},
"value": {
"type": "string",
"maxLength": 8192
}
},
"required": [
"name",
"value"
],
"additionalProperties": false
},
"description": "Custom HTTP headers sent with each delivery. Max 10. Reserved names (Content-Type, X-Rootly-Signature, Host, etc.) are rejected."
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"webhooks_endpoint": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the endpoint"
},
"slug": {
"type": "string",
"description": "The slug of the endpoint"
},
"url": {
"type": "string",
"description": "The URL of the endpoint."
},
"event_types": {
"type": "array",
"items": {
"type": "string",
"enum": [
"incident.created",
"incident.updated",
"incident.in_triage",
"incident.mitigated",
"incident.resolved",
"incident.cancelled",
"incident.deleted",
"incident.scheduled.created",
"incident.scheduled.updated",
"incident.scheduled.in_progress",
"incident.scheduled.completed",
"incident.scheduled.deleted",
"incident_post_mortem.created",
"incident_post_mortem.updated",
"incident_post_mortem.published",
"incident_post_mortem.deleted",
"incident_status_page_event.created",
"incident_status_page_event.updated",
"incident_status_page_event.deleted",
"incident_event.created",
"incident_event.updated",
"incident_event.deleted",
"alert.created",
"pulse.created",
"shift.started",
"genius_workflow_run.queued",
"genius_workflow_run.started",
"genius_workflow_run.completed",
"genius_workflow_run.failed",
"genius_workflow_run.canceled",
"audit_log.created"
]
}
},
"secret": {
"type": "string",
"description": "The webhook signing secret used to verify webhook requests."
},
"enabled": {
"type": "boolean"
},
"custom_headers": {
"type": "array",
"maxItems": 10,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 256
},
"value": {
"type": "string",
"maxLength": 8192
}
},
"required": [
"name",
"value"
],
"additionalProperties": false
},
"description": "Custom HTTP headers sent with each delivery. Max 10. Reserved names (Content-Type, X-Rootly-Signature, Host, etc.) are rejected."
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"name",
"url",
"event_types",
"secret",
"enabled",
"created_at",
"updated_at"
]
},
"webhooks_endpoint_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the webhooks_endpoint"
},
"type": {
"type": "string",
"enum": [
"webhooks_endpoints"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/webhooks_endpoint"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"webhooks_endpoint_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the webhooks_endpoint"
},
"type": {
"type": "string",
"enum": [
"webhooks_endpoints"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/webhooks_endpoint"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"status": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"color": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"name",
"color",
"enabled",
"created_at",
"updated_at"
]
},
"status_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the status"
},
"type": {
"type": "string",
"enum": [
"statuses"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/status"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"status_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the status"
},
"type": {
"type": "string",
"enum": [
"statuses"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/status"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_sub_status": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"sub_statuses"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"parent_status": {
"type": "string",
"enum": [
"started",
"retrospective"
]
},
"position": {
"type": "integer",
"nullable": true
}
},
"additionalProperties": false,
"required": [
"name",
"parent_status"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_sub_status": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"sub_statuses"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"position": {
"type": "integer",
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"sub_status": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"parent_status": {
"type": "string",
"enum": [
"in_triage",
"started",
"resolved",
"closed",
"cancelled",
"planning",
"scheduled",
"in_progress",
"verifying",
"completed"
]
},
"position": {
"type": "integer",
"nullable": true
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"name",
"parent_status",
"created_at",
"updated_at"
]
},
"sub_status_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the sub_status"
},
"type": {
"type": "string",
"enum": [
"sub_statuses"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/sub_status"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"sub_status_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the sub_status"
},
"type": {
"type": "string",
"enum": [
"sub_statuses"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/sub_status"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_incident_sub_status": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_sub_statuses"
]
},
"attributes": {
"type": "object",
"properties": {
"sub_status_id": {
"type": "string",
"description": "Note: To change an incident's sub-status, use the PATCH /incidents/:id endpoint and set the sub_status_id attribute. This endpoint is for modifying the timestamp of when an incident's sub-status was assigned."
},
"assigned_at": {
"type": "string"
},
"assigned_by_user_id": {
"type": "integer",
"nullable": true
}
},
"additionalProperties": false,
"required": [
"sub_status_id",
"assigned_at"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_incident_sub_status": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"incident_sub_statuses"
]
},
"attributes": {
"type": "object",
"properties": {
"sub_status_id": {
"type": "string",
"description": "Note: To change an incident's sub-status, use the PATCH /incidents/:id endpoint and set the sub_status_id attribute. This endpoint is for modifying the timestamp of when an incident's sub-status was assigned."
},
"assigned_at": {
"type": "string"
},
"assigned_by_user_id": {
"type": "integer",
"nullable": true
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"incident_sub_status": {
"type": "object",
"properties": {
"incident_id": {
"type": "string"
},
"sub_status_id": {
"type": "string",
"description": "Note: To change an incident's sub-status, use the PATCH /incidents/:id endpoint and set the sub_status_id attribute. This endpoint is for modifying the timestamp of when an incident's sub-status was assigned."
},
"assigned_at": {
"type": "string"
},
"assigned_by_user_id": {
"type": "integer",
"nullable": true
}
},
"required": [
"incident_id",
"sub_status_id",
"assigned_at"
]
},
"incident_sub_status_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident_sub_status"
},
"type": {
"type": "string",
"enum": [
"incident_sub_statuses"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_sub_status"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"incident_sub_status_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the incident_sub_status"
},
"type": {
"type": "string",
"enum": [
"incident_sub_statuses"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/incident_sub_status"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_retrospective_process_group": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"retrospective_process_groups"
]
},
"attributes": {
"type": "object",
"properties": {
"sub_status_id": {
"type": "string"
},
"position": {
"type": "integer"
}
},
"additionalProperties": false,
"required": [
"sub_status_id"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_retrospective_process_group": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"retrospective_process_groups"
]
},
"attributes": {
"type": "object",
"properties": {
"sub_status_id": {
"type": "string"
},
"position": {
"type": "integer"
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"retrospective_process_group": {
"type": "object",
"properties": {
"retrospective_process_id": {
"type": "string"
},
"sub_status_id": {
"type": "string"
},
"position": {
"type": "integer"
}
},
"required": [
"retrospective_process_id",
"sub_status_id",
"position"
]
},
"retrospective_process_group_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the retrospective_process_group"
},
"type": {
"type": "string",
"enum": [
"retrospective_process_groups"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/retrospective_process_group"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"retrospective_process_group_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the retrospective_process_group"
},
"type": {
"type": "string",
"enum": [
"retrospective_process_groups"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/retrospective_process_group"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_retrospective_process_group_step": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"retrospective_process_group_steps"
]
},
"attributes": {
"type": "object",
"properties": {
"retrospective_step_id": {
"type": "string"
},
"position": {
"type": "integer"
}
},
"additionalProperties": false,
"required": [
"retrospective_step_id"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_retrospective_process_group_step": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"retrospective_process_group_steps"
]
},
"attributes": {
"type": "object",
"properties": {
"position": {
"type": "integer"
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"retrospective_process_group_step": {
"type": "object",
"properties": {
"retrospective_process_group_id": {
"type": "string"
},
"retrospective_step_id": {
"type": "string"
},
"position": {
"type": "integer"
}
},
"required": [
"retrospective_process_group_id",
"retrospective_step_id",
"position"
]
},
"retrospective_process_group_step_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the retrospective_process_group_step"
},
"type": {
"type": "string",
"enum": [
"retrospective_process_group_steps"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/retrospective_process_group_step"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"retrospective_process_group_step_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the retrospective_process_group_step"
},
"type": {
"type": "string",
"enum": [
"retrospective_process_group_steps"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/retrospective_process_group_step"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"new_sla": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"slas"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the SLA"
},
"description": {
"type": "string",
"description": "A description of the SLA",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the SLA for ordering",
"nullable": true
},
"condition_match_type": {
"type": "string",
"description": "Whether all or any conditions must match",
"enum": [
"ALL",
"ANY"
]
},
"manager_role_id": {
"type": "string",
"format": "uuid",
"description": "The ID of the incident role responsible for this SLA. Must provide either manager_role_id or manager_user_id.",
"nullable": true
},
"manager_user_id": {
"type": "integer",
"description": "The ID of the user responsible for this SLA. Must provide either manager_role_id or manager_user_id.",
"nullable": true
},
"assignment_deadline_days": {
"type": "integer",
"description": "Number of days for the assignment deadline",
"enum": [
1,
2,
3,
4,
5,
6,
7,
14,
21,
30
]
},
"assignment_deadline_parent_status": {
"type": "string",
"description": "The incident parent status that triggers the assignment deadline",
"enum": [
"in_triage",
"started",
"mitigated",
"resolved",
"closed",
"cancelled"
]
},
"assignment_deadline_sub_status_id": {
"type": "string",
"format": "uuid",
"description": "Sub-status for the assignment deadline. Required when custom lifecycle statuses are enabled on the team.",
"nullable": true
},
"assignment_skip_weekends": {
"type": "boolean",
"description": "Whether to skip weekends when calculating the assignment deadline"
},
"completion_deadline_days": {
"type": "integer",
"description": "Number of days for the completion deadline",
"enum": [
1,
2,
3,
4,
5,
6,
7,
14,
21,
30
]
},
"completion_deadline_parent_status": {
"type": "string",
"description": "The incident parent status that triggers the completion deadline",
"enum": [
"in_triage",
"started",
"mitigated",
"resolved",
"closed",
"cancelled"
]
},
"completion_deadline_sub_status_id": {
"type": "string",
"format": "uuid",
"description": "Sub-status for the completion deadline. Required when custom lifecycle statuses are enabled on the team.",
"nullable": true
},
"completion_skip_weekends": {
"type": "boolean",
"description": "Whether to skip weekends when calculating the completion deadline"
},
"conditions": {
"type": "array",
"description": "Conditions that determine which incidents this SLA applies to. Maximum 20.",
"items": {
"type": "object",
"properties": {
"conditionable_type": {
"type": "string",
"description": "The type of condition",
"enum": [
"SLAs::BuiltInFieldCondition",
"SLAs::CustomFieldCondition"
]
},
"property": {
"type": "string",
"description": "The property to evaluate (for built-in field conditions). When the team has custom lifecycle statuses enabled, use 'sub_status' (with sub-status IDs as values); otherwise use 'status' (with parent status names). Sending the wrong one will return a validation error.",
"enum": [
"severity",
"environment",
"service",
"functionality",
"incident_type",
"group",
"cause",
"sub_status",
"incident_role",
"status",
"kind",
"visibility",
"summary",
"started_at",
"detected_at",
"acknowledged_at",
"mitigated_at",
"resolved_at"
],
"nullable": true
},
"operator": {
"type": "string",
"description": "The comparison operator"
},
"values": {
"type": "array",
"items": {
"type": "string"
},
"description": "The values to compare against",
"nullable": true
},
"form_field_id": {
"type": "string",
"format": "uuid",
"description": "The ID of the form field (for custom field conditions)",
"nullable": true
},
"position": {
"type": "integer",
"description": "The position of the condition for ordering"
}
},
"required": [
"conditionable_type",
"operator"
]
}
},
"notification_configurations": {
"type": "array",
"description": "Notification timing configurations. Maximum 20.",
"items": {
"type": "object",
"properties": {
"offset_type": {
"type": "string",
"description": "When to send the notification relative to the deadline",
"enum": [
"before_due",
"when_due",
"after_due"
]
},
"offset_days": {
"type": "integer",
"description": "Number of days before or after the deadline. Must be 0 for when_due."
}
},
"required": [
"offset_type",
"offset_days"
]
}
}
},
"additionalProperties": false,
"required": [
"name",
"assignment_deadline_days",
"assignment_deadline_parent_status",
"completion_deadline_days",
"completion_deadline_parent_status"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"update_sla": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"slas"
]
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the SLA"
},
"description": {
"type": "string",
"description": "A description of the SLA",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the SLA for ordering",
"nullable": true
},
"condition_match_type": {
"type": "string",
"description": "Whether all or any conditions must match",
"enum": [
"ALL",
"ANY"
]
},
"manager_role_id": {
"type": "string",
"format": "uuid",
"description": "The ID of the incident role responsible for this SLA. Exactly one of `manager_role_id` or `manager_user_id` must be provided.",
"nullable": true
},
"manager_user_id": {
"type": "integer",
"description": "The ID of the user responsible for this SLA. Exactly one of `manager_role_id` or `manager_user_id` must be provided.",
"nullable": true
},
"assignment_deadline_days": {
"type": "integer",
"description": "Number of days for the assignment deadline",
"enum": [
1,
2,
3,
4,
5,
6,
7,
14,
21,
30
]
},
"assignment_deadline_parent_status": {
"type": "string",
"description": "The incident parent status that triggers the assignment deadline",
"enum": [
"in_triage",
"started",
"mitigated",
"resolved",
"closed",
"cancelled"
]
},
"assignment_deadline_sub_status_id": {
"type": "string",
"format": "uuid",
"description": "Sub-status for the assignment deadline. Required when custom lifecycle statuses are enabled on the team.",
"nullable": true
},
"assignment_skip_weekends": {
"type": "boolean",
"description": "Whether to skip weekends when calculating the assignment deadline"
},
"completion_deadline_days": {
"type": "integer",
"description": "Number of days for the completion deadline",
"enum": [
1,
2,
3,
4,
5,
6,
7,
14,
21,
30
]
},
"completion_deadline_parent_status": {
"type": "string",
"description": "The incident parent status that triggers the completion deadline",
"enum": [
"in_triage",
"started",
"mitigated",
"resolved",
"closed",
"cancelled"
]
},
"completion_deadline_sub_status_id": {
"type": "string",
"format": "uuid",
"description": "Sub-status for the completion deadline. Required when custom lifecycle statuses are enabled on the team.",
"nullable": true
},
"completion_skip_weekends": {
"type": "boolean",
"description": "Whether to skip weekends when calculating the completion deadline"
},
"conditions": {
"type": "array",
"description": "Conditions that determine which incidents this SLA applies to. Replaces all existing conditions.",
"items": {
"type": "object",
"properties": {
"conditionable_type": {
"type": "string",
"description": "The type of condition",
"enum": [
"SLAs::BuiltInFieldCondition",
"SLAs::CustomFieldCondition"
]
},
"property": {
"type": "string",
"description": "The property to evaluate (for built-in field conditions). When the team has custom lifecycle statuses enabled, use 'sub_status' (with sub-status IDs as values); otherwise use 'status' (with parent status names). Sending the wrong one will return a validation error.",
"enum": [
"severity",
"environment",
"service",
"functionality",
"incident_type",
"group",
"cause",
"sub_status",
"incident_role",
"status",
"kind",
"visibility",
"summary",
"started_at",
"detected_at",
"acknowledged_at",
"mitigated_at",
"resolved_at"
],
"nullable": true
},
"operator": {
"type": "string",
"description": "The comparison operator"
},
"values": {
"type": "array",
"items": {
"type": "string"
},
"description": "The values to compare against",
"nullable": true
},
"form_field_id": {
"type": "string",
"format": "uuid",
"description": "The ID of the form field (for custom field conditions)",
"nullable": true
},
"position": {
"type": "integer",
"description": "The position of the condition for ordering"
}
},
"required": [
"conditionable_type",
"operator"
]
}
},
"notification_configurations": {
"type": "array",
"description": "Notification timing configurations. Replaces all existing configurations.",
"items": {
"type": "object",
"properties": {
"offset_type": {
"type": "string",
"description": "When to send the notification relative to the deadline",
"enum": [
"before_due",
"when_due",
"after_due"
]
},
"offset_days": {
"type": "integer",
"description": "Number of days before or after the deadline. Must be 0 for when_due."
}
},
"required": [
"offset_type",
"offset_days"
]
}
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
},
"sla": {
"type": "object",
"properties": {
"slug": {
"type": "string",
"description": "The slug of the SLA"
},
"name": {
"type": "string",
"description": "The name of the SLA"
},
"description": {
"type": "string",
"description": "A description of the SLA",
"nullable": true
},
"position": {
"type": "integer",
"description": "Position of the SLA for ordering"
},
"entity_type": {
"type": "string",
"description": "The entity type this SLA applies to",
"enum": [
"follow_up"
]
},
"condition_match_type": {
"type": "string",
"description": "Whether all or any conditions must match",
"enum": [
"ALL",
"ANY"
]
},
"manager_role_id": {
"type": "string",
"format": "uuid",
"description": "The ID of the manager incident role. Exactly one of `manager_role_id` or `manager_user_id` must be provided.",
"nullable": true
},
"manager_user_id": {
"type": "integer",
"description": "The ID of the manager user. Exactly one of `manager_role_id` or `manager_user_id` must be provided.",
"nullable": true
},
"assignment_deadline_days": {
"type": "integer",
"description": "Number of days for the assignment deadline"
},
"assignment_deadline_parent_status": {
"type": "string",
"description": "The incident parent status that triggers the assignment deadline"
},
"assignment_deadline_sub_status_id": {
"type": "string",
"format": "uuid",
"description": "Sub-status for the assignment deadline. Required when custom lifecycle statuses are enabled on the team.",
"nullable": true
},
"assignment_skip_weekends": {
"type": "boolean",
"description": "Whether to skip weekends when calculating the assignment deadline"
},
"completion_deadline_days": {
"type": "integer",
"description": "Number of days for the completion deadline"
},
"completion_deadline_parent_status": {
"type": "string",
"description": "The incident parent status that triggers the completion deadline"
},
"completion_deadline_sub_status_id": {
"type": "string",
"format": "uuid",
"description": "Sub-status for the completion deadline. Required when custom lifecycle statuses are enabled on the team.",
"nullable": true
},
"completion_skip_weekends": {
"type": "boolean",
"description": "Whether to skip weekends when calculating the completion deadline"
},
"conditions": {
"type": "array",
"description": "Conditions that determine which incidents this SLA applies to",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique ID of the condition"
},
"position": {
"type": "integer",
"description": "The position of the condition"
},
"conditionable_type": {
"type": "string",
"description": "The type of condition",
"enum": [
"SLAs::BuiltInFieldCondition",
"SLAs::CustomFieldCondition"
]
},
"property": {
"type": "string",
"description": "The property to evaluate (for built-in field conditions)",
"nullable": true
},
"operator": {
"type": "string",
"description": "The comparison operator"
},
"values": {
"type": "array",
"items": {
"type": "string"
},
"description": "The values to compare against",
"nullable": true
},
"form_field_id": {
"type": "string",
"format": "uuid",
"description": "The ID of the form field (for custom field conditions)",
"nullable": true
}
}
}
},
"notification_configurations": {
"type": "array",
"description": "Notification timing configurations",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique ID of the notification configuration"
},
"offset_type": {
"type": "string",
"description": "When to send the notification relative to the deadline",
"enum": [
"before_due",
"when_due",
"after_due"
]
},
"offset_days": {
"type": "integer",
"description": "Number of days offset from the deadline"
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
}
}
},
"created_at": {
"type": "string",
"description": "Date of creation"
},
"updated_at": {
"type": "string",
"description": "Date of last update"
}
},
"required": [
"name",
"condition_match_type",
"assignment_deadline_days",
"assignment_deadline_parent_status",
"completion_deadline_days",
"completion_deadline_parent_status",
"created_at",
"updated_at"
]
},
"sla_response": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the SLA"
},
"type": {
"type": "string",
"enum": [
"slas"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/sla"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data"
]
},
"sla_list": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the SLA"
},
"type": {
"type": "string",
"enum": [
"slas"
]
},
"attributes": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/sla"
}
]
}
},
"required": [
"id",
"type",
"attributes"
]
}
},
"links": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/links"
}
]
},
"meta": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/meta"
}
]
},
"included": {
"type": "array",
"items": {
"$ref": "#/components/schemas/jsonapi_included_resource"
}
}
},
"required": [
"data",
"links",
"meta"
]
},
"jsonapi_included_resource": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": true
},
"relationships": {
"type": "object",
"additionalProperties": true
}
},
"required": [
"id",
"type"
]
}
}
}
}