{
"openapi": "3.0.1",
"info": {
"title": "Rootly API v1",
"version": "v1",
"license": {
"name": "Rootly",
"url": "https://rootly.com"
},
"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/sre/instructions": {
"get": {
"summary": "Lists team-wide AI instruction slots",
"x-beta": true,
"tags": [
"AIInstructions"
],
"operationId": "listAIInstructions",
"description": "**Beta:** This endpoint is in beta. Requires an API key. Team API keys are not supported.",
"security": [
{
"bearer_auth": []
}
],
"responses": {
"200": {
"description": "SRE disabled hides its slot",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ai_instruction_list"
}
}
}
},
"403": {
"description": "instructions disabled"
},
"404": {
"description": "team keys rejected"
}
}
}
},
"/v1/ai/sre/instructions/{surface}": {
"parameters": [
{
"name": "surface",
"in": "path",
"required": true,
"schema": {
"type": "string",
"enum": [
"global",
"sre"
]
}
}
],
"get": {
"summary": "Shows a team-wide AI instruction slot",
"x-beta": true,
"tags": [
"AIInstructions"
],
"operationId": "getAIInstruction",
"description": "**Beta:** This endpoint is in beta. Requires an API key. Team API keys are not supported.",
"security": [
{
"bearer_auth": []
}
],
"responses": {
"200": {
"description": "slot shown",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ai_instruction"
}
}
}
},
"404": {
"description": "unconfigured slot"
}
}
},
"put": {
"summary": "Writes a team-wide AI instruction slot",
"x-beta": true,
"tags": [
"AIInstructions"
],
"operationId": "updateAIInstruction",
"description": "**Beta:** This endpoint is in beta. Requires an API key. Upserts the surface slot; a blank body clears it. Team API keys are not supported.",
"security": [
{
"bearer_auth": []
}
],
"parameters": [],
"responses": {
"200": {
"description": "on-call admin can write sre",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ai_instruction"
}
}
}
},
"204": {
"description": "blank body clears the slot"
},
"400": {
"description": "unsupported relationships"
},
"403": {
"description": "SRE disabled"
},
"422": {
"description": "body too long"
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ai_instruction_update"
}
}
}
}
},
"patch": {
"summary": "Partially writes a team-wide AI instruction slot",
"x-beta": true,
"tags": [
"AIInstructions"
],
"operationId": "patchAIInstruction",
"description": "**Beta:** This endpoint is in beta. Requires an API key. Upserts the surface slot; a blank body clears it. Team API keys are not supported.",
"security": [
{
"bearer_auth": []
}
],
"parameters": [],
"responses": {
"200": {
"description": "slot partially updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ai_instruction"
}
}
}
},
"204": {
"description": "slot cleared"
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ai_instruction_update"
}
}
}
}
},
"delete": {
"summary": "Clears a team-wide AI instruction slot",
"x-beta": true,
"tags": [
"AIInstructions"
],
"operationId": "deleteAIInstruction",
"description": "**Beta:** This endpoint is in beta. Requires an API key. Team API keys are not supported.",
"security": [
{
"bearer_auth": []
}
],
"responses": {
"204": {
"description": "slot cleared"
},
"403": {
"description": "on-call admin cannot delete global"
}
}
}
},
"/v1/ai/sre/investigation_rules": {
"get": {
"summary": "Lists investigation rules",
"x-beta": true,
"tags": [
"InvestigationRules"
],
"operationId": "listInvestigationRules",
"description": "**Beta:** This endpoint is in beta.\n\nRequires an API key. Team API keys are not supported.",
"security": [
{
"bearer_auth": []
}
],
"parameters": [
{
"name": "filter[name]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[status]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[resource_type]",
"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": "paginated rules",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/investigation_rule_list"
}
}
}
},
"403": {
"description": "AI SRE disabled"
},
"404": {
"description": "team-kind keys are unsupported"
}
}
},
"post": {
"summary": "Creates an investigation rule",
"x-beta": true,
"tags": [
"InvestigationRules"
],
"operationId": "createInvestigationRule",
"description": "**Beta:** This endpoint is in beta.\n\nRequires an API key. Team API keys are not supported.",
"security": [
{
"bearer_auth": []
}
],
"parameters": [],
"responses": {
"201": {
"description": "alert condition round trip v7",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/investigation_rule"
}
}
}
},
"422": {
"description": "incomplete condition"
},
"400": {
"description": "data id is unsupported on create"
},
"403": {
"description": "non-admin cannot write"
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/investigation_rule_create"
}
}
}
}
}
},
"/v1/ai/sre/investigation_rules/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
}
],
"get": {
"summary": "Shows an investigation rule",
"x-beta": true,
"tags": [
"InvestigationRules"
],
"operationId": "getInvestigationRule",
"description": "**Beta:** This endpoint is in beta.\n\nRequires an API key. Team API keys are not supported.",
"security": [
{
"bearer_auth": []
}
],
"responses": {
"200": {
"description": "non-admin can read",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/investigation_rule"
}
}
}
},
"404": {
"description": "other team's rule"
}
}
},
"put": {
"summary": "Updates an investigation rule",
"x-beta": true,
"tags": [
"InvestigationRules"
],
"operationId": "updateInvestigationRule",
"description": "**Beta:** This endpoint is in beta.\n\nRequires an API key. Team API keys are not supported. Omitting conditions preserves them unless resource_type changes, in which case conditions are required. [] clears them.",
"security": [
{
"bearer_auth": []
}
],
"parameters": [],
"responses": {
"200": {
"description": "conditions explicitly cleared",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/investigation_rule"
}
}
}
},
"422": {
"description": "unsupported alert condition field"
},
"400": {
"description": "unsupported relationships"
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/investigation_rule_update"
}
}
}
}
},
"patch": {
"summary": "Partially updates an investigation rule",
"x-beta": true,
"tags": [
"InvestigationRules"
],
"operationId": "patchInvestigationRule",
"description": "**Beta:** This endpoint is in beta. Requires an API key. Team API keys are not supported. Omitting conditions preserves them unless resource_type changes, in which case conditions are required. [] clears them.",
"security": [
{
"bearer_auth": []
}
],
"parameters": [],
"responses": {
"200": {
"description": "rule partially updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/investigation_rule"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/investigation_rule_update"
}
}
}
}
},
"delete": {
"summary": "Deletes an investigation rule",
"x-beta": true,
"tags": [
"InvestigationRules"
],
"operationId": "deleteInvestigationRule",
"description": "**Beta:** This endpoint is in beta.\n\nRequires an API key. Team API keys are not supported.",
"security": [
{
"bearer_auth": []
}
],
"responses": {
"200": {
"description": "rule deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/investigation_rule"
}
}
}
}
}
}
},
"/v1/ai/automations/{ai_automation_id}/runs": {
"parameters": [
{
"name": "ai_automation_id",
"in": "path",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
}
],
"get": {
"summary": "Lists AI automation runs",
"description": "Scans the 1000 most recent runs matching the filters; pagination and counts cover the visible runs in that window. When meta.next_scan_cursor is set, older runs exist beyond the window. Present only on the last page of the current scan window; finish page pagination before following it. Repeat the request with filter[scan_cursor] set to that opaque cursor to continue. Incident-linked runs are visible only when the caller's role permits access. OAuth tokens also need the `ir.incidents:read` scope; API keys use the key's role. Requires OAuth scope `ai.automations:write`.",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AIAutomations"
],
"operationId": "ListAIAutomationRuns",
"parameters": [
{
"name": "filter[status]",
"in": "query",
"description": "Comma-separated statuses; any matching status is included.",
"schema": {
"type": "string"
}
},
{
"name": "filter[trigger_kind]",
"in": "query",
"description": "Comma-separated trigger kinds; any matching kind is included.",
"schema": {
"type": "string"
}
},
{
"name": "filter[scan_cursor]",
"in": "query",
"description": "Opaque encrypted cursor from meta.next_scan_cursor.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
}
],
"responses": {
"200": {
"description": "created_at filters reach runs outside the default scan window",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ai_automation_run_list"
}
}
}
},
"422": {
"description": "scan cursors cannot be reused on another automation",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"404": {
"description": "malformed parent automation IDs are not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"post": {
"summary": "Runs an AI automation now",
"description": "Requires OAuth scope `ai.automations:write`. For run-now requests with incident_id, or run_id of an incident-linked run, OAuth tokens also need the `ir.incidents:read` scope; API keys use the key's role. Limited to 30 requests per credential per minute (fixed one-minute windows), separate from the default mutation rate limit; exceeding it returns 429 with Retry-After.",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AIAutomations"
],
"operationId": "RunAIAutomation",
"parameters": [],
"responses": {
"202": {
"description": "a full run-now window resets at the next minute boundary",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ai_automation_run"
}
}
}
},
"422": {
"description": "AI-only OAuth scope cannot run an automation for an incident",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"404": {
"description": "re-running an incident run the caller cannot read is not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"429": {
"description": "run-now is limited to 30 requests per credential per minute",
"content": {
"application/vnd.api+json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string"
}
}
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_ai_automation_run"
}
}
},
"required": true
}
}
},
"/v1/ai/automation_runs/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
}
],
"get": {
"summary": "Gets an AI automation run",
"description": "Incident-linked runs are visible only when the caller's role permits access. OAuth tokens also need the `ir.incidents:read` scope; API keys use the key's role. Requires OAuth scope `ai.automations:write`.",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AIAutomations"
],
"operationId": "GetAIAutomationRun",
"responses": {
"200": {
"description": "incident read scope makes incident-linked runs visible",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ai_automation_run"
}
}
}
},
"404": {
"description": "runs from revoked sessions are hidden",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/ai/automations/slack_channels": {
"get": {
"summary": "Lists synced Slack channels for AI Automations",
"description": "Channels Rootly has synced from the team's connected Slack workspace; any returned slack_channel_id is accepted as destination_slack_channel_id. When filter[search] is set, exact channel-name matches come first. When Slack channel user filtering is enabled, personal keys and OAuth tokens only see, and can only set new, channels the user can access in Slack; an update may resend the automation's current channel unchanged.",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AIAutomations"
],
"operationId": "ListAIAutomationSlackChannels",
"parameters": [
{
"name": "filter[search]",
"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": "OAuth Automations read scope permits access",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ai_automation_slack_channels"
}
}
}
},
"404": {
"description": "OAuth Skills read scope does not permit access",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/ai/automations/slack_users": {
"get": {
"summary": "Lists Slack users for AI Automations",
"description": "Users, including bots, from the team's connected Slack workspace; any returned slack_user_id is accepted by user and item_user trigger conditions.",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AIAutomations"
],
"operationId": "ListAIAutomationSlackUsers",
"parameters": [
{
"name": "filter[search]",
"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": "enterprise installs without a selected workspace return no users",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ai_automation_slack_users"
}
}
}
},
"404": {
"description": "group API keys are not authorized",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/ai/automations/slack_user_groups": {
"get": {
"summary": "Lists Slack user groups for AI Automations",
"description": "User groups from the team's connected Slack workspace, read live from Slack; any returned slack_user_group_id is accepted by usergroup trigger conditions.",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AIAutomations"
],
"operationId": "ListAIAutomationSlackUserGroups",
"parameters": [
{
"name": "filter[search]",
"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": "Slack API failures return no user groups",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ai_automation_slack_user_groups"
}
}
}
},
"404": {
"description": "group API keys are not authorized",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/ai/automations/trigger_options": {
"get": {
"summary": "Lists options for configuring AI Automation triggers",
"description": "Returns the source-of-truth options used by the AI Automation editor.",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AIAutomations"
],
"operationId": "GetAIAutomationTriggerOptions",
"responses": {
"200": {
"description": "OAuth Automations read scope permits access",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ai_automation_trigger_options"
}
}
}
},
"403": {
"description": "AI Automations are disabled",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"404": {
"description": "OAuth Skills read scope does not permit access",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/ai/automations/{id}/triggers/{trigger_id}/webhook_secret": {
"parameters": [
{
"name": "id",
"in": "path",
"description": "AI Automation ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "trigger_id",
"in": "path",
"description": "Webhook trigger ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Generates or rotates an AI Automation webhook trigger secret",
"description": "Returns a new secret for a webhook trigger. The previous secret stops working immediately. The secret is only returned in this response; Rootly stores a SHA-256 digest of it.",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AIAutomations"
],
"operationId": "RotateAIAutomationWebhookSecret",
"parameters": [],
"responses": {
"201": {
"description": "secret generated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ai_automation_webhook_secret_response"
}
}
}
},
"404": {
"description": "trigger isn't a webhook trigger of this automation"
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v1/ai/automations": {
"get": {
"summary": "Lists AI automations",
"description": "Requires OAuth scope `ai.automations:read`.",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AIAutomations"
],
"operationId": "ListAIAutomations",
"parameters": [
{
"name": "filter[search]",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "filter[enabled]",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "filter[trigger_kind]",
"in": "query",
"description": "Comma-separated values; any matching trigger kind is included.",
"schema": {
"type": "string"
}
},
{
"name": "filter[event_name]",
"in": "query",
"description": "Comma-separated values; any matching event name is included.",
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "sort",
"in": "query",
"schema": {
"type": "string",
"enum": [
"name",
"-name",
"created_at",
"-created_at",
"updated_at",
"-updated_at"
]
}
}
],
"responses": {
"200": {
"description": "read OAuth scope permits listing automations",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ai_automation_list"
}
}
}
},
"422": {
"description": "unknown trigger kinds are rejected",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"403": {
"description": "AI Automations are not enabled",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"404": {
"description": "AI Skills write scope alone does not permit listing automations",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"post": {
"summary": "Creates an AI automation",
"description": "Requires OAuth scope `ai.automations:write`. Read-only attributes are ignored on write.",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AIAutomations"
],
"operationId": "CreateAIAutomation",
"parameters": [],
"responses": {
"201": {
"description": "client credentials write scope can create automations",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ai_automation"
}
}
}
},
"422": {
"description": "skills unusable by automations are rejected",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"400": {
"description": "relationships are unsupported on create",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"404": {
"description": "read OAuth scope cannot create automations",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_ai_automation"
}
}
},
"required": true
}
}
},
"/v1/ai/automations/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
}
],
"get": {
"summary": "Gets an AI automation",
"description": "Requires OAuth scope `ai.automations:read`.",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AIAutomations"
],
"operationId": "GetAIAutomation",
"responses": {
"200": {
"description": "read OAuth scope permits retrieving automations",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ai_automation"
}
}
}
}
}
},
"patch": {
"summary": "Updates an AI automation",
"description": "Requires OAuth scope `ai.automations:write`. Read-only attributes are ignored on write.",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AIAutomations"
],
"operationId": "UpdateAIAutomation",
"parameters": [],
"responses": {
"200": {
"description": "a null credit limit clears the stored limit",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ai_automation"
}
}
}
},
"422": {
"description": "conflicting schedule timezone aliases are rejected",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"400": {
"description": "empty updates are rejected",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"404": {
"description": "read OAuth scope cannot update automations",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_ai_automation"
}
}
},
"required": true
}
},
"put": {
"summary": "Updates an AI automation",
"description": "Requires OAuth scope `ai.automations:write`. Read-only attributes are ignored on write.",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AIAutomations"
],
"operationId": "PutAIAutomation",
"parameters": [],
"responses": {
"200": {
"description": "event automation read representation round-trips through PUT",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ai_automation"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_ai_automation"
}
}
},
"required": true
}
},
"delete": {
"summary": "Deletes an AI automation",
"description": "Requires OAuth scope `ai.automations:write`. Retires the automation: it is disabled and soft-deleted, no longer listed or runnable; GET show and run-now return 404, while its existing run history remains readable via the runs endpoints.",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AIAutomations"
],
"operationId": "DeleteAIAutomation",
"responses": {
"200": {
"description": "write OAuth scope permits deleting automations",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ai_automation"
}
}
}
},
"404": {
"description": "read OAuth scope cannot delete automations",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/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. For eligible unbound home chat, `checkpoint_id` and `decision` confirm or cancel approval-gated writes. Responses include `confirmation` for a pending write and `checkpoint_resolved` after resume. If an action-item write needs required fields the model did not supply, no checkpoint is created and the turn completes with a plain reply linking to that incident's action-item form in the Rootly web app. The synchronous response has no `confirmation` key; only `confirmation` responses are resumable. Limited to 60 requests per minute per credential. Rate-limit responses include `Retry-After` and `X-RateLimit-*` headers. Requires `ai.chat:write` OAuth scope or an API key.",
"operationId": "createAiChat",
"parameters": [
{
"name": "message",
"in": "query",
"schema": {
"type": "string"
},
"description": "Message to send. Required unless checkpoint_id is supplied.",
"required": false
},
{
"name": "session_id",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Resume an existing session",
"required": false
},
{
"name": "checkpoint_id",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Pending confirmation checkpoint to resolve",
"required": false
},
{
"name": "decision",
"in": "query",
"schema": {
"type": "string",
"enum": [
"confirm",
"cancel"
]
},
"description": "Resolve the checkpoint with confirm or cancel",
"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",
"headers": {
"X-RateLimit-Limit": {
"schema": {
"type": "string"
},
"description": "Request limit and window duration"
},
"X-RateLimit-Remaining": {
"schema": {
"type": "string"
},
"description": "Requests remaining in the current window"
},
"X-RateLimit-Used": {
"schema": {
"type": "string"
},
"description": "Requests used in the current window"
},
"X-RateLimit-Reset": {
"schema": {
"type": "string"
},
"description": "Unix timestamp when the current window resets"
}
},
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ai_chat_response"
}
}
}
},
"429": {
"description": "AI chat rate limit exceeded",
"headers": {
"Retry-After": {
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 60
},
"description": "Seconds until the current rate-limit window resets"
},
"X-RateLimit-Limit": {
"schema": {
"type": "string"
},
"description": "Request limit and window duration"
},
"X-RateLimit-Remaining": {
"schema": {
"type": "string"
},
"description": "Requests remaining in the current window"
},
"X-RateLimit-Used": {
"schema": {
"type": "string"
},
"description": "Requests used in the current window"
},
"X-RateLimit-Reset": {
"schema": {
"type": "string"
},
"description": "Unix timestamp when the current window resets"
}
},
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ai_chat_error_response"
}
}
}
},
"403": {
"description": "AI chat not enabled, insufficient scope, or home-chat caller is ineligible",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ai_chat_error_response"
}
}
}
},
"422": {
"description": "invalid request, missing session_id, invalid decision, or agent error",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ai_chat_error_response"
}
}
}
},
"404": {
"description": "confirm session or checkpoint not found, or unresumable message session for an eligible home-chat caller",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ai_chat_error_response"
}
}
}
},
"500": {
"description": "AI processing failed",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ai_chat_error_response"
}
}
}
}
}
}
},
"/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. For eligible unbound home chat, `checkpoint_id` and `decision` confirm or cancel approval-gated writes. Events include `confirmation_required` for pending writes and `checkpoint_resolved` before replay. If an action-item write needs required fields the model did not supply, no checkpoint is created and the turn completes with a plain reply linking to that incident's action-item form in the Rootly web app. The stream emits `done` with `status: complete` and no `confirmation_required` event; only `confirmation_required` events are resumable. `status` events carry a short progress line (`{status}`) such as the running tool's title or its progress message; they never include tool arguments or results. `skill_loaded` events carry `{skill: {id, name, slug, version}}` when an AI Skill is loaded. Limited to 60 requests per minute per credential. Rate-limit responses include `Retry-After` and `X-RateLimit-*` headers. 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 unless checkpoint_id is supplied.",
"required": false
},
{
"name": "session_id",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Resume an existing session",
"required": false
},
{
"name": "checkpoint_id",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Pending confirmation checkpoint to resolve",
"required": false
},
{
"name": "decision",
"in": "query",
"schema": {
"type": "string",
"enum": [
"confirm",
"cancel"
]
},
"description": "Resolve the checkpoint with confirm or cancel",
"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",
"headers": {
"X-RateLimit-Limit": {
"schema": {
"type": "string"
},
"description": "Request limit and window duration"
},
"X-RateLimit-Remaining": {
"schema": {
"type": "string"
},
"description": "Requests remaining in the current window"
},
"X-RateLimit-Used": {
"schema": {
"type": "string"
},
"description": "Requests used in the current window"
},
"X-RateLimit-Reset": {
"schema": {
"type": "string"
},
"description": "Unix timestamp when the current window resets"
}
}
},
"429": {
"description": "AI chat rate limit exceeded",
"headers": {
"Retry-After": {
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 60
},
"description": "Seconds until the current rate-limit window resets"
},
"X-RateLimit-Limit": {
"schema": {
"type": "string"
},
"description": "Request limit and window duration"
},
"X-RateLimit-Remaining": {
"schema": {
"type": "string"
},
"description": "Requests remaining in the current window"
},
"X-RateLimit-Used": {
"schema": {
"type": "string"
},
"description": "Requests used in the current window"
},
"X-RateLimit-Reset": {
"schema": {
"type": "string"
},
"description": "Unix timestamp when the current window resets"
}
},
"content": {
"text/event-stream": {
"schema": {
"$ref": "#/components/schemas/ai_chat_error_response"
}
}
}
},
"403": {
"description": "AI chat not enabled or home-chat caller is ineligible",
"content": {
"text/event-stream": {
"schema": {
"$ref": "#/components/schemas/ai_chat_error_response"
}
}
}
},
"404": {
"description": "confirm session or checkpoint not found, or unresumable message session for an eligible home-chat caller",
"content": {
"text/event-stream": {
"schema": {
"$ref": "#/components/schemas/ai_chat_error_response"
}
}
}
},
"422": {
"description": "session_id is missing or the confirmation decision is invalid",
"content": {
"text/event-stream": {
"schema": {
"$ref": "#/components/schemas/ai_chat_error_response"
}
}
}
}
}
}
},
"/v1/ai/chat/sessions": {
"get": {
"summary": "List AI home chat sessions",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AI Chat"
],
"description": "Returns the caller's active, unbound AI home chat sessions newest-first, cursor-paginated by `before`. `archived=false` leaves out archived sessions, `archived=true` lists only archived ones, and `pinned` splits the unarchived ones. Archived sessions are never pinned, so `archived=true&pinned=true` returns no sessions. Requires `ai.chat:read` OAuth scope or a personal API key, and the caller must be eligible for home chat.",
"operationId": "listAiChatSessions",
"parameters": [
{
"name": "before",
"in": "query",
"schema": {
"type": "string"
},
"description": "Opaque cursor from a previous page's meta.pagination.next_before",
"required": false
},
{
"name": "limit",
"in": "query",
"schema": {
"type": "integer"
},
"description": "Sessions per page (max 50, default 20)",
"required": false
},
{
"name": "pinned",
"in": "query",
"schema": {
"type": "boolean"
},
"description": "true lists only pinned sessions, false only unpinned ones (archived excluded either way)",
"required": false
},
{
"name": "archived",
"in": "query",
"schema": {
"type": "boolean"
},
"description": "true lists only archived sessions, false leaves them out (default: both)",
"required": false
}
],
"responses": {
"200": {
"description": "home chat sessions",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ai_chat_session_list"
}
}
}
},
"403": {
"description": "AI chat disabled for the team, OAuth token missing ai.chat:read, or caller not eligible for home chat (e.g. non-personal credentials)",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ai_chat_error_response"
}
}
}
},
"422": {
"description": "pinned or archived is not a boolean",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ai_chat_error_response"
}
}
}
}
}
}
},
"/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. Assistant messages may include a `skill` object with `id`, `name`, `slug`, and `version` for the AI Skill loaded during that turn. The response also carries the session's current `title`, `pinned`, `archived`, and `last_active_at` state. 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}": {
"patch": {
"summary": "Update AI chat session",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AI Chat"
],
"description": "Renames, pins or archives an AI home chat session; a blank or null title resets to the generated title. Archiving also unpins. Requires `ai.chat:write` OAuth scope or a personal API key, and the caller must be eligible for home chat.",
"operationId": "updateAiChatSession",
"parameters": [
{
"name": "id",
"in": "path",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "Session UUID",
"required": true
}
],
"responses": {
"200": {
"description": "updated session",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ai_chat_session_title"
}
}
}
},
"403": {
"description": "AI chat disabled for the team, OAuth token missing ai.chat:write, or caller not eligible for home chat (e.g. non-personal credentials)",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ai_chat_error_response"
}
}
}
},
"404": {
"description": "session not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ai_chat_error_response"
}
}
}
},
"422": {
"description": "no title, pinned or archived given, title is not a string/null, or pinned/archived is not a boolean",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ai_chat_error_response"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_ai_chat_session"
}
}
},
"required": true
}
},
"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/ai/skills/{ai_skill_id}/versions": {
"parameters": [
{
"name": "ai_skill_id",
"in": "path",
"description": "The skill ID or slug.",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Lists AI skill versions",
"description": "Requires OAuth scope `ai.skills:read`.",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AISkills"
],
"operationId": "ListAISkillVersions",
"responses": {
"200": {
"description": "AI skills read scope permits listing versions",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ai_skill_version_list"
}
}
}
},
"404": {
"description": "group API keys are not authorized",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/ai/skills/{ai_skill_id}/versions/{version}": {
"parameters": [
{
"name": "ai_skill_id",
"in": "path",
"description": "The skill ID or slug.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"get": {
"summary": "Gets an AI skill version",
"description": "Requires OAuth scope `ai.skills:read`.",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AISkills"
],
"operationId": "GetAISkillVersion",
"responses": {
"200": {
"description": "skill versions have no tool grants field",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ai_skill_version_response"
}
}
}
},
"404": {
"description": "unknown version is hidden",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/ai/skills": {
"get": {
"summary": "Lists AI skills",
"description": "Requires OAuth scope `ai.skills:read`.",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AISkills"
],
"operationId": "ListAISkills",
"parameters": [
{
"name": "filter[enabled]",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "filter[search]",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "filter[slug]",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "filter[invocable_by]",
"in": "query",
"description": "Comma-separated sources; skills matching any listed source are returned.",
"schema": {
"type": "string"
}
},
{
"name": "filter[source]",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "filter[created_at][gt]",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "filter[created_at][gte]",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "filter[created_at][lt]",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "filter[created_at][lte]",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "sort",
"in": "query",
"schema": {
"type": "string",
"enum": [
"name",
"-name",
"created_at",
"-created_at",
"updated_at",
"-updated_at"
]
}
}
],
"responses": {
"200": {
"description": "all scope permits listing AI skills",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ai_skill_list"
}
}
}
},
"422": {
"description": "unknown invocable_by sources are rejected",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"403": {
"description": "AI Skills are not enabled by the team's configuration",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"404": {
"description": "AI automations write scope does not permit listing AI skills",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"post": {
"summary": "Creates an AI skill",
"description": "Requires OAuth scope `ai.skills:write`. Read-only attributes are ignored on write.",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AISkills"
],
"operationId": "CreateAISkill",
"parameters": [],
"responses": {
"201": {
"description": "write scope permits creation",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ai_skill_response"
}
}
}
},
"400": {
"description": "relationships are unsupported on create",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"422": {
"description": "tool grants are no longer accepted on AI Skills",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"404": {
"description": "read scope does not permit creation",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/new_ai_skill"
}
}
},
"required": true
}
}
},
"/v1/ai/skills/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"description": "The skill ID or slug.",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Gets an AI skill",
"description": "Requires OAuth scope `ai.skills:read`.",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AISkills"
],
"operationId": "GetAISkill",
"responses": {
"200": {
"description": "OAuth read scope permits access",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ai_skill_response"
}
}
}
},
"404": {
"description": "skills belonging to another team are hidden",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"patch": {
"summary": "Updates an AI skill",
"description": "Requires OAuth scope `ai.skills:write`. Read-only attributes are ignored on write.",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AISkills"
],
"operationId": "UpdateAISkill",
"parameters": [],
"responses": {
"200": {
"description": "write scope permits updates",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ai_skill_response"
}
}
}
},
"422": {
"description": "owners from other organizations are rejected on update",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"400": {
"description": "relationships are unsupported on update",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_ai_skill"
}
}
},
"required": true
}
},
"put": {
"summary": "Updates an AI skill",
"description": "Requires OAuth scope `ai.skills:write`. Read-only attributes are ignored on write.",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AISkills"
],
"operationId": "PutAISkill",
"parameters": [],
"responses": {
"200": {
"description": "the full JSON:API GET representation can be put back",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ai_skill_response"
}
}
}
},
"422": {
"description": "a mismatched data id is rejected",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_ai_skill"
}
}
},
"required": true
}
},
"delete": {
"summary": "Deletes an AI skill",
"description": "Requires OAuth scope `ai.skills:write`. Soft-deletes the skill and removes its attachments while retaining its history. GitHub-managed skills are recreated on the next sync if their file remains in the repository.",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AISkills"
],
"operationId": "DeleteAISkill",
"responses": {
"200": {
"description": "skill can be deleted by slug",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ai_skill_response"
}
}
}
},
"404": {
"description": "readers cannot delete skills",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"422": {
"description": "deletion failed",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/ai/tool_call_events": {
"get": {
"summary": "Lists AI tool call events",
"description": "Returns audit events for AI tool calls and connector calls.",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AIToolCallEvents"
],
"operationId": "listAiToolCallEvents",
"parameters": [
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"description": "Number of events per page (defaults to 50, max 1000)",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[connector_id]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[outcome]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[risk_class]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[surface]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter[user_id]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[occurred_after]",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
},
"required": false,
"description": "Occurred at or after (ISO 8601)"
},
{
"name": "filter[occurred_before]",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
},
"required": false,
"description": "Occurred at or before (ISO 8601)"
}
],
"responses": {
"200": {
"description": "AI tool call events returned",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ai_tool_call_event_list"
}
}
}
},
"400": {
"description": "filter timestamps must be valid",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/v1/alert_configuration": {
"get": {
"summary": "Retrieves the team's alert configuration",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertConfiguration"
],
"operationId": "getAlertConfiguration",
"responses": {
"200": {
"description": "alert configuration found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/alert_configuration_response"
}
}
}
},
"404": {
"description": "team has no alert configuration",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Updates the team's alert configuration",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"AlertConfiguration"
],
"operationId": "updateAlertConfiguration",
"parameters": [],
"responses": {
"200": {
"description": "an explicit first-audible-level policy overrides the stored value",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/alert_configuration_response"
}
}
}
},
"403": {
"description": "an attribute's feature is not enabled for the team",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"404": {
"description": "team has no alert configuration",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"422": {
"description": "the settings are invalid",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/update_alert_configuration"
}
}
},
"required": true
}
}
},
"/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",
"slack_reply"
]
},
"required": false
},
{
"name": "filter[action]",
"in": "query",
"schema": {
"type": "string",
"enum": [
"created",
"escalation_policy_paged",
"ignored_alert_request",
"call_lifecycle",
"level_skipped",
"user_paged",
"ai_sre_requested",
"ai_sre_delegated",
"team_attached_from_payload",
"team_attached_from_source",
"team_attached_from_heartbeat",
"emailed",
"slacked",
"ms_teams_messaged",
"google_chat_messaged",
"called",
"texted",
"notified",
"skipped",
"opened",
"retriggered",
"ack_timeout_retriggered",
"answered",
"acknowledged",
"escalated",
"paged",
"resolved",
"attached",
"snoozed",
"retrigger_suppressed",
"retrigger_cancelled",
"triggered",
"open",
"updated",
"added",
"removed",
"unresolved",
"marked",
"not_marked",
"cleared",
"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"
}
}
}
},
"503": {
"description": "page took too long to load",
"headers": {
"Retry-After": {
"schema": {
"type": "integer"
},
"description": "Seconds to wait before retrying"
}
},
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_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 target 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_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"
}
}
}
},
"422": {
"description": "invalid target type",
"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_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\nAsynchronous processing is also applied automatically, whether or not it is enabled for your organization, when a request carries a rule graph too large to save within the request timeout. Size is measured in total dependent records — rules plus their condition groups, conditions and destinations — and for an update it includes the rules already on the route, not just those in the payload.\n\n**Important**: Whenever rules are processed asynchronously, the rules list in the API response will not be up-to-date immediately after creation. You should refetch the alert route, or poll the async rule creation status endpoint with the `request_id` you supplied, to confirm the rules have landed.\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"
}
}
}
},
"403": {
"description": "non-paging rules, dynamic destinations, rule-level sources, value normalization and matching on more than one property not available for the organization",
"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",
"parameters": [
{
"name": "show_nested_ids",
"in": "query",
"required": false,
"schema": {
"type": "boolean"
},
"description": "Include the IDs of nested destinations, condition groups and conditions, for referencing them in PATCH updates or deletions"
}
],
"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\nAsynchronous processing is also applied automatically, whether or not it is enabled for your organization, when a request carries a rule graph too large to save within the request timeout. Size is measured in total dependent records — rules plus their condition groups, conditions and destinations — and includes the rules already on the route, not just those in the payload, so a small payload against a large route may still be processed asynchronously.\n\n**Important**: Whenever rules are processed asynchronously, the rules list in the API response will not be up-to-date immediately after update. You should refetch the alert route, or poll the async rule creation status endpoint with the `request_id` you supplied, to confirm the rules have landed.\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"
}
}
}
},
"403": {
"description": "non-paging rules, dynamic destinations, rule-level sources, value normalization and matching on more than one property not available for the organization",
"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"
}
}
}
},
"403": {
"description": "non-paging rules, dynamic destinations, rule-level sources, value normalization and matching on more than one property not available for the organization",
"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 with enabled false",
"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": {
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"422": {
"description": "built-in alert fields cannot be unbound",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"200": {
"description": "preserves existing alert source field ids",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/alerts_source_response"
}
}
}
}
},
"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",
"parameters": [],
"responses": {
"200": {
"description": "alert acknowledged",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/alert_response"
}
}
}
},
"403": {
"description": "actor not supported for this API key",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"422": {
"description": "actor could not be resolved",
"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"
}
}
}
},
"400": {
"description": "cannot acknowledge open alert",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/acknowledge_alert"
}
}
}
}
}
},
"/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 an owner or admin role, or the on-call admin role. Optionally set `role_id` and `on_call_role_id` to control the service account's permissions. The roles must be ones the caller could assign to a member (an Admin cannot assign Owner, and only on-call admins can assign the on-call Admin role); otherwise the request returns 422.\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, including a role the caller cannot assign",
"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 `404 Not Found` when the authenticating key is not authorized to manage it, or `403 Forbidden` when it is.\n\n**Grace period:** 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`.\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",
"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[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"
}
}
}
},
"422": {
"description": "catalog_entity is used by an alert route",
"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/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"
},
"422": {
"description": "catalog_property used by a dynamic alert routing destination",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
}
},
"/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"
}
}
}
},
"422": {
"description": "catalog is used by an alert route",
"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/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. OAuth tokens need the `ir.dashboards:write` scope. Panel data only includes records the token's other scopes allow (e.g. `ir.incidents:read`, `oc.alerts:read`).",
"operationId": "createDashboardPanel",
"parameters": [],
"responses": {
"201": {
"description": "dashboard panel created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/dashboard_panel_response"
}
}
}
},
"422": {
"description": "rejects a group_by on a field that cannot be grouped",
"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_panel"
}
}
},
"required": true
}
},
"get": {
"summary": "List dashboard panels",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"DashboardPanels"
],
"description": "List dashboard panels. OAuth tokens need the `ir.dashboards:read` scope. Panel data only includes records the token's other scopes allow (e.g. `ir.incidents:read`, `oc.alerts:read`).",
"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. OAuth tokens need the `ir.dashboards:write` scope. Panel data only includes records the token's other scopes allow (e.g. `ir.incidents:read`, `oc.alerts:read`).",
"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. OAuth tokens need the `ir.dashboards:read` scope. Panel data only includes records the token's other scopes allow (e.g. `ir.incidents:read`, `oc.alerts:read`).",
"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. OAuth tokens need the `ir.dashboards:write` scope. Panel data only includes records the token's other scopes allow (e.g. `ir.incidents:read`, `oc.alerts:read`).",
"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. OAuth tokens need the `ir.dashboards:write` scope. Panel data only includes records the token's other scopes allow (e.g. `ir.incidents:read`, `oc.alerts:read`).",
"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. OAuth tokens need the `ir.dashboards:write` scope.",
"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. OAuth tokens need the `ir.dashboards:read` scope. Panel data only includes records the token's other scopes allow (e.g. `ir.incidents:read`, `oc.alerts:read`).",
"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. OAuth tokens need the `ir.dashboards:write` scope.",
"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. OAuth tokens need the `ir.dashboards:write` scope.",
"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. OAuth tokens need the `ir.dashboards:read` scope. Panel data only includes records the token's other scopes allow (e.g. `ir.incidents:read`, `oc.alerts:read`).",
"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. OAuth tokens need the `ir.dashboards:write` scope.",
"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. OAuth tokens need the `ir.dashboards:write` scope.",
"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/{action_id}/runs": {
"post": {
"summary": "Create an edge connector action run",
"operationId": "createEdgeConnectorActionRun",
"tags": [
"Edge Connector Actions"
],
"security": [
{
"bearer_auth": []
}
],
"parameters": [
{
"name": "edge_connector_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "action_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"202": {
"description": "Action run queued",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/edge_connector_action_run_response"
}
}
}
},
"422": {
"description": "entity_type must be incident or alert"
},
"404": {
"description": "The entity is outside the team scope"
}
},
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"edge_connector_action_runs"
]
},
"attributes": {
"type": "object",
"properties": {
"parameters": {
"type": "object",
"nullable": true,
"description": "Null is treated as {}.",
"additionalProperties": true
},
"entity_type": {
"type": "string",
"enum": [
"incident",
"alert"
],
"nullable": true,
"description": "Must be provided together with entity_id. A missing or unreadable entity returns 404."
},
"entity_id": {
"type": "string",
"format": "uuid",
"nullable": true,
"description": "Must be provided together with entity_type. A missing or unreadable entity returns 404."
}
},
"additionalProperties": false
}
},
"required": [
"type",
"attributes"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
}
}
}
},
"/v1/edge_connectors/{edge_connector_id}/actions/{action_id}/runs/{id}": {
"get": {
"summary": "Show an edge connector action run",
"operationId": "getEdgeConnectorActionRun",
"tags": [
"Edge Connector Actions"
],
"security": [
{
"bearer_auth": []
}
],
"parameters": [
{
"name": "edge_connector_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "action_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "The caller can read the workflow run",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/edge_connector_action_run_response"
}
}
}
},
"404": {
"description": "The caller cannot read the workflow run"
}
}
}
},
"/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"
},
"owner_group_ids": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "IDs of the teams (groups) that own this connector"
},
"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"
}
},
"owner_group_ids": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "IDs of the teams (groups) that own this connector"
},
"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/environments/bulk_upsert": {
"post": {
"summary": "Bulk upsert Environments",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Environments"
],
"description": "Create or update multiple environments by external_id. Only attributes present in the payload are written (managed-fields semantics). Transactional: all succeed or all fail. Requires an API key with both create and update capability across the resource scope (team/org-scoped); record-scoped principals cannot use this endpoint (they receive 404), which also prevents the create-vs-update branch from leaking whether an external_id exists.",
"operationId": "bulkUpsertEnvironments",
"parameters": [],
"responses": {
"200": {
"description": "records upserted successfully",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/bulk_upsert_environments_response"
}
}
}
},
"422": {
"description": "validation or record-level error",
"content": {
"application/vnd.api+json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/errors_list"
},
{
"$ref": "#/components/schemas/bulk_upsert_environments_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_environments"
}
}
},
"required": true
}
}
},
"/v1/environments/bulk_delete": {
"post": {
"summary": "Bulk delete Environments",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Environments"
],
"description": "Delete environments by external_id list, or prune by managed_by source. Two mutually exclusive modes.",
"operationId": "bulkDeleteEnvironments",
"parameters": [],
"responses": {
"200": {
"description": "records deleted successfully",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/bulk_destroy_environments_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_environments_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_environments"
}
}
},
"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}/condition_groups": {
"parameters": [
{
"name": "form_field_placement_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Creates a Form Field Placement Condition Group",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormFieldPlacementConditionGroups"
],
"description": "Creates a new form_field_placement_condition_group. Add conditions to it by creating form_field_placement_conditions with its condition_group_id.",
"operationId": "createFormFieldPlacementConditionGroup",
"parameters": [],
"responses": {
"201": {
"description": "form_field_placement_condition_group created",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/form_field_placement_condition_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_form_field_placement_condition_group"
}
}
},
"required": true
}
},
"get": {
"summary": "List Form Field Placement Condition Groups",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormFieldPlacementConditionGroups"
],
"description": "List form_field_placement_condition_groups, each with its conditions",
"operationId": "listFormFieldPlacementConditionGroups",
"parameters": [
{
"name": "page[number]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "page[size]",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter[group_type]",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/form_field_placement_condition_group_list"
}
}
}
}
}
}
},
"/v1/form_field_placement_condition_groups/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves a Form Field Placement Condition Group",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormFieldPlacementConditionGroups"
],
"description": "Retrieves a specific form_field_placement_condition_group by id, with its conditions",
"operationId": "getFormFieldPlacementConditionGroup",
"responses": {
"200": {
"description": "form_field_placement_condition_group found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/form_field_placement_condition_group_response"
}
}
}
},
"404": {
"description": "resource not found",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
}
}
},
"put": {
"summary": "Update a Form Field Placement Condition Group",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormFieldPlacementConditionGroups"
],
"description": "Update a specific form_field_placement_condition_group by id",
"operationId": "updateFormFieldPlacementConditionGroup",
"parameters": [],
"responses": {
"200": {
"description": "form_field_placement_condition_group updated",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/form_field_placement_condition_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_form_field_placement_condition_group"
}
}
},
"required": true
}
},
"delete": {
"summary": "Delete a Form Field Placement Condition Group",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"FormFieldPlacementConditionGroups"
],
"description": "Delete a specific form_field_placement_condition_group by id, along with its conditions",
"operationId": "deleteFormFieldPlacementConditionGroup",
"responses": {
"200": {
"description": "form_field_placement_condition_group deleted",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/form_field_placement_condition_group_response"
}
}
}
},
"422": {
"description": "condition groups are not enabled",
"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/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": "cross-resource placement rejected",
"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": "moves a custom field's placement onto an action item form",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/form_field_placement_response"
}
}
}
},
"422": {
"description": "rejects re-pointing a placement at another team's form set",
"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_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 on an action item form",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/form_field_position_response"
}
}
}
},
"422": {
"description": "rejects an action item form when the feature 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"
}
}
}
}
},
"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"
}
}
}
},
"422": {
"description": "does not error when updating with a nonexistent form_field_id",
"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_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"
}
}
}
},
"200": {
"description": "built-in problem form_field already set up",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/form_field_response"
}
}
}
},
"404": {
"description": "built-in problem form_field already set up but not readable by the caller",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_list"
}
}
}
},
"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[resource_type]",
"in": "query",
"required": false,
"description": "Filter by resource type: `incident` or `problem`. Comma-separate multiple values. `problem` returns no fields unless Problem Management is enabled for the team.",
"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[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. Without `filter[resource_type]`, returns incident form sets and, when Problem Management is enabled, problem form sets. Pass `filter[resource_type]=incident` to list only incident 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[resource_type]",
"in": "query",
"schema": {
"type": "string",
"example": "incident"
},
"required": false,
"description": "Filter by resource type: `incident` or `problem`. Comma-separate multiple values. When omitted, incident form sets are returned, plus problem form sets if Problem Management is enabled. `problem` returns no form sets unless Problem Management is enabled. Any other value returns a 400."
},
{
"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"
}
}
}
},
"400": {
"description": "invalid resource_type filter",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/errors_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/functionalities/bulk_upsert": {
"post": {
"summary": "Bulk upsert Functionalities",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Functionalities"
],
"description": "Create or update multiple functionalities by external_id. Only attributes present in the payload are written (managed-fields semantics). Transactional: all succeed or all fail. Requires an API key with both create and update capability across the resource scope (team/org-scoped); record-scoped principals cannot use this endpoint (they receive 404), which also prevents the create-vs-update branch from leaking whether an external_id exists.",
"operationId": "bulkUpsertFunctionalities",
"parameters": [],
"responses": {
"200": {
"description": "records upserted successfully",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/bulk_upsert_functionalities_response"
}
}
}
},
"422": {
"description": "validation or record-level error",
"content": {
"application/vnd.api+json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/errors_list"
},
{
"$ref": "#/components/schemas/bulk_upsert_functionalities_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_functionalities"
}
}
},
"required": true
}
}
},
"/v1/functionalities/bulk_delete": {
"post": {
"summary": "Bulk delete Functionalities",
"security": [
{
"bearer_auth": []
}
],
"tags": [
"Functionalities"
],
"description": "Delete functionalities by external_id list, or prune by managed_by source. Two mutually exclusive modes.",
"operationId": "bulkDeleteFunctionalities",
"parameters": [],
"responses": {
"200": {
"description": "records deleted successfully",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/bulk_destroy_functionalities_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_functionalities_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_functionalities"
}
}
},
"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"
}
}
}
},
"422": {
"description": "rejects a private custom logo URL",
"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_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"
}
}
}
},
"422": {
"description": "rejects a private custom logo URL",
"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_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": "accepts out-of-scope selected ids when scope validation is disabled",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/workflow_form_field_condition_response"
}
}
}
},
"422": {
"description": "rejects out-of-scope selected ids when scope validation is enabled",
"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_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": "accepts out-of-scope selected ids on update when scope validation is disabled",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/workflow_form_field_condition_response"
}
}
}
},
"422": {
"description": "rejects out-of-scope selected ids on update when scope validation is enabled",
"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_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"
}
}
}
},
"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_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[incident_id]",
"in": "query",
"required": false,
"description": "Filter by incident IDs (UUIDs), comma-separated",
"schema": {
"type": "string"
}
},
{
"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. The body may be written as `content` (or its alias `smart_content`) and is sanitized to the tags the retrospective editor supports. When no `title` is sent and the body opens with an `