{ "openapi": "3.1.0", "info": { "title": "Devin API v3", "description": "Devin v3 API with Service User authentication and RBAC", "version": "3.0.0" }, "paths": { "/v3/self": { "get": { "tags": [ "self" ], "summary": "Get Self", "operationId": "handle_get_self_v3_self_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ServiceUserSelf" }, { "$ref": "#/components/schemas/PatUserSelf" }, { "$ref": "#/components/schemas/DevinBrainUserSelf" }, { "$ref": "#/components/schemas/WindsurfSessionUserSelf" } ], "title": "Response Handle Get Self V3 Self Get" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3beta1/ai-gateway/metrics": { "get": { "tags": [ "ai-gateway-metrics" ], "summary": "Query AI Gateway Metrics", "description": "Query account-wide production OTel measurements. Requires\naccount.ai_gateway.view_metrics for service users and PATs on any account type.\nE2E covers HTTP 200 responses. Requests without tenant attribution are excluded.\nMissing data stays null; this telemetry is independent of trace sampling and is\nnot billing data. See the metric reference for populations and derivations.", "operationId": "handle_get_ai_gateway_metrics_v3beta1_ai_gateway_metrics_get", "parameters": [ { "name": "metric", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/AiGatewayMetric", "description": "The gateway measurement to query." }, "description": "The gateway measurement to query." }, { "name": "time_after", "in": "query", "required": true, "schema": { "type": "integer", "description": "Inclusive start, in Unix seconds. Must be a multiple of interval_seconds.", "title": "Time After" }, "description": "Inclusive start, in Unix seconds. Must be a multiple of interval_seconds." }, { "name": "time_before", "in": "query", "required": true, "schema": { "type": "integer", "description": "Exclusive end, in Unix seconds. Must be a multiple of interval_seconds.", "title": "Time Before" }, "description": "Exclusive end, in Unix seconds. Must be a multiple of interval_seconds." }, { "name": "interval_seconds", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 86400, "minimum": 60, "description": "Requested bucket width; must evenly divide 86400. Datadog may return coarser buckets.", "default": 300, "title": "Interval Seconds" }, "description": "Requested bucket width; must evenly divide 86400. Datadog may return coarser buckets." }, { "name": "model", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_./-]{0,199}$" }, { "type": "null" } ], "description": "Model family such as kimi-k3 (every reasoning effort combined), or one model ID such as kimi-k3-high (case-insensitive). Omit for all models, reported by family.", "title": "Model" }, "description": "Model family such as kimi-k3 (every reasoning effort combined), or one model ID such as kimi-k3-high (case-insensitive). Omit for all models, reported by family." }, { "name": "aggregation", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "sum", "avg", "p50", "p90", "p95", "p99", "ratio" ], "type": "string" }, { "type": "null" } ], "description": "Counters: sum. Distributions: avg, p50, p90, p95 (default), p99. Streaming share: ratio.", "title": "Aggregation" }, "description": "Counters: sum. Distributions: avg, p50, p90, p95 (default), p99. Streaming share: ratio." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AiGatewayMetricsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3beta1/ai-gateway/models": { "get": { "tags": [ "ai-gateway-metrics" ], "summary": "List AI Gateway Model Prices", "description": "List the models the account can call through the AI Gateway with the\nprice the account pays in USD per token. A model family whose members\nall have one price is one entry. Requires account.ai_gateway.view_prices\nfor service users and PATs on any account type. Prices are informational;\nthe invoice is the billing record.", "operationId": "handle_get_ai_gateway_models_v3beta1_ai_gateway_models_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AiGatewayModelsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/consumption/acu-limits/devin": { "get": { "tags": [ "acu-limits" ], "summary": "Get Devin ACU limits", "description": "Get all org-level Devin ACU limits for this enterprise.", "operationId": "handle_get_devin_acu_limits_v3_enterprise_consumption_acu_limits_devin_get", "parameters": [ { "name": "after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "After" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_ACULimitResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/consumption/acu-limits/devin/organizations/{org_id}": { "put": { "tags": [ "acu-limits" ], "summary": "Set org-level Devin ACU limit", "description": "Create or update an org-level Devin ACU limit.", "operationId": "handle_set_org_devin_acu_limit_v3_enterprise_consumption_acu_limits_devin_organizations__org_id__put", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateACULimitRequest" } } } }, "responses": { "204": { "description": "Successful Response" }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "delete": { "tags": [ "acu-limits" ], "summary": "Delete org-level Devin ACU limit", "description": "Delete an org-level Devin ACU limit.", "operationId": "handle_delete_org_devin_acu_limit_v3_enterprise_consumption_acu_limits_devin_organizations__org_id__delete", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "204": { "description": "Successful Response" }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/consumption/cycles": { "get": { "tags": [ "consumption" ], "summary": "List Consumption Cycles", "operationId": "handle_get_consumption_cycles_v3_enterprise_consumption_cycles_get", "parameters": [ { "name": "after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "After" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_ConsumptionCycle_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/consumption/daily": { "get": { "tags": [ "consumption" ], "summary": "Get Daily Consumption", "description": "Get daily ACU consumption for the entire enterprise.\n\nReturns total ACUs and consumption broken down by date.\n\n**Timezone behavior**: Billing cycles use midnight PST (Pacific Standard Time)\nas the day boundary, which corresponds to 08:00:00 UTC. To match the consumption\ndata shown in the Devin dashboard, pass Unix timestamps that align with this\ntimezone offset (e.g., 1733385600 for December 5, 2025 at midnight PST).", "operationId": "handle_get_consumption_daily_v3_enterprise_consumption_daily_get", "parameters": [ { "name": "time_before", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Time Before" } }, { "name": "time_after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Time After" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsumptionResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/consumption/daily/organizations/{org_id}": { "get": { "tags": [ "consumption" ], "summary": "Get Organization Daily Consumption", "description": "Get daily ACU consumption for a specific organization.\n\nReturns total ACUs and consumption broken down by date for the org.\n\n**Timezone behavior**: Billing cycles use midnight PST (Pacific Standard Time)\nas the day boundary, which corresponds to 08:00:00 UTC. To match the consumption\ndata shown in the Devin dashboard, pass Unix timestamps that align with this\ntimezone offset (e.g., 1733385600 for December 5, 2025 at midnight PST).", "operationId": "handle_get_org_consumption_daily_v3_enterprise_consumption_daily_organizations__org_id__get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "time_before", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Time Before" } }, { "name": "time_after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Time After" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsumptionResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/consumption/daily/users/{user_id}": { "get": { "tags": [ "consumption" ], "summary": "Get User Daily Consumption", "description": "Get daily ACU consumption for a specific user.\n\nReturns total ACUs and consumption broken down by date for the user.\n\n**Timezone behavior**: Billing cycles use midnight PST (Pacific Standard Time)\nas the day boundary, which corresponds to 08:00:00 UTC. To match the consumption\ndata shown in the Devin dashboard, pass Unix timestamps that align with this\ntimezone offset (e.g., 1733385600 for December 5, 2025 at midnight PST).", "operationId": "handle_get_user_consumption_daily_v3_enterprise_consumption_daily_users__user_id__get", "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "User Id" }, "description": "User ID" }, { "name": "time_before", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Time Before" } }, { "name": "time_after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Time After" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsumptionResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/consumption/daily/service-users/{service_user_id}": { "get": { "tags": [ "consumption" ], "summary": "Get Service User Daily Consumption", "description": "Get daily ACU consumption for a specific service user.\n\nReturns total ACUs and consumption broken down by date for sessions\ncreated by the given service user.\n\n**Timezone behavior**: Billing cycles use midnight PST (Pacific Standard Time)\nas the day boundary, which corresponds to 08:00:00 UTC. To match the consumption\ndata shown in the Devin dashboard, pass Unix timestamps that align with this\ntimezone offset (e.g., 1733385600 for December 5, 2025 at midnight PST).", "operationId": "handle_get_service_user_consumption_daily_v3_enterprise_consumption_daily_service_users__service_user_id__get", "parameters": [ { "name": "service_user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Service User Id", "example": "service-user-abc123def456" }, "description": "Service user ID (prefix: service-user-)" }, { "name": "time_before", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Time Before" } }, { "name": "time_after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Time After" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsumptionResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/consumption/daily/sessions/{session_id}": { "get": { "tags": [ "consumption" ], "summary": "Get Session Daily Consumption", "description": "Get daily ACU consumption for a specific session.\n\nReturns total ACUs and consumption broken down by date for the session.\n\n**Timezone behavior**: Billing cycles use midnight PST (Pacific Standard Time)\nas the day boundary, which corresponds to 08:00:00 UTC. To match the consumption\ndata shown in the Devin dashboard, pass Unix timestamps that align with this\ntimezone offset (e.g., 1733385600 for December 5, 2025 at midnight PST).", "operationId": "handle_get_session_consumption_daily_v3_enterprise_consumption_daily_sessions__session_id__get", "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Session Id", "example": "devin-abc123def456" }, "description": "Session ID (prefix: devin-). Alias for devin_id used in consumption endpoints." }, { "name": "time_before", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Time Before" } }, { "name": "time_after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Time After" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsumptionResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/consumption/daily/sessions": { "get": { "tags": [ "consumption" ], "summary": "List Session Daily Consumption", "description": "List daily ACU consumption per session and billing day.\n\nEach item is one session's usage in one daily billing window. Items are\nordered by billing date and session. Only session-days with a usage record\nare returned; recorded zero-ACU days may be present. Sum items by\n`session_id` for per-session totals. `first` counts session-days.\n\nEvery billed session-day of the enterprise's account is returned, including\nsealed and hidden-from-team sessions and sessions without an organization,\nso items add up to the billed ACUs. Billing-exempt sessions are excluded.\n\nBilling windows end in (time_after, time_before]. Billing dates before the\nUTC date of `time_after` are omitted; partial days are not prorated. Use\n08:00 UTC bounds for complete billing days (fixed UTC-8, including summer).\n\nKeep bounds fixed between pages. Results are live, not a snapshot or a\ncorrection feed. `total` is not computed.", "operationId": "handle_list_session_consumption_daily_v3_enterprise_consumption_daily_sessions_get", "parameters": [ { "name": "time_before", "in": "query", "required": true, "schema": { "type": "integer", "description": "End of the reporting window in positive Unix seconds, at most 100 days after time_after.", "title": "Time Before" }, "description": "End of the reporting window in positive Unix seconds, at most 100 days after time_after." }, { "name": "time_after", "in": "query", "required": true, "schema": { "type": "integer", "description": "Start of the reporting window in positive Unix seconds.", "title": "Time After" }, "description": "Start of the reporting window in positive Unix seconds." }, { "name": "after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "After" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 1000, "minimum": 1, "default": 100, "title": "First" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_SessionConsumptionResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/metrics/usage": { "get": { "tags": [ "metrics" ], "summary": "Get Usage Metrics", "description": "Get aggregated usage metrics for the enterprise account.\n\nReturns counts of sessions, searches, and PRs (opened, closed, merged)\nwithin the specified time range.", "operationId": "handle_get_usage_metrics_v3_enterprise_metrics_usage_get", "parameters": [ { "name": "time_before", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Time Before" } }, { "name": "time_after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Time After" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageMetrics" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/organizations/{org_id}/metrics/usage": { "get": { "tags": [ "metrics" ], "summary": "Get Organization Usage Metrics", "description": "Get aggregated usage metrics for the enterprise account.\n\nReturns counts of sessions, searches, and PRs (opened, closed, merged)\nwithin the specified time range.", "operationId": "handle_get_organization_usage_metrics_v3_enterprise_organizations__org_id__metrics_usage_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "time_before", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Time Before" } }, { "name": "time_after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Time After" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageMetrics" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/metrics/sessions": { "get": { "tags": [ "metrics" ], "summary": "Get Session Metrics", "description": "Get aggregated session metrics for the enterprise account.\n\nOptionally filter by playbook_id to get metrics for sessions created with a specific playbook.", "operationId": "handle_get_session_metrics_v3_enterprise_metrics_sessions_get", "parameters": [ { "name": "user_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "User Ids" } }, { "name": "service_user_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Service User Ids" } }, { "name": "time_before", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time Before" } }, { "name": "time_after", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time After" } }, { "name": "org_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Org Ids" } }, { "name": "playbook_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Playbook Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionMetricsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/metrics/searches": { "get": { "tags": [ "metrics" ], "summary": "Get Search Metrics", "description": "Get aggregated search metrics for the enterprise account.", "operationId": "handle_get_search_metrics_v3_enterprise_metrics_searches_get", "parameters": [ { "name": "time_before", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time Before" } }, { "name": "time_after", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time After" } }, { "name": "org_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Org Ids" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchMetricsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/metrics/prs": { "get": { "tags": [ "metrics" ], "summary": "Get PR Metrics", "description": "Get aggregated PR metrics for the enterprise account.\n\nOptionally filter by playbook_id to get metrics for PRs from sessions created with a specific playbook.", "operationId": "handle_get_pr_metrics_v3_enterprise_metrics_prs_get", "parameters": [ { "name": "user_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "User Ids" } }, { "name": "service_user_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Service User Ids" } }, { "name": "time_before", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time Before" } }, { "name": "time_after", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time After" } }, { "name": "org_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Org Ids" } }, { "name": "playbook_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Playbook Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrMetricsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/metrics/dau": { "get": { "tags": [ "metrics" ], "summary": "Get Daily Active Users", "description": "Get daily active users for each day in the specified time range.\n\nA user is considered active on a given day if they have created at least\nmin_sessions sessions OR at least min_searches searches during that UTC day.\n\nReturns a list of daily active user counts, one entry per day in the range.", "operationId": "handle_get_dau_metrics_v3_enterprise_metrics_dau_get", "parameters": [ { "name": "time_before", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time Before" } }, { "name": "time_after", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time After" } }, { "name": "org_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Org Ids" } }, { "name": "min_sessions", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 1, "title": "Min Sessions" } }, { "name": "min_searches", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 1, "title": "Min Searches" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActiveUserMetricsListResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/metrics/wau": { "get": { "tags": [ "metrics" ], "summary": "Get Weekly Active Users", "description": "Get weekly active users for each week in the specified time range.\n\nA user is considered active in a given week if they have created at least\nmin_sessions sessions OR at least min_searches searches during that UTC week.\n\nWeeks are defined as Monday 00:00:00 UTC to Sunday 23:59:59 UTC.\n\nReturns a list of weekly active user counts, one entry per week in the range.", "operationId": "handle_get_wau_metrics_v3_enterprise_metrics_wau_get", "parameters": [ { "name": "time_before", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time Before" } }, { "name": "time_after", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time After" } }, { "name": "org_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Org Ids" } }, { "name": "min_sessions", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 1, "title": "Min Sessions" } }, { "name": "min_searches", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 1, "title": "Min Searches" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActiveUserMetricsListResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/metrics/mau": { "get": { "tags": [ "metrics" ], "summary": "Get Monthly Active Users", "description": "Get monthly active users for each month in the specified time range.\n\nA user is considered active in a given month if they have created at least\nmin_sessions sessions OR at least min_searches searches during that UTC month.\n\nReturns a list of monthly active user counts, one entry per month in the range.", "operationId": "handle_get_mau_metrics_v3_enterprise_metrics_mau_get", "parameters": [ { "name": "time_before", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time Before" } }, { "name": "time_after", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time After" } }, { "name": "org_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Org Ids" } }, { "name": "min_sessions", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 1, "title": "Min Sessions" } }, { "name": "min_searches", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 1, "title": "Min Searches" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActiveUserMetricsListResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/metrics/sessions-by-category": { "get": { "tags": [ "metrics" ], "summary": "Get Session Metrics by Category", "description": "Get session counts and ACU consumption grouped by category and subcategory.", "operationId": "handle_get_sessions_by_category_v3_enterprise_metrics_sessions_by_category_get", "parameters": [ { "name": "time_before", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time Before" } }, { "name": "time_after", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time After" } }, { "name": "org_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Org Ids" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionsByCategoryResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/metrics/active-users": { "get": { "tags": [ "metrics" ], "summary": "Get Active Users for Custom Date Range", "description": "Get unique active users for a custom date range.\n\nA user is considered active if they have created at least min_sessions sessions\nOR at least min_searches searches within the specified time range.\n\nReturns a single count of unique active users across the entire range.", "operationId": "handle_get_active_users_metrics_v3_enterprise_metrics_active_users_get", "parameters": [ { "name": "time_before", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time Before" } }, { "name": "time_after", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time After" } }, { "name": "org_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Org Ids" } }, { "name": "min_sessions", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 1, "title": "Min Sessions" } }, { "name": "min_searches", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 1, "title": "Min Searches" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActiveUserMetricsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/ip-access-list": { "get": { "tags": [ "ip-access-list" ], "summary": "Get IP Access List", "operationId": "handle_get_ip_access_list_v3_enterprise_ip_access_list_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IpAccessListResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "put": { "tags": [ "ip-access-list" ], "summary": "Replace IP Access List", "operationId": "handle_replace_ip_access_list_v3_enterprise_ip_access_list_put", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IpAccessListReplaceRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IpAccessListResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "post": { "tags": [ "ip-access-list" ], "summary": "Add IPs to IP Access List", "operationId": "handle_add_ip_access_list_v3_enterprise_ip_access_list_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IpAccessListAddRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IpAccessListResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "delete": { "tags": [ "ip-access-list" ], "summary": "Clear IP Access List", "operationId": "handle_clear_ip_access_list_v3_enterprise_ip_access_list_delete", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IpAccessListResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/git-providers/connections": { "get": { "tags": [ "git_connections" ], "summary": "List Git Connections", "operationId": "handle_get_git_connections_v3_enterprise_git_providers_connections_get", "parameters": [ { "name": "after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "After" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_GitConnectionResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/git-providers/connections/{connection_id}/repositories": { "get": { "tags": [ "git_connections" ], "summary": "List repositories for a git connection", "operationId": "handle_list_git_connection_repositories_v3_enterprise_git_providers_connections__connection_id__repositories_get", "parameters": [ { "name": "connection_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Connection Id" } }, { "name": "after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "After" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 100, "title": "First" } }, { "name": "filter_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filter Name" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_GitConnectionRepositoryResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/organizations/{org_id}/git-providers/permissions": { "get": { "tags": [ "git_permissions" ], "summary": "List Git Permissions", "description": "List git permissions for the organization.", "operationId": "handle_get_organization_git_permissions_v3_enterprise_organizations__org_id__git_providers_permissions_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "After" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_GitPermissionResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "post": { "tags": [ "git_permissions" ], "summary": "Create Git Permissions", "operationId": "handle_bulk_create_organization_git_permissions_v3_enterprise_organizations__org_id__git_providers_permissions_post", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GitPermissionBulkCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GitPermissionResponse" }, "title": "Response Handle Bulk Create Organization Git Permissions V3 Enterprise Organizations Org Id Git Providers Permissions Post" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "put": { "tags": [ "git_permissions" ], "summary": "Replace Git Permissions", "operationId": "handle_replace_organization_git_permissions_v3_enterprise_organizations__org_id__git_providers_permissions_put", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GitPermissionBulkCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GitPermissionResponse" }, "title": "Response Handle Replace Organization Git Permissions V3 Enterprise Organizations Org Id Git Providers Permissions Put" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "delete": { "tags": [ "git_permissions" ], "summary": "Clear Git Permissions", "operationId": "handle_clear_organization_git_permissions_v3_enterprise_organizations__org_id__git_providers_permissions_delete", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GitPermissionResponse" }, "title": "Response Handle Clear Organization Git Permissions V3 Enterprise Organizations Org Id Git Providers Permissions Delete" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/organizations/{org_id}/git-providers/permissions/{git_permission_id}": { "patch": { "tags": [ "git_permissions" ], "summary": "Update Git Permission", "operationId": "handle_update_organization_git_permission_v3_enterprise_organizations__org_id__git_providers_permissions__git_permission_id__patch", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "git_permission_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Git Permission Id", "example": "git-permission-abc123def456" }, "description": "Git permission ID (prefix: git-permission-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GitPermissionUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GitPermissionResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "delete": { "tags": [ "git_permissions" ], "summary": "Delete Git Permission", "operationId": "handle_delete_organization_git_permission_v3_enterprise_organizations__org_id__git_providers_permissions__git_permission_id__delete", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "git_permission_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Git Permission Id", "example": "git-permission-abc123def456" }, "description": "Git permission ID (prefix: git-permission-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GitPermissionResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/audit-logs": { "get": { "tags": [ "audit_logs" ], "summary": "List Audit Logs", "description": "List audit logs for the enterprise.", "operationId": "handle_get_enterprise_audit_logs_v3_enterprise_audit_logs_get", "parameters": [ { "name": "order", "in": "query", "required": false, "schema": { "enum": [ "asc", "desc" ], "type": "string", "default": "desc", "title": "Order" } }, { "name": "time_before", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Time Before" } }, { "name": "time_after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Time After" } }, { "name": "after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "After" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } }, { "name": "action", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/AuditLogAction" }, { "type": "null" } ], "title": "Action" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_AuditLogResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/organizations/{org_id}/audit-logs": { "get": { "tags": [ "audit_logs" ], "summary": "List Organization Audit Logs", "description": "List audit logs for the organization.", "operationId": "handle_get_org_audit_logs_v3_enterprise_organizations__org_id__audit_logs_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "order", "in": "query", "required": false, "schema": { "enum": [ "asc", "desc" ], "type": "string", "default": "desc", "title": "Order" } }, { "name": "time_before", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Time Before" } }, { "name": "time_after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Time After" } }, { "name": "after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "After" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } }, { "name": "action", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/AuditLogAction" }, { "type": "null" } ], "title": "Action" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_AuditLogResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/hypervisors": { "get": { "summary": "List Hypervisors", "description": "List the hypervisors of the account's customer-managed VPC tenants.", "operationId": "handle_get_hypervisors_v3_enterprise_hypervisors_get", "parameters": [ { "name": "after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "After" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } }, { "name": "status", "in": "query", "required": false, "schema": { "enum": [ "available", "restarting", "disconnected", "terminated", "draining", "retiring", "all" ], "type": "string", "default": "available", "title": "Status" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_HypervisorResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/organizations": { "get": { "tags": [ "organizations" ], "summary": "List Organizations", "description": "List organizations in the enterprise.", "operationId": "handle_get_organizations_v3_enterprise_organizations_get", "parameters": [ { "name": "after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "After" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_OrganizationResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "post": { "tags": [ "organizations" ], "summary": "Create Organization", "description": "Create a new organization in this enterprise", "operationId": "handle_create_organization_v3_enterprise_organizations_post", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/organizations/{org_id}": { "get": { "tags": [ "organizations" ], "summary": "Get Organization", "description": "Get details for a specific organization in the enterprise.", "operationId": "handle_get_organization_v3_enterprise_organizations__org_id__get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "patch": { "tags": [ "organizations" ], "summary": "Update Organization", "description": "Update an organization's name and/or ACU limits", "operationId": "handle_update_organization_v3_enterprise_organizations__org_id__patch", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "delete": { "tags": [ "organizations" ], "summary": "Delete Organization", "description": "Delete an organization from this enterprise", "operationId": "handle_delete_organization_v3_enterprise_organizations__org_id__delete", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/org-group-limits": { "get": { "tags": [ "org-groups" ], "summary": "Get Org Groups Config", "description": "Get the current organization groups configuration.", "operationId": "get_org_groups_config_v3_enterprise_org_group_limits_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrgGroupsConfig" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "put": { "tags": [ "org-groups" ], "summary": "Update Org Groups Config", "description": "Update the organization groups configuration.\n\nThis endpoint replaces the entire org groups configuration with the provided config.\n- Groups not in the request will be deleted\n- Groups in the request will be created or updated to match the config", "operationId": "update_org_groups_config_v3_enterprise_org_group_limits_put", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrgGroupsConfig" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrgGroupsConfig" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/roles": { "get": { "tags": [ "roles" ], "summary": "List Roles", "description": "Get roles for this enterprise", "operationId": "handle_get_roles_v3_enterprise_roles_get", "parameters": [ { "name": "after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "After" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_Role_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/roles/{role_id}": { "get": { "tags": [ "roles" ], "summary": "Get Role", "description": "Get a single role and its permissions for this enterprise", "operationId": "handle_get_role_v3_enterprise_roles__role_id__get", "parameters": [ { "name": "role_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Role Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleDetailResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/members/idp-groups": { "get": { "tags": [ "idp_groups" ], "summary": "List IDP Groups", "operationId": "handle_list_enterprise_idp_groups_v3_enterprise_members_idp_groups_get", "parameters": [ { "name": "after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "After" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_IdpGroup_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/members/idp-groups/{idp_group_name}": { "get": { "tags": [ "idp_groups" ], "summary": "Get IDP Group", "operationId": "handle_get_enterprise_idp_group_v3_enterprise_members_idp_groups__idp_group_name__get", "parameters": [ { "name": "idp_group_name", "in": "path", "required": true, "schema": { "type": "string", "title": "Idp Group Name" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdpGroup" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "post": { "tags": [ "idp_groups" ], "summary": "Assign IDP Group", "operationId": "handle_assign_enterprise_idp_group_role_v3_enterprise_members_idp_groups__idp_group_name__post", "parameters": [ { "name": "idp_group_name", "in": "path", "required": true, "schema": { "type": "string", "title": "Idp Group Name" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdpGroupUpdateRoleRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdpGroup" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "patch": { "tags": [ "idp_groups" ], "summary": "Update IDP Group", "operationId": "handle_update_enterprise_idp_group_role_v3_enterprise_members_idp_groups__idp_group_name__patch", "parameters": [ { "name": "idp_group_name", "in": "path", "required": true, "schema": { "type": "string", "title": "Idp Group Name" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdpGroupUpdateRoleRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdpGroup" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "delete": { "tags": [ "idp_groups" ], "summary": "Delete IDP Group", "operationId": "handle_remove_enterprise_idp_group_v3_enterprise_members_idp_groups__idp_group_name__delete", "parameters": [ { "name": "idp_group_name", "in": "path", "required": true, "schema": { "type": "string", "title": "Idp Group Name" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdpGroup" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/organizations/{org_id}/members/idp-groups": { "get": { "tags": [ "idp_groups" ], "summary": "List Organization IDP Groups", "operationId": "handle_list_organization_idp_groups_v3_enterprise_organizations__org_id__members_idp_groups_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "After" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_IdpGroup_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/organizations/{org_id}/members/idp-groups/{idp_group_name}": { "get": { "tags": [ "idp_groups" ], "summary": "Get Organization IDP Group", "operationId": "handle_get_organization_idp_group_v3_enterprise_organizations__org_id__members_idp_groups__idp_group_name__get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "idp_group_name", "in": "path", "required": true, "schema": { "type": "string", "title": "Idp Group Name" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdpGroup" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "post": { "tags": [ "idp_groups" ], "summary": "Assign Organization IDP Group", "operationId": "handle_assign_organization_idp_group_role_v3_enterprise_organizations__org_id__members_idp_groups__idp_group_name__post", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "idp_group_name", "in": "path", "required": true, "schema": { "type": "string", "title": "Idp Group Name" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdpGroupUpdateRoleRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdpGroup" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "patch": { "tags": [ "idp_groups" ], "summary": "Update Organization IDP Group", "operationId": "handle_update_organization_idp_group_role_v3_enterprise_organizations__org_id__members_idp_groups__idp_group_name__patch", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "idp_group_name", "in": "path", "required": true, "schema": { "type": "string", "title": "Idp Group Name" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdpGroupUpdateRoleRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdpGroup" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "delete": { "tags": [ "idp_groups" ], "summary": "Delete Organization IDP Group", "description": "Remove idp_group from the organization.", "operationId": "handle_remove_organization_idp_group_v3_enterprise_organizations__org_id__members_idp_groups__idp_group_name__delete", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "idp_group_name", "in": "path", "required": true, "schema": { "type": "string", "title": "Idp Group Name" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdpGroup" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/members/users": { "get": { "tags": [ "users" ], "summary": "List Users", "operationId": "handle_list_enterprise_users_v3_enterprise_members_users_get", "parameters": [ { "name": "after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "After" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } }, { "name": "email", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Filter by exact email address", "title": "Email" }, "description": "Filter by exact email address" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_EnterpriseUser_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "post": { "tags": [ "users" ], "summary": "Invite Users", "operationId": "handle_bulk_invite_enterprise_users_v3_enterprise_members_users_post", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserBulkCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/User" }, "title": "Response Handle Bulk Invite Enterprise Users V3 Enterprise Members Users Post" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/members/idp-users": { "get": { "tags": [ "users" ], "summary": "List IDP Group Users", "description": "List users whose enterprise membership is derived from IDP group assignments.", "operationId": "handle_list_enterprise_idp_users_v3_enterprise_members_idp_users_get", "parameters": [ { "name": "after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "After" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } }, { "name": "email", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Filter by exact email address", "title": "Email" }, "description": "Filter by exact email address" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_IdpGroupUser_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/members/users/{user_id}": { "get": { "tags": [ "users" ], "summary": "Get User", "description": "Get a user by ID. Returns both direct and IDP-group-derived role assignments.", "operationId": "handle_get_enterprise_user_v3_enterprise_members_users__user_id__get", "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "User Id" }, "description": "User ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnterpriseUserWithIdpRoles" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "patch": { "tags": [ "users" ], "summary": "Update User", "operationId": "handle_update_enterprise_user_role_v3_enterprise_members_users__user_id__patch", "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "User Id" }, "description": "User ID" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserUpdateRoleRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "delete": { "tags": [ "users" ], "summary": "Delete User", "operationId": "handle_remove_enterprise_user_v3_enterprise_members_users__user_id__delete", "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "User Id" }, "description": "User ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/organizations/{org_id}/members/users/{user_id}": { "post": { "tags": [ "users" ], "summary": "Assign Organization User", "operationId": "handle_assign_organization_user_role_v3_enterprise_organizations__org_id__members_users__user_id__post", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "User Id" }, "description": "User ID" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserUpdateRoleRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "patch": { "tags": [ "users" ], "summary": "Update Organization User", "operationId": "handle_update_organization_user_role_v3_enterprise_organizations__org_id__members_users__user_id__patch", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "User Id" }, "description": "User ID" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserUpdateRoleRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "delete": { "tags": [ "users" ], "summary": "Delete Organization User", "operationId": "handle_remove_organization_user_v3_enterprise_organizations__org_id__members_users__user_id__delete", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "User Id" }, "description": "User ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/members/service-users": { "get": { "tags": [ "service_users" ], "summary": "List Service Users", "description": "List service users in the enterprise.", "operationId": "handle_list_enterprise_service_users_v3_enterprise_members_service_users_get", "parameters": [ { "name": "after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "After" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } }, { "name": "include_inactive", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Include inactive service users (expired or removed).", "default": false, "title": "Include Inactive" }, "description": "Include inactive service users (expired or removed)." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_ServiceUser_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/members/service-users/{service_user_id}": { "get": { "tags": [ "service_users" ], "summary": "Get Service User", "description": "Get a service user by ID.", "operationId": "handle_get_enterprise_service_user_v3_enterprise_members_service_users__service_user_id__get", "parameters": [ { "name": "service_user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Service User Id", "example": "service-user-abc123def456" }, "description": "Service user ID (prefix: service-user-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceUser" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "post": { "tags": [ "service_users" ], "summary": "Assign Service User", "description": "Assign enterprise role to service user.", "operationId": "handle_assign_enterprise_service_user_role_v3_enterprise_members_service_users__service_user_id__post", "parameters": [ { "name": "service_user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Service User Id", "example": "service-user-abc123def456" }, "description": "Service user ID (prefix: service-user-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceUserUpdateRoleRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceUser" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "patch": { "tags": [ "service_users" ], "summary": "Update Service User", "description": "Update enterprise role for service user.", "operationId": "handle_update_enterprise_service_user_role_v3_enterprise_members_service_users__service_user_id__patch", "parameters": [ { "name": "service_user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Service User Id", "example": "service-user-abc123def456" }, "description": "Service user ID (prefix: service-user-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceUserUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceUser" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "delete": { "tags": [ "service_users" ], "summary": "Delete Service User", "operationId": "handle_remove_enterprise_service_user_v3_enterprise_members_service_users__service_user_id__delete", "parameters": [ { "name": "service_user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Service User Id", "example": "service-user-abc123def456" }, "description": "Service user ID (prefix: service-user-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceUser" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/organizations/{org_id}/members/service-users": { "get": { "tags": [ "service_users" ], "summary": "List Organization Service Users", "description": "List service users in the organization.", "operationId": "handle_list_organization_service_users_v3_enterprise_organizations__org_id__members_service_users_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "After" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } }, { "name": "include_inactive", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Include inactive service users (expired or removed).", "default": false, "title": "Include Inactive" }, "description": "Include inactive service users (expired or removed)." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_ServiceUser_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/organizations/{org_id}/members/service-users/{service_user_id}": { "post": { "tags": [ "service_users" ], "summary": "Assign Organization Service User", "description": "Assign organization role to service user.", "operationId": "handle_assign_organization_service_user_role_v3_enterprise_organizations__org_id__members_service_users__service_user_id__post", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "service_user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Service User Id", "example": "service-user-abc123def456" }, "description": "Service user ID (prefix: service-user-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceUserUpdateRoleRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceUser" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "patch": { "tags": [ "service_users" ], "summary": "Update Organization Service User", "description": "Update organization role for service user.", "operationId": "handle_update_organization_service_user_role_v3_enterprise_organizations__org_id__members_service_users__service_user_id__patch", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "service_user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Service User Id", "example": "service-user-abc123def456" }, "description": "Service user ID (prefix: service-user-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceUserUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceUser" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "delete": { "tags": [ "service_users" ], "summary": "Delete Organization Service User", "description": "Remove service user from the organization.", "operationId": "handle_remove_organization_service_user_v3_enterprise_organizations__org_id__members_service_users__service_user_id__delete", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "service_user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Service User Id", "example": "service-user-abc123def456" }, "description": "Service user ID (prefix: service-user-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceUser" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/organizations/{org_id}/tags": { "get": { "tags": [ "organization-tags" ], "summary": "Get Organization Allowed Tags", "description": "Get the allowed session tags for an organization.", "operationId": "handle_get_organization_allowed_tags_v3_enterprise_organizations__org_id__tags_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "post": { "tags": [ "organization-tags" ], "summary": "Append Organization Tags", "description": "Append tags to the allowed session tags for an organization.", "operationId": "handle_append_organization_allowed_tags_v3_enterprise_organizations__org_id__tags_post", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagsCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "put": { "tags": [ "organization-tags" ], "summary": "Replace Organization Allowed Tags", "description": "Replace the full set of allowed session tags for an organization.", "operationId": "handle_replace_organization_allowed_tags_v3_enterprise_organizations__org_id__tags_put", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagsCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "delete": { "tags": [ "organization-tags" ], "summary": "Clear Organization Tags", "description": "Clear all allowed session tags for an organization.", "operationId": "clear_organization_allowed_tags_v3_enterprise_organizations__org_id__tags_delete", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/organizations/{org_id}/tags/default": { "put": { "tags": [ "organization-tags" ], "summary": "Set Organization Default Tag", "description": "Set the default tag for an organization. The tag must exist in the allowed tags list.", "operationId": "set_organization_default_tag_v3_enterprise_organizations__org_id__tags_default_put", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefaultTagRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefaultTagResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "get": { "tags": [ "organization-tags" ], "summary": "Get Organization Default Tag", "description": "Get the current default tag for an organization.", "operationId": "get_organization_default_tag_v3_enterprise_organizations__org_id__tags_default_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefaultTagResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "delete": { "tags": [ "organization-tags" ], "summary": "Clear Organization Default Tag", "description": "Clear the default tag for an organization.", "operationId": "clear_organization_default_tag_v3_enterprise_organizations__org_id__tags_default_delete", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefaultTagResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/organizations/{org_id}/tags/{tag}": { "delete": { "tags": [ "organization-tags" ], "summary": "Remove Organization Tag", "description": "Remove a single tag from the allowed session tags for an organization.", "operationId": "remove_organization_allowed_tag_v3_enterprise_organizations__org_id__tags__tag__delete", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "tag", "in": "path", "required": true, "schema": { "type": "string", "title": "Tag" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/idp-groups": { "get": { "tags": [ "idp_groups" ], "summary": "List Account IDP Groups", "description": "List IDP groups registered with this enterprise.", "operationId": "handle_list_account_idp_groups_v3_enterprise_idp_groups_get", "parameters": [ { "name": "after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "After" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_IdpGroupResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "post": { "tags": [ "idp_groups" ], "summary": "Register Account IDP Groups", "description": "Bulk create IDP groups for this enterprise. Existing groups are ignored.", "operationId": "handle_bulk_register_account_idp_groups_v3_enterprise_idp_groups_post", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdpGroupsBulkCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IdpGroupResponse" }, "title": "Response Handle Bulk Register Account Idp Groups V3 Enterprise Idp Groups Post" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/idp-groups/{idp_group_name}": { "delete": { "tags": [ "idp_groups" ], "summary": "Delete Account IDP Group", "description": "Remove a registered IDP group from this enterprise.", "operationId": "handle_delete_account_idp_group_v3_enterprise_idp_groups__idp_group_name__delete", "parameters": [ { "name": "idp_group_name", "in": "path", "required": true, "schema": { "type": "string", "title": "Idp Group Name" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdpGroupResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/knowledge/notes": { "get": { "tags": [ "notes" ], "summary": "List all notes.", "operationId": "handle_list_notes_v3_enterprise_knowledge_notes_get", "parameters": [ { "name": "after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "After" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } }, { "name": "access_type", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "org", "enterprise" ], "type": "string" }, { "type": "null" } ], "title": "Access Type" } }, { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search" } }, { "name": "folder_path", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Folder Path" } }, { "name": "pinned_repo", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pinned Repo" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_KnowledgeNoteResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "post": { "tags": [ "notes" ], "summary": "Create an enterprise-level note", "operationId": "handle_create_note_v3_enterprise_knowledge_notes_post", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeNoteCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeNoteResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/knowledge/folders": { "get": { "tags": [ "notes" ], "summary": "Get knowledge folder structure with note counts.", "description": "Return the full folder tree with per-folder note counts.", "operationId": "handle_list_folders_v3_enterprise_knowledge_folders_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderTreeResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/knowledge/notes/{note_id}": { "get": { "tags": [ "notes" ], "summary": "Get a note by ID", "description": "Get a note by ID.", "operationId": "handle_get_note_v3_enterprise_knowledge_notes__note_id__get", "parameters": [ { "name": "note_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Note Id", "example": "note-abc123def456" }, "description": "Knowledge note ID (prefix: note-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeNoteResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "put": { "tags": [ "notes" ], "summary": "Update a note", "operationId": "handle_update_note_v3_enterprise_knowledge_notes__note_id__put", "parameters": [ { "name": "note_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Note Id", "example": "note-abc123def456" }, "description": "Knowledge note ID (prefix: note-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeNoteCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeNoteResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "delete": { "tags": [ "notes" ], "summary": "Delete a note", "operationId": "handle_delete_note_v3_enterprise_knowledge_notes__note_id__delete", "parameters": [ { "name": "note_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Note Id", "example": "note-abc123def456" }, "description": "Knowledge note ID (prefix: note-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeNoteResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/playbooks": { "get": { "tags": [ "playbooks" ], "summary": "List all playbooks.", "operationId": "handle_list_playbooks_v3_enterprise_playbooks_get", "deprecated": true, "parameters": [ { "name": "after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "After" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_PlaybookResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "post": { "tags": [ "playbooks" ], "summary": "Create an enterprise-level playbook", "operationId": "handle_create_playbook_v3_enterprise_playbooks_post", "deprecated": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlaybookCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlaybookResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/playbooks/{playbook_id}": { "get": { "tags": [ "playbooks" ], "summary": "Get a playbook by ID.", "description": "Get a specific playbook by ID.", "operationId": "handle_get_playbook_v3_enterprise_playbooks__playbook_id__get", "deprecated": true, "parameters": [ { "name": "playbook_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Playbook Id", "example": "playbook-abc123def456" }, "description": "Playbook ID (prefix: playbook-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlaybookResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "put": { "tags": [ "playbooks" ], "summary": "Update a playbook", "operationId": "handle_update_playbook_v3_enterprise_playbooks__playbook_id__put", "deprecated": true, "parameters": [ { "name": "playbook_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Playbook Id", "example": "playbook-abc123def456" }, "description": "Playbook ID (prefix: playbook-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlaybookCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlaybookResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "delete": { "tags": [ "playbooks" ], "summary": "Delete a playbook", "operationId": "handle_delete_playbook_v3_enterprise_playbooks__playbook_id__delete", "deprecated": true, "parameters": [ { "name": "playbook_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Playbook Id", "example": "playbook-abc123def456" }, "description": "Playbook ID (prefix: playbook-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlaybookResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/pr-reviews": { "post": { "tags": [ "pr-reviews" ], "summary": "Trigger Devin Review", "description": "Trigger a Devin Review for a pull/merge request.\n\nCreates a database record that will be picked up by the review\nworker pool. Always fetches the latest commit from the PR.", "operationId": "handle_create_pr_review_v3_enterprise_pr_reviews_post", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrReviewCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrReviewResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "get": { "tags": [ "pr-reviews" ], "summary": "Get latest Devin Review status", "description": "Return the latest Devin Review for a PR scoped to the enterprise.\n\nThe owning organization is resolved server-side from ``pr_url`` \u2014\nthe same way as the trigger endpoint. When ``commit_sha`` is\nomitted, the PR's current head commit is fetched from the provider\nand used. Returns ``404`` when no review exists for the resolved\ncommit.", "operationId": "handle_get_pr_review_status_v3_enterprise_pr_reviews_get", "parameters": [ { "name": "pr_url", "in": "query", "required": true, "schema": { "type": "string", "description": "Full URL of the pull/merge request to look up (e.g. `https://github.com/owner/repo/pull/123`).", "examples": [ "https://github.com/owner/repo/pull/123" ], "title": "Pr Url" }, "description": "Full URL of the pull/merge request to look up (e.g. `https://github.com/owner/repo/pull/123`)." }, { "name": "commit_sha", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Commit SHA to look up (full or short prefix). Defaults to the PR's current head commit when omitted.", "examples": [ "abc123def4567890abc123def4567890abc123de" ], "title": "Commit Sha" }, "description": "Commit SHA to look up (full or short prefix). Defaults to the PR's current head commit when omitted." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrReviewResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/sessions/insights": { "get": { "tags": [ "sessions" ], "summary": "List sessions with insights", "description": "List sessions with detailed insights including message counts,\nsession size classification, and AI-generated analysis.", "operationId": "handle_get_account_sessions_insights_v3_enterprise_sessions_insights_get", "parameters": [ { "name": "after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "After" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } }, { "name": "session_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Session Ids" } }, { "name": "created_after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Created After" } }, { "name": "created_before", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Created Before" } }, { "name": "updated_after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Updated After" } }, { "name": "updated_before", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Updated Before" } }, { "name": "tags", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Tags" } }, { "name": "playbook_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Playbook Id" } }, { "name": "origins", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "enum": [ "webapp", "slack", "teams", "api", "linear", "jira", "automation", "cli", "desktop", "code_scan", "other" ], "type": "string" } }, { "type": "null" } ], "title": "Origins" } }, { "name": "schedule_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Schedule Id" } }, { "name": "user_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "User Ids" } }, { "name": "service_user_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Service User Ids" } }, { "name": "repo_names", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Filter by repository names (e.g., 'owner/repo')", "title": "Repo Names" }, "description": "Filter by repository names (e.g., 'owner/repo')" }, { "name": "category", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "bug_fixing", "ci_cd_and_devops", "code_quality_and_security", "code_review", "code_review_and_analysis", "data_and_automation", "documentation_and_content", "feature_development", "migrations_and_upgrades", "other", "production_investigation", "refactoring_and_optimization", "research_and_exploration", "security", "unit_test_generation" ], "type": "string" }, { "type": "null" } ], "title": "Category" } }, { "name": "is_archived", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Archived" } }, { "name": "automation_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Filter to sessions created by any of these automations", "title": "Automation Ids" }, "description": "Filter to sessions created by any of these automations" }, { "name": "parent_session_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Filter to child sessions spawned by this parent session", "title": "Parent Session Id" }, "description": "Filter to child sessions spawned by this parent session" }, { "name": "org_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Org Ids" } }, { "name": "include_deleted_orgs", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Include Deleted Orgs" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_SessionInsightsResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/sessions/{devin_id}": { "get": { "tags": [ "sessions" ], "summary": "Get session details", "description": "Get details of a specific session.", "operationId": "handle_get_account_session_v3_enterprise_sessions__devin_id__get", "parameters": [ { "name": "devin_id", "in": "path", "required": true, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Devin Id", "example": "devin-abc123def456" }, "description": "Devin session ID (prefix: devin-)" }, { "name": "org_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Org Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/sessions/{devin_id}/insights": { "get": { "tags": [ "sessions" ], "summary": "Get session insights", "description": "Get detailed insights for a specific session, including message counts,\nsession size classification, and AI-generated analysis.", "operationId": "handle_get_account_session_insights_v3_enterprise_sessions__devin_id__insights_get", "parameters": [ { "name": "devin_id", "in": "path", "required": true, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Devin Id", "example": "devin-abc123def456" }, "description": "Devin session ID (prefix: devin-)" }, { "name": "org_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Org Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionInsightsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/sessions/{devin_id}/insights/generate": { "post": { "tags": [ "sessions" ], "summary": "Generate session insights", "description": "Trigger on-demand generation of session insights.\n\nReturns ``already_exists`` if insights have already been generated.\nOtherwise kicks off generation in the background. Poll the\nGET insights endpoint to retrieve results once generation completes.", "operationId": "handle_generate_account_session_insights_v3_enterprise_sessions__devin_id__insights_generate_post", "parameters": [ { "name": "devin_id", "in": "path", "required": true, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Devin Id", "example": "devin-abc123def456" }, "description": "Devin session ID (prefix: devin-)" }, { "name": "org_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Org Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionInsightsGenerateResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/sessions": { "get": { "tags": [ "sessions" ], "summary": "List sessions for account", "description": "List all sessions across the enterprise.", "operationId": "handle_get_account_sessions_v3_enterprise_sessions_get", "parameters": [ { "name": "after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "After" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } }, { "name": "session_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Session Ids" } }, { "name": "created_after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Created After" } }, { "name": "created_before", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Created Before" } }, { "name": "updated_after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Updated After" } }, { "name": "updated_before", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Updated Before" } }, { "name": "tags", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Tags" } }, { "name": "playbook_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Playbook Id" } }, { "name": "origins", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "enum": [ "webapp", "slack", "teams", "api", "linear", "jira", "automation", "cli", "desktop", "code_scan", "other" ], "type": "string" } }, { "type": "null" } ], "title": "Origins" } }, { "name": "schedule_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Schedule Id" } }, { "name": "user_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "User Ids" } }, { "name": "service_user_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Service User Ids" } }, { "name": "repo_names", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Filter by repository names (e.g., 'owner/repo')", "title": "Repo Names" }, "description": "Filter by repository names (e.g., 'owner/repo')" }, { "name": "category", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "bug_fixing", "ci_cd_and_devops", "code_quality_and_security", "code_review", "code_review_and_analysis", "data_and_automation", "documentation_and_content", "feature_development", "migrations_and_upgrades", "other", "production_investigation", "refactoring_and_optimization", "research_and_exploration", "security", "unit_test_generation" ], "type": "string" }, { "type": "null" } ], "title": "Category" } }, { "name": "is_archived", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Archived" } }, { "name": "automation_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Filter to sessions created by any of these automations", "title": "Automation Ids" }, "description": "Filter to sessions created by any of these automations" }, { "name": "parent_session_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Filter to child sessions spawned by this parent session", "title": "Parent Session Id" }, "description": "Filter to child sessions spawned by this parent session" }, { "name": "org_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Org Ids" } }, { "name": "include_deleted_orgs", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Include Deleted Orgs" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_SessionResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/sessions/{devin_id}/attachments": { "get": { "tags": [ "sessions" ], "summary": "List session attachments", "description": "List all attachments for a session.", "operationId": "handle_get_account_session_attachments_v3_enterprise_sessions__devin_id__attachments_get", "parameters": [ { "name": "devin_id", "in": "path", "required": true, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Devin Id", "example": "devin-abc123def456" }, "description": "Devin session ID (prefix: devin-)" }, { "name": "org_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Org Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SessionAttachment" }, "title": "Response Handle Get Account Session Attachments V3 Enterprise Sessions Devin Id Attachments Get" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/sessions/{devin_id}/tags": { "get": { "tags": [ "sessions" ], "summary": "Get session tags", "description": "Get the tags for a specific session.", "operationId": "handle_get_account_session_tags_v3_enterprise_sessions__devin_id__tags_get", "parameters": [ { "name": "devin_id", "in": "path", "required": true, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Devin Id", "example": "devin-abc123def456" }, "description": "Devin session ID (prefix: devin-)" }, { "name": "org_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Org Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionTagsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "put": { "tags": [ "sessions" ], "summary": "Replace session tags", "description": "Replace all tags on a session.", "operationId": "handle_replace_account_session_tags_v3_enterprise_sessions__devin_id__tags_put", "parameters": [ { "name": "devin_id", "in": "path", "required": true, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Devin Id", "example": "devin-abc123def456" }, "description": "Devin session ID (prefix: devin-)" }, { "name": "org_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Org Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionTagsUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionTagsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "post": { "tags": [ "sessions" ], "summary": "Append session tags", "description": "Append tags to a session (deduplicating with existing tags).", "operationId": "handle_append_account_session_tags_v3_enterprise_sessions__devin_id__tags_post", "parameters": [ { "name": "devin_id", "in": "path", "required": true, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Devin Id", "example": "devin-abc123def456" }, "description": "Devin session ID (prefix: devin-)" }, { "name": "org_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Org Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionTagsUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionTagsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/sessions/{devin_id}/messages": { "get": { "tags": [ "sessions" ], "summary": "List session messages", "description": "List all messages for a session with cursor-based pagination, ordered chronologically.", "operationId": "handle_get_account_session_messages_v3_enterprise_sessions__devin_id__messages_get", "parameters": [ { "name": "devin_id", "in": "path", "required": true, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Devin Id", "example": "devin-abc123def456" }, "description": "Devin session ID (prefix: devin-)" }, { "name": "qs", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/CursorPaginationParams" } }, { "name": "org_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Org Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_SessionMessage_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "post": { "tags": [ "sessions" ], "summary": "Send a message to a session", "description": "Send a message to an active session. The session will be automatically resumed if suspended.", "operationId": "handle_post_account_session_message_v3_enterprise_sessions__devin_id__messages_post", "parameters": [ { "name": "devin_id", "in": "path", "required": true, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Devin Id", "example": "devin-abc123def456" }, "description": "Devin session ID (prefix: devin-)" }, { "name": "org_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Org Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionMessageCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/queue": { "get": { "tags": [ "queue" ], "summary": "Get Queue", "description": "Get the queue status for an enterprise.\n\nReturns the total number of queued sessions (status: new, resuming, claimed)\nand a status indicator (normal/elevated/high).\n\nThis endpoint is useful for enterprise admins to monitor queue health and\nset up alerts for capacity issues.", "operationId": "get_queue_v3_enterprise_queue_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QueueResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/organizations/{org_id}/members/users": { "get": { "tags": [ "users" ], "summary": "List Organization Users", "operationId": "handle_list_organization_users_v3_enterprise_organizations__org_id__members_users_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "After" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } }, { "name": "email", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Filter by exact email address", "title": "Email" }, "description": "Filter by exact email address" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_User_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/organizations/{org_id}/members/idp-users": { "get": { "tags": [ "users" ], "summary": "List Organization IDP Group Users", "description": "List users whose organization membership is derived from IDP group assignments.", "operationId": "handle_list_organization_idp_users_v3_enterprise_organizations__org_id__members_idp_users_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "After" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } }, { "name": "email", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Filter by exact email address", "title": "Email" }, "description": "Filter by exact email address" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_IdpGroupUser_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/code-scans/metrics": { "get": { "tags": [ "code-scans" ], "summary": "Get Code Scan Metrics", "description": "Get aggregated code scan metrics for the enterprise account.\n\nReturns scan, finding, and remediation-PR metrics for code scans created\nwithin the specified time range, optionally filtered to specific\norganizations.", "operationId": "handle_get_code_scan_metrics_v3_enterprise_code_scans_metrics_get", "parameters": [ { "name": "time_before", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time Before" } }, { "name": "time_after", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time After" } }, { "name": "org_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Org Ids" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodeScanMetricsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/code-scans/scans": { "get": { "tags": [ "code-scans" ], "summary": "List Code Scans", "description": "List code scans for the enterprise account.\n\nScans are returned newest first. Optionally filter by ``org_ids``,\n``repo_name``, and creation time (``time_after`` / ``time_before``);\nresults are paginated with an opaque cursor (``after`` / ``first``).", "operationId": "handle_list_code_scans_v3_enterprise_code_scans_scans_get", "parameters": [ { "name": "time_before", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Time Before" } }, { "name": "time_after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Time After" } }, { "name": "after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "After" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } }, { "name": "scan_type", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "security", "performance", "db-queries", "test-coverage", "dead-code", "code-quality", "cleanup", "telemetry", "accessibility", "compliance", "general", "migration-docs", "red-team" ], "type": "string" }, { "type": "null" } ], "description": "Filter to scans of this scan type.", "title": "Scan Type" }, "description": "Filter to scans of this scan type." }, { "name": "repo_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Filter to scans that scanned this repository. Matches multi-repo scans even when the repository is not the scan's primary repo, so returned items may report a different repo_name.", "title": "Repo Name" }, "description": "Filter to scans that scanned this repository. Matches multi-repo scans even when the repository is not the scan's primary repo, so returned items may report a different repo_name." }, { "name": "org_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Filter to scans in these organizations.", "title": "Org Ids" }, "description": "Filter to scans in these organizations." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_CodeScanResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/code-scans/findings": { "get": { "tags": [ "code-scans" ], "summary": "List Code Scan Findings", "description": "List code scan findings for the enterprise account.\n\nFindings are returned newest first. Optionally filter by ``org_ids``,\n``scan_id``, ``repo_name``, ``severity``, ``status``, ``payoff``, and\ncreated/updated timestamp bounds (``created_after``/``created_before``,\n``updated_after``/``updated_before``). Results are paginated with an opaque\ncursor (``after`` / ``first``).", "operationId": "handle_list_code_scan_findings_v3_enterprise_code_scans_findings_get", "parameters": [ { "name": "after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "After" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } }, { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ], "description": "Text search over finding title, description, and file path. Combines with other filters such as repo_name. Blank means no search. Returns 503 when search is unavailable for an organization.", "title": "Q" }, "description": "Text search over finding title, description, and file path. Combines with other filters such as repo_name. Blank means no search. Returns 503 when search is unavailable for an organization." }, { "name": "scan_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Filter to findings produced by this scan.", "title": "Scan Id" }, "description": "Filter to findings produced by this scan." }, { "name": "repo_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Filter to findings reported in this repository.", "title": "Repo Name" }, "description": "Filter to findings reported in this repository." }, { "name": "severity", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "enum": [ "critical", "high", "medium", "low" ], "type": "string" } }, { "type": "null" } ], "description": "Filter to findings with any of these severities (critical, high, medium, low).", "title": "Severity" }, "description": "Filter to findings with any of these severities (critical, high, medium, low)." }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "enum": [ "open", "dismissed", "resolved" ], "type": "string" } }, { "type": "null" } ], "description": "Filter to findings with any of these statuses (open, dismissed, resolved).", "title": "Status" }, "description": "Filter to findings with any of these statuses (open, dismissed, resolved)." }, { "name": "payoff", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "enum": [ "quick_win", "big_fix", "easy_fix", "deprioritize" ], "type": "string" }, "maxItems": 4 }, { "type": "null" } ], "description": "Filter to findings in any of these payoff quadrants (quick_win, big_fix, easy_fix, deprioritize). Unrated findings (null fix_effort) never match.", "title": "Payoff" }, "description": "Filter to findings in any of these payoff quadrants (quick_win, big_fix, easy_fix, deprioritize). Unrated findings (null fix_effort) never match." }, { "name": "created_after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Findings created at or after this unix timestamp (seconds).", "title": "Created After" }, "description": "Findings created at or after this unix timestamp (seconds)." }, { "name": "created_before", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Findings created at or before this unix timestamp (seconds).", "title": "Created Before" }, "description": "Findings created at or before this unix timestamp (seconds)." }, { "name": "updated_after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Findings updated at or after this unix timestamp (seconds).", "title": "Updated After" }, "description": "Findings updated at or after this unix timestamp (seconds)." }, { "name": "updated_before", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Findings updated at or before this unix timestamp (seconds).", "title": "Updated Before" }, "description": "Findings updated at or before this unix timestamp (seconds)." }, { "name": "org_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Filter to findings in these organizations.", "title": "Org Ids" }, "description": "Filter to findings in these organizations." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_CodeScanFindingResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/code-scans/profiles": { "get": { "tags": [ "code-scans" ], "summary": "List Code Scan Profiles", "description": "List code scan profiles for the enterprise account.\n\nReturns profile summaries (without guidance) newest first, including both\norg-owned and account-shared profiles. Optionally filter by ``org_ids``;\nresults are paginated with an opaque cursor (``after`` / ``first``).", "operationId": "handle_list_code_scan_profiles_v3_enterprise_code_scans_profiles_get", "parameters": [ { "name": "after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "After" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } }, { "name": "org_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Only return profiles visible to these organizations. Defaults to all organizations in the account.", "title": "Org Ids" }, "description": "Only return profiles visible to these organizations. Defaults to all organizations in the account." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_CodeScanProfileSummaryResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/code-scans/profiles/{profile_id}": { "get": { "tags": [ "code-scans" ], "summary": "Get Code Scan Profile", "description": "Get a code scan profile by ID.\n\nReturns the profile's metadata, visibility (org-owned or shared\naccount-wide), and all of its guidance fields. Returns ``404`` when the\nprofile does not exist or is not visible to the enterprise account.", "operationId": "handle_get_code_scan_profile_v3_enterprise_code_scans_profiles__profile_id__get", "parameters": [ { "name": "profile_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Profile Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodeScanProfileDetailResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/organizations/{org_id}/code-scans/{scan_id}/findings/{finding_id}/remediate": { "post": { "tags": [ "code-scans" ], "summary": "Remediate Code Scan Finding", "description": "Launch a Devin session to remediate a code scan finding.\n\nThe session analyzes the vulnerable code, implements a fix, and opens a\npull request. The session is attributed to the calling principal (the\nservice user or PAT that made the request). Returns ``409`` if the finding\nalready has a remediation session.", "operationId": "handle_remediate_code_scan_finding_v3_enterprise_organizations__org_id__code_scans__scan_id__findings__finding_id__remediate_post", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "scan_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Scan Id" } }, { "name": "finding_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Finding Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/V3RemediateFindingRequest" }, { "type": "null" } ], "title": "Body" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemediateFindingResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/organizations/{org_id}/code-scans/{scan_id}/findings/remediate": { "post": { "tags": [ "code-scans" ], "summary": "Remediate Code Scan Findings", "description": "Launch one Devin session to remediate several findings of a code scan.\n\nA batch of two or more findings (which may span repositories) gets a\nplanner session that groups them and launches a fix session per group,\neach on its own branch with its own pull request. A single finding gets a\nfix session directly. The session is attributed to the calling principal.\nReturns ``409`` if any finding already has a remediation session, in which\ncase none of them is claimed.\n\nInstead of ``finding_ids``, ``select_all`` remediates every open finding\nmatching its filters that is not already being remediated.", "operationId": "handle_remediate_code_scan_findings_v3_enterprise_organizations__org_id__code_scans__scan_id__findings_remediate_post", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "scan_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Scan Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemediateFindingsRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemediateFindingsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/organizations/{org_id}/code-scans/{scan_id}": { "get": { "tags": [ "code-scans" ], "summary": "Get Code Scan", "description": "Get a single code scan, including the files attached to it.\n\nReturns ``404`` when the scan is not in the organization.", "operationId": "handle_get_code_scan_v3_enterprise_organizations__org_id__code_scans__scan_id__get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "scan_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Scan Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodeScanResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/organizations/{org_id}/code-scans/{scan_id}/profile": { "put": { "tags": [ "code-scans" ], "summary": "Switch Code Scan Profile", "description": "Switch the profile applied to future incremental runs of a scan.\n\nIncremental re-scans pick up their profile through the scan's profile\nlink, so repointing the link changes the profile used from the next run\nonward. Completed runs and their findings are unaffected. The new\nprofile must have the same scan type and mode as the current one, and\nthe scan must not have an active run (``409`` otherwise).", "operationId": "handle_switch_code_scan_profile_v3_enterprise_organizations__org_id__code_scans__scan_id__profile_put", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "scan_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Scan Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodeScanProfileSwitchRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodeScanProfileSwitchResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/organizations/{org_id}/code-scans/{scan_id}/effort": { "put": { "tags": [ "code-scans" ], "summary": "Update Code Scan Effort", "description": "Set the effort applied to future incremental runs of a scan.\n\nCompleted runs and their findings are unaffected. The scan must not\nhave an active run (``409`` otherwise).", "operationId": "handle_update_code_scan_effort_v3_enterprise_organizations__org_id__code_scans__scan_id__effort_put", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "scan_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Scan Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodeScanEffortUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodeScanEffortResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/organizations/{org_id}/code-scans/{scan_id}/scan-new-commits": { "post": { "tags": [ "code-scans" ], "summary": "Scan New Commits", "description": "Immediately trigger an incremental (diff) scan of new commits.\n\nRe-runs the scan against only the commits landed since it last completed.\nThis is the one-off, on-demand form of the auto-scan schedule. Returns\n``409`` if the scan has no completed run to extend or is already in\nprogress.", "operationId": "handle_scan_new_commits_v3_enterprise_organizations__org_id__code_scans__scan_id__scan_new_commits_post", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "scan_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Scan Id" } } ], "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScanNewCommitsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/organizations/{org_id}/code-scans/{scan_id}/cancel": { "post": { "tags": [ "code-scans" ], "summary": "Cancel Code Scan", "description": "Cancel an in-flight scan and stop its session and support sessions.\n\nKeeps the scan, findings so far, and auto-scan schedule. Returns 404 for\nmissing or archived scans, and 409 for a non-cancellable scan.", "operationId": "handle_cancel_code_scan_v3_enterprise_organizations__org_id__code_scans__scan_id__cancel_post", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "scan_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Scan Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelCodeScanResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/organizations/{org_id}/code-scans/{scan_id}/recover": { "post": { "tags": [ "code-scans" ], "summary": "Recover Code Scan", "description": "Recover a scan that failed because its session stopped.\n\nSends the scan's existing session a message to continue, resuming it if\nsuspended, and sets the scan back to ``running``. Returns ``409`` if the\nscan is not ``failed`` or its session has ended; scan new commits instead.", "operationId": "handle_recover_code_scan_v3_enterprise_organizations__org_id__code_scans__scan_id__recover_post", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "scan_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Scan Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecoverCodeScanResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/organizations/{org_id}/code-scans/ingestion": { "post": { "tags": [ "code-scans" ], "summary": "Start Ingestion Scan", "description": "Start an ingestion-mode code scan on one or more repositories in an organization.\n\nThe scan is enqueued and launched asynchronously by the scan dispatcher.\nOnly ingest-mode profiles are accepted; a non-ingest profile is rejected\nwith ``400``. Optional attachment URLs (uploaded via the attachments API)\nare provided to the scan. Returns ``409`` when the organization's scan\nbacklog is at capacity.", "operationId": "handle_start_ingestion_scan_v3_enterprise_organizations__org_id__code_scans_ingestion_post", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartIngestionScanRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodeScanResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/organizations/{org_id}/code-scans/{scan_id}/auto-scan": { "post": { "tags": [ "code-scans" ], "summary": "Create Auto-Scan Schedule", "description": "Create the recurring auto-scan schedule for a code scan.\n\nAuto-scan is backed by an automation with a ``schedule:recurring`` trigger\n(carrying the rrule) and a ``scan_new_commits`` action targeting this\nscan; when the schedule fires, commits landed since the last scan are\nscanned. Create-only: returns ``409`` if the scan already has a schedule\n(delete it first to change it).", "operationId": "handle_create_auto_scan_schedule_v3_enterprise_organizations__org_id__code_scans__scan_id__auto_scan_post", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "scan_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Scan Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutoScanScheduleCreateRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutoScanScheduleResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "delete": { "tags": [ "code-scans" ], "summary": "Delete Auto-Scan Schedule", "description": "Remove the recurring auto-scan schedule for a code scan.\n\nDeletes the underlying schedule automation. Idempotent: returns ``204``\neven when no schedule is configured.", "operationId": "handle_delete_auto_scan_schedule_v3_enterprise_organizations__org_id__code_scans__scan_id__auto_scan_delete", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "scan_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Scan Id" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/organizations/{org_id}/code-scans/{scan_id}/findings/{finding_id}/unlink-session": { "post": { "tags": [ "code-scans" ], "summary": "Unlink Code Scan Finding Session", "description": "Detach a finding from its remediation session so it can be remediated\nagain. The session is not stopped.", "operationId": "handle_unlink_code_scan_finding_session_v3_enterprise_organizations__org_id__code_scans__scan_id__findings__finding_id__unlink_session_post", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "scan_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Scan Id" } }, { "name": "finding_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Finding Id" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/organizations/{org_id}/code-scans/{scan_id}/findings/unlink-session": { "post": { "tags": [ "code-scans" ], "summary": "Unlink Code Scan Findings Session", "description": "Detach several findings from their remediation sessions so they can be\nremediated again. The sessions are not stopped.", "operationId": "handle_unlink_code_scan_findings_session_v3_enterprise_organizations__org_id__code_scans__scan_id__findings_unlink_session_post", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "scan_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Scan Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnlinkFindingsSessionRequest" } } } }, "responses": { "204": { "description": "Successful Response" }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/organizations/{org_id}/code-scans/{scan_id}/findings/{finding_id}": { "patch": { "tags": [ "code-scans" ], "summary": "Update Code Scan Finding Status", "description": "Update a finding's status without stopping sessions or modifying PRs.", "operationId": "handle_update_code_scan_finding_status_v3_enterprise_organizations__org_id__code_scans__scan_id__findings__finding_id__patch", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "scan_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Scan Id" } }, { "name": "finding_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Finding Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodeScanFindingStatusUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodeScanFindingStatusResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/organizations/{org_id}/code-scans/{scan_id}/findings": { "patch": { "tags": [ "code-scans" ], "summary": "Update Code Scan Findings Status", "description": "Update the status of several findings at once, applying the same\ndismissal or resolution note to each, without stopping sessions or\nmodifying PRs. Select findings by ``finding_ids`` (``404`` if any is not\npart of the scan, in which case none is updated) or by ``select_all``\nfilters, resolved server-side.", "operationId": "handle_update_code_scan_findings_status_v3_enterprise_organizations__org_id__code_scans__scan_id__findings_patch", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "scan_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Scan Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodeScanFindingsStatusUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodeScanFindingsStatusResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/organizations/{org_id}/code-scans": { "post": { "tags": [ "code-scans" ], "summary": "Start Code Scan", "description": "Start a new code scan on a repository in an organization.\n\nThe scan is enqueued and launched asynchronously by the scan dispatcher.\nThe scan is attributed to the calling principal (the service user or PAT\nthat made the request). Returns ``409`` when the organization's scan\nbacklog is at capacity.", "operationId": "handle_start_code_scan_v3_enterprise_organizations__org_id__code_scans_post", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodeScanCreateRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodeScanResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/snapshot-setup/blueprints": { "get": { "tags": [ "snapshot_setup" ], "summary": "List enterprise-tier blueprints", "operationId": "list_enterprise_blueprints_v3_enterprise_snapshot_setup_blueprints_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlueprintList" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "post": { "tags": [ "snapshot_setup" ], "summary": "Create the enterprise-tier blueprint", "description": "Create the single enterprise-tier blueprint.\n\nReturns 409 if a blueprint already exists for this enterprise.", "operationId": "create_enterprise_blueprint_endpoint_v3_enterprise_snapshot_setup_blueprints_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateEnterpriseBlueprintBody" } } }, "required": true }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Blueprint" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/snapshot-setup/blueprints/{blueprint_id}": { "get": { "tags": [ "snapshot_setup" ], "summary": "Get the enterprise blueprint", "operationId": "get_enterprise_blueprint_endpoint_v3_enterprise_snapshot_setup_blueprints__blueprint_id__get", "parameters": [ { "name": "blueprint_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Blueprint Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Blueprint" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "put": { "tags": [ "snapshot_setup" ], "summary": "Replace the enterprise blueprint's YAML contents", "operationId": "update_enterprise_blueprint_endpoint_v3_enterprise_snapshot_setup_blueprints__blueprint_id__put", "parameters": [ { "name": "blueprint_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Blueprint Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateBlueprintContentsBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Blueprint" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "delete": { "tags": [ "snapshot_setup" ], "summary": "Delete the enterprise blueprint (soft-delete)", "operationId": "delete_enterprise_blueprint_endpoint_v3_enterprise_snapshot_setup_blueprints__blueprint_id__delete", "parameters": [ { "name": "blueprint_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Blueprint Id" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/snapshot-setup/blueprints/{blueprint_id}/contents": { "get": { "tags": [ "snapshot_setup" ], "summary": "Presigned URL for the enterprise blueprint YAML", "operationId": "get_enterprise_blueprint_contents_v3_enterprise_snapshot_setup_blueprints__blueprint_id__contents_get", "parameters": [ { "name": "blueprint_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Blueprint Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PresignedDownload" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/snapshot-setup/blueprints/{blueprint_id}/files": { "get": { "tags": [ "snapshot_setup" ], "summary": "List enterprise blueprint files", "operationId": "list_enterprise_blueprint_files_v3_enterprise_snapshot_setup_blueprints__blueprint_id__files_get", "parameters": [ { "name": "blueprint_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Blueprint Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlueprintFileList" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "post": { "tags": [ "snapshot_setup" ], "summary": "Upload an enterprise blueprint file", "description": "Upload a file attachment (env-var substitution material) to the blueprint.\n\nReturns 409 if the derived env-var name collides with another active file.", "operationId": "upload_enterprise_blueprint_file_endpoint_v3_enterprise_snapshot_setup_blueprints__blueprint_id__files_post", "parameters": [ { "name": "blueprint_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Blueprint Id" } }, { "name": "name", "in": "query", "required": true, "schema": { "type": "string", "title": "Name" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_upload_enterprise_blueprint_file_endpoint_v3_enterprise_snapshot_setup_blueprints__blueprint_id__files_post" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlueprintFile" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/snapshot-setup/blueprints/{blueprint_id}/files/{file_id}/contents": { "get": { "tags": [ "snapshot_setup" ], "summary": "Presigned URL for an enterprise blueprint file", "operationId": "get_enterprise_blueprint_file_contents_v3_enterprise_snapshot_setup_blueprints__blueprint_id__files__file_id__contents_get", "parameters": [ { "name": "blueprint_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Blueprint Id" } }, { "name": "file_id", "in": "path", "required": true, "schema": { "type": "string", "title": "File Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PresignedDownload" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/snapshot-setup/blueprints/{blueprint_id}/files/{file_id}": { "delete": { "tags": [ "snapshot_setup" ], "summary": "Delete an enterprise blueprint file", "operationId": "delete_enterprise_blueprint_file_v3_enterprise_snapshot_setup_blueprints__blueprint_id__files__file_id__delete", "parameters": [ { "name": "blueprint_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Blueprint Id" } }, { "name": "file_id", "in": "path", "required": true, "schema": { "type": "string", "title": "File Id" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3beta1/enterprise/service-users/{service_user_id}/api-keys": { "post": { "tags": [ "service_user_api_keys" ], "summary": "Create API key for service user", "description": "Create a new API key for a service user.\n\nThe caller must have ManageAccountServiceUsers permission. Returns 409\nwhile static service user keys are disabled for the enterprise, unless the\nservice user backs SCIM or an active Outpost.", "operationId": "handle_create_service_user_api_key_v3beta1_enterprise_service_users__service_user_id__api_keys_post", "parameters": [ { "name": "service_user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Service User Id", "example": "service-user-abc123def456" }, "description": "Service user ID (prefix: service-user-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateApiKeyRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeyWithTokenResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "get": { "tags": [ "service_user_api_keys" ], "summary": "List API keys for service user", "description": "List API keys for a service user, optionally filtered by status.", "operationId": "handle_list_service_user_api_keys_v3beta1_enterprise_service_users__service_user_id__api_keys_get", "parameters": [ { "name": "service_user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Service User Id", "example": "service-user-abc123def456" }, "description": "Service user ID (prefix: service-user-)" }, { "name": "status", "in": "query", "required": false, "schema": { "enum": [ "active", "revoked", "expired", "all" ], "type": "string", "default": "all", "title": "Status" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_ApiKeyResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3beta1/enterprise/service-users/{service_user_id}/api-keys/{api_key_id}": { "delete": { "tags": [ "service_user_api_keys" ], "summary": "Revoke API key for service user", "description": "Revoke an API key for a service user.\n\nReturns 404 if the key is not found, 409 if already revoked.", "operationId": "handle_revoke_service_user_api_key_v3beta1_enterprise_service_users__service_user_id__api_keys__api_key_id__delete", "parameters": [ { "name": "service_user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Service User Id", "example": "service-user-abc123def456" }, "description": "Service user ID (prefix: service-user-)" }, { "name": "api_key_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Api Key Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeyResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3beta1/enterprise/service-users/{service_user_id}/api-keys/{api_key_id}/rotate": { "post": { "tags": [ "service_user_api_keys" ], "summary": "Rotate API key for service user", "description": "Rotate an API key for a service user.\n\nCreates a new key. By default revokes the old key; set revoke_current=false\nfor graceful rollover where both keys remain active temporarily.\nReturns 404 if the key is not found, 400 if the key is not active, and 409\nwhile static service user keys are disabled for the enterprise, unless the\nservice user backs SCIM or an active Outpost.", "operationId": "handle_rotate_service_user_api_key_v3beta1_enterprise_service_users__service_user_id__api_keys__api_key_id__rotate_post", "parameters": [ { "name": "service_user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Service User Id", "example": "service-user-abc123def456" }, "description": "Service user ID (prefix: service-user-)" }, { "name": "api_key_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Api Key Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RotateApiKeyRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeyWithTokenResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3beta1/enterprise/guardrail-violations": { "get": { "tags": [ "guardrail_violations" ], "summary": "List Guardrail Violations", "description": "List guardrail violations across the enterprise.", "operationId": "handle_get_enterprise_guardrail_violations_v3beta1_enterprise_guardrail_violations_get", "parameters": [ { "name": "order", "in": "query", "required": false, "schema": { "enum": [ "asc", "desc" ], "type": "string", "default": "desc", "title": "Order" } }, { "name": "time_before", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Time Before" } }, { "name": "time_after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Time After" } }, { "name": "after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "After" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } }, { "name": "session_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Session Id" } }, { "name": "guardrail_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Guardrail Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_GuardrailViolationResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3beta1/enterprise/organizations/{org_id}/guardrail-violations": { "get": { "tags": [ "guardrail_violations" ], "summary": "List Organization Guardrail Violations", "description": "List guardrail violations for a specific organization.", "operationId": "handle_get_org_guardrail_violations_v3beta1_enterprise_organizations__org_id__guardrail_violations_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "order", "in": "query", "required": false, "schema": { "enum": [ "asc", "desc" ], "type": "string", "default": "desc", "title": "Order" } }, { "name": "time_before", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Time Before" } }, { "name": "time_after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Time After" } }, { "name": "after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "After" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } }, { "name": "session_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Session Id" } }, { "name": "guardrail_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Guardrail Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_GuardrailViolationResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3beta1/enterprise/security-profiles": { "get": { "tags": [ "security-profiles" ], "summary": "List enterprise security profiles", "description": "List the enterprise's security profiles, shared with every org in the\nenterprise. Each org's own profiles are listed on the org paths.", "operationId": "handle_list_security_profiles_v3beta1_enterprise_security_profiles_get", "parameters": [ { "name": "after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "After" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_EnterpriseSecurityProfileResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "post": { "tags": [ "security-profiles" ], "summary": "Create an enterprise security profile", "description": "Create an enterprise-owned security profile.", "operationId": "handle_create_security_profile_v3beta1_enterprise_security_profiles_post", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityProfileCreateRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnterpriseSecurityProfileResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3beta1/enterprise/security-profiles/{profile_id}": { "get": { "tags": [ "security-profiles" ], "summary": "Get an enterprise security profile", "description": "Get one of the enterprise's security profiles by ID.", "operationId": "handle_get_security_profile_v3beta1_enterprise_security_profiles__profile_id__get", "parameters": [ { "name": "profile_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Profile Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnterpriseSecurityProfileResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "patch": { "tags": [ "security-profiles" ], "summary": "Update an enterprise security profile", "description": "Update an enterprise-owned security profile. Omitted fields are left\nunchanged; explicit null clears net_policy / mcp_config.", "operationId": "handle_update_security_profile_v3beta1_enterprise_security_profiles__profile_id__patch", "parameters": [ { "name": "profile_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Profile Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityProfileUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnterpriseSecurityProfileResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "delete": { "tags": [ "security-profiles" ], "summary": "Delete an enterprise security profile", "description": "Delete an enterprise-owned security profile. Fails with 409 while\nbindings (defaults, playbooks, automations, sessions \u2014 including orgs'\nown bindings) still reference it; the 409 detail lists the referencing\nresource types.", "operationId": "handle_delete_security_profile_v3beta1_enterprise_security_profiles__profile_id__delete", "parameters": [ { "name": "profile_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Profile Id" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3beta1/enterprise/security-profile-settings": { "get": { "tags": [ "security-profiles" ], "summary": "Get enterprise security profile settings", "description": "Get the enterprise's default security-profile selection.", "operationId": "handle_get_security_profile_settings_v3beta1_enterprise_security_profile_settings_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnterpriseSecurityProfileSettingsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "patch": { "tags": [ "security-profiles" ], "summary": "Update enterprise security profile settings", "description": "Update the enterprise's default security-profile selection. Omitted\nfields are left unchanged. Only enterprise-owned profiles may be pinned.", "operationId": "handle_update_security_profile_settings_v3beta1_enterprise_security_profile_settings_patch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnterpriseSecurityProfileSettingsUpdateRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnterpriseSecurityProfileSettingsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/attachments": { "post": { "tags": [ "attachments" ], "summary": "Upload an attachment", "description": "Upload a file attachment that can be used in Devin sessions.", "operationId": "handle_upload_attachment_v3_organizations__org_id__attachments_post", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_handle_upload_attachment_v3_organizations__org_id__attachments_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachmentResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/attachments/{uuid}/{name}": { "get": { "tags": [ "attachments" ], "summary": "Download an attachment", "description": "Download a file attachment.\n\nReturns a 307 redirect: to the IP-enforcing presigned proxy for orgs with an\nIP allowlist, or to a presigned S3 URL otherwise.", "operationId": "handle_download_attachment_v3_organizations__org_id__attachments__uuid___name__get", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string", "title": "Uuid" } }, { "name": "name", "in": "path", "required": true, "schema": { "type": "string", "title": "Name" } }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "307": { "description": "Redirect to the attachment download URL" } } } }, "/v3/organizations/{org_id}/automations": { "get": { "tags": [ "automations" ], "summary": "List automations", "description": "List all automations for the organization, newest first.\n\nSupports `metadata.=` query parameters to filter on\nmetadata labels (exact match; multiple filters AND together).\n\n`agent_types` filters to automations containing at least one action of a\ngiven agent type; repeat the parameter to match any of several types\n(OR). Action payloads live in customer-data storage rather than\nqueryable columns, so this filter scans pages server-side. `total` is\nonly returned when a single unfiltered scan covered the whole result set\n(first page, no further pages, nothing hidden); otherwise it is omitted\nrather than reporting a count that includes automations the API will\nnever return.", "operationId": "handle_list_automations_v3_organizations__org_id__automations_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "After" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } }, { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search" } }, { "name": "creator_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Creator Id" } }, { "name": "enabled", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enabled" } }, { "name": "event_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Event Type" } }, { "name": "agent_types", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "enum": [ "new_session", "long_running", "auto_triage", "remediate_finding", "triage_session", "generic_assistant", "incident_session", "code_scan" ], "type": "string" } }, { "type": "null" } ], "title": "Agent Types" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_AutomationResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "post": { "tags": [ "automations" ], "summary": "Create automation", "description": "Create a new automation with triggers and actions.", "operationId": "handle_create_automation_v3_organizations__org_id__automations_post", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomationCreateRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomationResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/automations/schemas": { "get": { "tags": [ "automations" ], "summary": "Get automation event schemas", "description": "Return all supported trigger event schemas, keyed by source then event name.\n\nEach schema describes the event's payload fields, which operators its\nconditions support, and the valid `replies` verbs, so callers can\nconstruct valid `triggers` for the create and update endpoints.", "operationId": "handle_get_automation_schemas_v3_organizations__org_id__automations_schemas_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "security_profile_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Resolve `default_net_policy` and `security_profile` for a create that sets `security_profile.profile_id` to this profile. Requires the security-profile management permission.", "title": "Security Profile Id" }, "description": "Resolve `default_net_policy` and `security_profile` for a create that sets `security_profile.profile_id` to this profile. Requires the security-profile management permission." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomationSchemasResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/automations/templates": { "get": { "tags": [ "automations" ], "summary": "List automation templates", "description": "List the built-in automation templates.\n\n`template_id` values are accepted by the create endpoint; when\n`tools.mcp_servers` is omitted at create time, the template's\n`required_mcps` apply.", "operationId": "handle_list_automation_templates_v3_organizations__org_id__automations_templates_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomationTemplatesResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/automations/{automation_id}": { "get": { "tags": [ "automations" ], "summary": "Get automation", "description": "Get a single automation by ID.", "operationId": "handle_get_automation_v3_organizations__org_id__automations__automation_id__get", "parameters": [ { "name": "automation_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Automation Id" } }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomationResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "patch": { "tags": [ "automations" ], "summary": "Update automation", "description": "Update an automation.\n\nPresent groups merge member-wise by default (RFC 7396): omitted members\nkeep their stored value and explicit nulls clear them. List membership\nreplaces wholesale, and each sent element merges onto the stored element\nof the same type when that type occurs exactly once on both sides.", "operationId": "handle_update_automation_v3_organizations__org_id__automations__automation_id__patch", "parameters": [ { "name": "automation_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Automation Id" } }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomationUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomationResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "delete": { "tags": [ "automations" ], "summary": "Delete automation", "description": "Soft delete an automation and return the deleted automation.", "operationId": "handle_delete_automation_v3_organizations__org_id__automations__automation_id__delete", "parameters": [ { "name": "automation_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Automation Id" } }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomationResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/knowledge/notes": { "get": { "tags": [ "notes" ], "summary": "List org-level notes", "description": "List notes for an organization.", "operationId": "handle_list_notes_v3_organizations__org_id__knowledge_notes_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "After" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } }, { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search" } }, { "name": "folder_path", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Folder Path" } }, { "name": "pinned_repo", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pinned Repo" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_KnowledgeNoteResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "post": { "tags": [ "notes" ], "summary": "Create an org-level note", "description": "Create a note for an organization.", "operationId": "handle_create_note_v3_organizations__org_id__knowledge_notes_post", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeNoteCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeNoteResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/knowledge/folders": { "get": { "tags": [ "notes" ], "summary": "Get knowledge folder structure with note counts.", "description": "Return the full folder tree with per-folder note counts.", "operationId": "handle_list_folders_v3_organizations__org_id__knowledge_folders_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderTreeResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/knowledge/notes/{note_id}": { "get": { "tags": [ "notes" ], "summary": "Get an org-level note", "description": "Get a note by ID for an organization.", "operationId": "handle_get_note_v3_organizations__org_id__knowledge_notes__note_id__get", "parameters": [ { "name": "note_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Note Id", "example": "note-abc123def456" }, "description": "Knowledge note ID (prefix: note-)" }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeNoteResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "put": { "tags": [ "notes" ], "summary": "Update an org-level note", "description": "Update a note for an organization.", "operationId": "handle_update_note_v3_organizations__org_id__knowledge_notes__note_id__put", "parameters": [ { "name": "note_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Note Id", "example": "note-abc123def456" }, "description": "Knowledge note ID (prefix: note-)" }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeNoteCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeNoteResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "delete": { "tags": [ "notes" ], "summary": "Delete an org-level note", "description": "Delete a note for an organization.", "operationId": "handle_delete_note_v3_organizations__org_id__knowledge_notes__note_id__delete", "parameters": [ { "name": "note_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Note Id", "example": "note-abc123def456" }, "description": "Knowledge note ID (prefix: note-)" }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeNoteResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/playbooks": { "get": { "tags": [ "playbooks" ], "summary": "List org-level playbooks", "description": "List playbooks for an organization.", "operationId": "handle_list_playbooks_v3_organizations__org_id__playbooks_get", "deprecated": true, "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "After" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } }, { "name": "include_enterprise", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Also return the enterprise-level playbooks shared with this organization (`access_type: enterprise`). They are read-only through the organization API.", "default": false, "title": "Include Enterprise" }, "description": "Also return the enterprise-level playbooks shared with this organization (`access_type: enterprise`). They are read-only through the organization API." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_PlaybookResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "post": { "tags": [ "playbooks" ], "summary": "Create an org-level playbook", "description": "Create a playbook for an organization.", "operationId": "handle_create_playbook_v3_organizations__org_id__playbooks_post", "deprecated": true, "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlaybookCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlaybookResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/playbooks/{playbook_id}": { "get": { "tags": [ "playbooks" ], "summary": "Get an organization- or enterprise-level playbook by ID", "description": "Get a specific organization- or enterprise-level playbook.", "operationId": "handle_get_playbook_v3_organizations__org_id__playbooks__playbook_id__get", "deprecated": true, "parameters": [ { "name": "playbook_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Playbook Id", "example": "playbook-abc123def456" }, "description": "Playbook ID (prefix: playbook-)" }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlaybookResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "put": { "tags": [ "playbooks" ], "summary": "Update an org-level playbook", "description": "Update a playbook for an organization.", "operationId": "handle_update_playbook_v3_organizations__org_id__playbooks__playbook_id__put", "deprecated": true, "parameters": [ { "name": "playbook_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Playbook Id", "example": "playbook-abc123def456" }, "description": "Playbook ID (prefix: playbook-)" }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlaybookCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlaybookResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "delete": { "tags": [ "playbooks" ], "summary": "Delete an org-level playbook", "description": "Delete a playbook for an organization.", "operationId": "handle_delete_playbook_v3_organizations__org_id__playbooks__playbook_id__delete", "deprecated": true, "parameters": [ { "name": "playbook_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Playbook Id", "example": "playbook-abc123def456" }, "description": "Playbook ID (prefix: playbook-)" }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlaybookResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/schedules": { "post": { "tags": [ "schedules" ], "summary": "Create schedule", "description": "Create a new scheduled session.\n\n**Deprecated.** Schedules are superseded by Automations: create an automation with a `schedule:recurring` trigger via `POST /v3/organizations/{org_id}/automations` instead. For organizations migrated to Automations this endpoint returns `403`; existing schedules remain readable, updatable, and deletable.", "operationId": "handle_create_schedule_v3_organizations__org_id__schedules_post", "deprecated": true, "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "get": { "tags": [ "schedules" ], "summary": "List schedules", "description": "List all schedules for the organization.\n\n**Deprecated.** Schedules are superseded by Automations: create an automation with a `schedule:recurring` trigger via `POST /v3/organizations/{org_id}/automations` instead. This endpoint remains available for existing schedules.", "operationId": "handle_list_schedules_v3_organizations__org_id__schedules_get", "deprecated": true, "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 200, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_ScheduleResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/schedules/{schedule_id}": { "get": { "tags": [ "schedules" ], "summary": "Get schedule", "description": "Get a specific schedule by ID.\n\n**Deprecated.** Schedules are superseded by Automations: create an automation with a `schedule:recurring` trigger via `POST /v3/organizations/{org_id}/automations` instead. This endpoint remains available for existing schedules.", "operationId": "handle_get_schedule_v3_organizations__org_id__schedules__schedule_id__get", "deprecated": true, "parameters": [ { "name": "schedule_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Schedule Id", "example": "sched-abc123def456" }, "description": "Schedule ID (prefix: sched-)" }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "patch": { "tags": [ "schedules" ], "summary": "Update schedule", "description": "Update an existing schedule.\n\n**Deprecated.** Schedules are superseded by Automations: create an automation with a `schedule:recurring` trigger via `POST /v3/organizations/{org_id}/automations` instead. This endpoint remains available for existing schedules.", "operationId": "handle_update_schedule_v3_organizations__org_id__schedules__schedule_id__patch", "deprecated": true, "parameters": [ { "name": "schedule_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Schedule Id", "example": "sched-abc123def456" }, "description": "Schedule ID (prefix: sched-)" }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "delete": { "tags": [ "schedules" ], "summary": "Delete schedule", "description": "Soft delete a schedule.\n\n**Deprecated.** Schedules are superseded by Automations: create an automation with a `schedule:recurring` trigger via `POST /v3/organizations/{org_id}/automations` instead. This endpoint remains available for existing schedules.", "operationId": "handle_delete_schedule_v3_organizations__org_id__schedules__schedule_id__delete", "deprecated": true, "parameters": [ { "name": "schedule_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Schedule Id", "example": "sched-abc123def456" }, "description": "Schedule ID (prefix: sched-)" }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/secrets": { "get": { "tags": [ "secrets" ], "summary": "List org-level secrets", "description": "List secrets for an organization.", "operationId": "handle_list_secrets_v3_organizations__org_id__secrets_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "After" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_SecretResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "post": { "tags": [ "secrets" ], "summary": "Create an org-level secret", "description": "Create a secret for an organization.", "operationId": "handle_create_secret_v3_organizations__org_id__secrets_post", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/secrets/{secret_id}": { "delete": { "tags": [ "secrets" ], "summary": "Delete an org-level secret", "description": "Delete a secret for an organization.", "operationId": "handle_delete_secret_v3_organizations__org_id__secrets__secret_id__delete", "parameters": [ { "name": "secret_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Secret Id", "example": "secret-abc123def456" }, "description": "Secret ID (prefix: secret-)" }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/sessions": { "post": { "tags": [ "sessions" ], "summary": "Create Session", "description": "Create a new session", "operationId": "handle_create_session_v3_organizations__org_id__sessions_post", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "devin_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Devin Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "get": { "tags": [ "sessions" ], "summary": "List Sessions", "description": "List sessions.", "operationId": "handle_get_sessions_v3_organizations__org_id__sessions_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "qs", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/SessionsQueryParams" } }, { "name": "devin_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Devin Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_SessionResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/sessions/insights": { "get": { "tags": [ "sessions" ], "summary": "List sessions with insights", "description": "List sessions with detailed insights including message counts,\nsession size classification, and AI-generated analysis.", "operationId": "handle_get_sessions_insights_v3_organizations__org_id__sessions_insights_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "qs", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/SessionsQueryParams" } }, { "name": "devin_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Devin Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_SessionInsightsResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/sessions/{devin_id}": { "get": { "tags": [ "sessions" ], "summary": "Get Session", "description": "Get details of a specific session.", "operationId": "handle_get_session_v3_organizations__org_id__sessions__devin_id__get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "devin_id", "in": "path", "required": true, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Devin Id", "example": "devin-abc123def456" }, "description": "Devin session ID (prefix: devin-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "delete": { "tags": [ "sessions" ], "summary": "Terminate Session", "description": "Terminate session", "operationId": "handle_terminate_session_v3_organizations__org_id__sessions__devin_id__delete", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "devin_id", "in": "path", "required": true, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Devin Id", "example": "devin-abc123def456" }, "description": "Devin session ID (prefix: devin-)" }, { "name": "archive", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to archive the Devin session", "default": false, "title": "Archive" }, "description": "Whether to archive the Devin session" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/sessions/{devin_id}/insights": { "get": { "tags": [ "sessions" ], "summary": "Get session insights", "description": "Get detailed insights for a specific session, including message counts,\nsession size classification, and AI-generated analysis.", "operationId": "handle_get_session_insights_v3_organizations__org_id__sessions__devin_id__insights_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "devin_id", "in": "path", "required": true, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Devin Id", "example": "devin-abc123def456" }, "description": "Devin session ID (prefix: devin-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionInsightsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/sessions/{devin_id}/insights/generate": { "post": { "tags": [ "sessions" ], "summary": "Generate session insights", "description": "Trigger on-demand generation of session insights.\n\nReturns ``already_exists`` if insights have already been generated.\nOtherwise kicks off generation in the background. Poll the\nGET insights endpoint to retrieve results once generation completes.", "operationId": "handle_generate_session_insights_v3_organizations__org_id__sessions__devin_id__insights_generate_post", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "devin_id", "in": "path", "required": true, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Devin Id", "example": "devin-abc123def456" }, "description": "Devin session ID (prefix: devin-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionInsightsGenerateResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/sessions/{devin_id}/sleep": { "post": { "tags": [ "sessions" ], "summary": "Sleep Session", "description": "Request that a session suspend.", "operationId": "handle_sleep_session_v3_organizations__org_id__sessions__devin_id__sleep_post", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "devin_id", "in": "path", "required": true, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Devin Id", "example": "devin-abc123def456" }, "description": "Devin session ID (prefix: devin-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/sessions/{devin_id}/archive": { "post": { "tags": [ "sessions" ], "summary": "Archive Session", "description": "Archive session and put it to sleep if currently running", "operationId": "handle_archive_session_v3_organizations__org_id__sessions__devin_id__archive_post", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "devin_id", "in": "path", "required": true, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Devin Id", "example": "devin-abc123def456" }, "description": "Devin session ID (prefix: devin-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/sessions/{devin_id}/unarchive": { "post": { "tags": [ "sessions" ], "summary": "Unarchive Session", "description": "Unarchive session (does not cascade to child sessions)", "operationId": "handle_unarchive_session_v3_organizations__org_id__sessions__devin_id__unarchive_post", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "devin_id", "in": "path", "required": true, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Devin Id", "example": "devin-abc123def456" }, "description": "Devin session ID (prefix: devin-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/sessions/{devin_id}/attachments": { "get": { "tags": [ "sessions" ], "summary": "List session attachments", "description": "List all attachments for a session.", "operationId": "handle_get_session_attachments_v3_organizations__org_id__sessions__devin_id__attachments_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "devin_id", "in": "path", "required": true, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Devin Id", "example": "devin-abc123def456" }, "description": "Devin session ID (prefix: devin-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SessionAttachment" }, "title": "Response Handle Get Session Attachments V3 Organizations Org Id Sessions Devin Id Attachments Get" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/sessions/{devin_id}/tags": { "get": { "tags": [ "sessions" ], "summary": "Get session tags", "description": "Get the tags for a specific session.", "operationId": "handle_get_session_tags_v3_organizations__org_id__sessions__devin_id__tags_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "devin_id", "in": "path", "required": true, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Devin Id", "example": "devin-abc123def456" }, "description": "Devin session ID (prefix: devin-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionTagsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "put": { "tags": [ "sessions" ], "summary": "Replace session tags", "description": "Replace all tags on a session.", "operationId": "handle_replace_session_tags_v3_organizations__org_id__sessions__devin_id__tags_put", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "devin_id", "in": "path", "required": true, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Devin Id", "example": "devin-abc123def456" }, "description": "Devin session ID (prefix: devin-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionTagsUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionTagsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "post": { "tags": [ "sessions" ], "summary": "Append session tags", "description": "Append tags to a session (deduplicating with existing tags).", "operationId": "handle_append_session_tags_v3_organizations__org_id__sessions__devin_id__tags_post", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "devin_id", "in": "path", "required": true, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Devin Id", "example": "devin-abc123def456" }, "description": "Devin session ID (prefix: devin-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionTagsUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionTagsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/sessions/{devin_id}/messages": { "get": { "tags": [ "sessions" ], "summary": "List session messages", "description": "List all messages for a session with cursor-based pagination, ordered chronologically.", "operationId": "handle_get_session_messages_v3_organizations__org_id__sessions__devin_id__messages_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "devin_id", "in": "path", "required": true, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Devin Id", "example": "devin-abc123def456" }, "description": "Devin session ID (prefix: devin-)" }, { "name": "after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "After" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_SessionMessage_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "post": { "tags": [ "sessions" ], "summary": "Send a message to a session", "description": "Send a message to an active session. The session will be automatically resumed if suspended.", "operationId": "handle_post_message_v3_organizations__org_id__sessions__devin_id__messages_post", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "devin_id", "in": "path", "required": true, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Devin Id", "example": "devin-abc123def456" }, "description": "Devin session ID (prefix: devin-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionMessageCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/metrics/usage": { "get": { "tags": [ "metrics" ], "summary": "Get Usage Metrics", "description": "Get aggregated usage metrics for the organization.", "operationId": "handle_get_usage_metrics_v3_organizations__org_id__metrics_usage_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "time_before", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Time Before" } }, { "name": "time_after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Time After" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageMetrics" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/metrics/sessions": { "get": { "tags": [ "metrics" ], "summary": "Get Session Metrics", "description": "Get aggregated session metrics for the organization.", "operationId": "handle_get_session_metrics_v3_organizations__org_id__metrics_sessions_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "user_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "User Ids" } }, { "name": "service_user_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Service User Ids" } }, { "name": "time_before", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time Before" } }, { "name": "time_after", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time After" } }, { "name": "playbook_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Playbook Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionMetricsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/metrics/searches": { "get": { "tags": [ "metrics" ], "summary": "Get Search Metrics", "description": "Get aggregated search metrics for the organization.", "operationId": "handle_get_search_metrics_v3_organizations__org_id__metrics_searches_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "time_before", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time Before" } }, { "name": "time_after", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time After" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchMetricsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/metrics/prs": { "get": { "tags": [ "metrics" ], "summary": "Get PR Metrics", "description": "Get aggregated PR metrics for the organization.", "operationId": "handle_get_pr_metrics_v3_organizations__org_id__metrics_prs_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "user_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "User Ids" } }, { "name": "service_user_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Service User Ids" } }, { "name": "time_before", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time Before" } }, { "name": "time_after", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time After" } }, { "name": "playbook_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Playbook Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrMetricsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/metrics/dau": { "get": { "tags": [ "metrics" ], "summary": "Get Daily Active Users", "description": "Get daily active users for each day in the specified time range.", "operationId": "handle_get_dau_metrics_v3_organizations__org_id__metrics_dau_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "time_before", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time Before" } }, { "name": "time_after", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time After" } }, { "name": "min_sessions", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 1, "title": "Min Sessions" } }, { "name": "min_searches", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 1, "title": "Min Searches" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActiveUserMetricsListResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/metrics/wau": { "get": { "tags": [ "metrics" ], "summary": "Get Weekly Active Users", "description": "Get weekly active users for each week in the specified time range.", "operationId": "handle_get_wau_metrics_v3_organizations__org_id__metrics_wau_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "time_before", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time Before" } }, { "name": "time_after", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time After" } }, { "name": "min_sessions", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 1, "title": "Min Sessions" } }, { "name": "min_searches", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 1, "title": "Min Searches" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActiveUserMetricsListResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/metrics/mau": { "get": { "tags": [ "metrics" ], "summary": "Get Monthly Active Users", "description": "Get monthly active users for each month in the specified time range.", "operationId": "handle_get_mau_metrics_v3_organizations__org_id__metrics_mau_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "time_before", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time Before" } }, { "name": "time_after", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time After" } }, { "name": "min_sessions", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 1, "title": "Min Sessions" } }, { "name": "min_searches", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 1, "title": "Min Searches" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActiveUserMetricsListResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/metrics/active-users": { "get": { "tags": [ "metrics" ], "summary": "Get Active Users for Custom Date Range", "description": "Get unique active users for a custom date range.", "operationId": "handle_get_active_users_metrics_v3_organizations__org_id__metrics_active_users_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "time_before", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time Before" } }, { "name": "time_after", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time After" } }, { "name": "min_sessions", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 1, "title": "Min Sessions" } }, { "name": "min_searches", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 1, "title": "Min Searches" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActiveUserMetricsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/consumption/daily": { "get": { "tags": [ "consumption" ], "summary": "Get Daily Consumption", "description": "Get daily ACU consumption for the organization.\n\n**Timezone behavior**: Billing cycles use midnight PST (Pacific Standard Time)\nas the day boundary, which corresponds to 08:00:00 UTC.", "operationId": "handle_get_consumption_daily_v3_organizations__org_id__consumption_daily_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "time_before", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Time Before" } }, { "name": "time_after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Time After" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsumptionResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/consumption/daily/users/{user_id}": { "get": { "tags": [ "consumption" ], "summary": "Get User Daily Consumption", "description": "Get daily ACU consumption for a specific user within the organization.\n\n**Timezone behavior**: Billing cycles use midnight PST (Pacific Standard Time)\nas the day boundary, which corresponds to 08:00:00 UTC.", "operationId": "handle_get_user_consumption_daily_v3_organizations__org_id__consumption_daily_users__user_id__get", "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "User Id" }, "description": "User ID" }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "time_before", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Time Before" } }, { "name": "time_after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Time After" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsumptionResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/consumption/daily/service-users/{service_user_id}": { "get": { "tags": [ "consumption" ], "summary": "Get Service User Daily Consumption", "description": "Get daily ACU consumption for a specific service user within the organization.\n\n**Timezone behavior**: Billing cycles use midnight PST (Pacific Standard Time)\nas the day boundary, which corresponds to 08:00:00 UTC.", "operationId": "handle_get_service_user_consumption_daily_v3_organizations__org_id__consumption_daily_service_users__service_user_id__get", "parameters": [ { "name": "service_user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Service User Id", "example": "service-user-abc123def456" }, "description": "Service user ID (prefix: service-user-)" }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "time_before", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Time Before" } }, { "name": "time_after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Time After" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsumptionResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/consumption/daily/sessions/{session_id}": { "get": { "tags": [ "consumption" ], "summary": "Get Session Daily Consumption", "description": "Get daily ACU consumption for a specific session within the organization.\n\n**Timezone behavior**: Billing cycles use midnight PST (Pacific Standard Time)\nas the day boundary, which corresponds to 08:00:00 UTC.", "operationId": "handle_get_session_consumption_daily_v3_organizations__org_id__consumption_daily_sessions__session_id__get", "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Session Id", "example": "devin-abc123def456" }, "description": "Session ID (prefix: devin-). Alias for devin_id used in consumption endpoints." }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "time_before", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Time Before" } }, { "name": "time_after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Time After" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsumptionResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/pr-reviews": { "post": { "tags": [ "pr-reviews" ], "summary": "Trigger Devin Review", "description": "Trigger a Devin Review for a pull/merge request.\n\nCreates a database record that will be picked up by the review\nworker pool. Always fetches the latest commit from the PR.", "operationId": "handle_create_pr_review_v3_organizations__org_id__pr_reviews_post", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrReviewCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrReviewResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "get": { "tags": [ "pr-reviews" ], "summary": "Get latest Devin Review status", "description": "Return the latest Devin Review for a PR scoped to the organization.\n\nWhen ``commit_sha`` is omitted, the PR's current head commit is\nfetched from the provider and used. Returns ``404`` when no review\nexists for the resolved commit.", "operationId": "handle_get_pr_review_status_v3_organizations__org_id__pr_reviews_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "pr_url", "in": "query", "required": true, "schema": { "type": "string", "description": "Full URL of the pull/merge request to look up (e.g. `https://github.com/owner/repo/pull/123`).", "examples": [ "https://github.com/owner/repo/pull/123" ], "title": "Pr Url" }, "description": "Full URL of the pull/merge request to look up (e.g. `https://github.com/owner/repo/pull/123`)." }, { "name": "commit_sha", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Commit SHA to look up (full or short prefix). Defaults to the PR's current head commit when omitted.", "examples": [ "abc123def4567890abc123def4567890abc123de" ], "title": "Commit Sha" }, "description": "Commit SHA to look up (full or short prefix). Defaults to the PR's current head commit when omitted." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrReviewResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/code-scans/metrics": { "get": { "tags": [ "code-scans" ], "summary": "Get Code Scan Metrics", "description": "Get aggregated code scan metrics for the organization.\n\nReturns scan, finding, and remediation-PR metrics for code scans created\nwithin the specified time range.", "operationId": "handle_get_code_scan_metrics_v3_organizations__org_id__code_scans_metrics_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "time_before", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time Before" } }, { "name": "time_after", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time After" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodeScanMetricsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/code-scans/scans": { "get": { "tags": [ "code-scans" ], "summary": "List Code Scans", "description": "List code scans for the organization.\n\nScans are returned newest first. Optionally filter by ``repo_name`` and\ncreation time (``time_after`` / ``time_before``); results are paginated\nwith an opaque cursor (``after`` / ``first``).", "operationId": "handle_list_code_scans_v3_organizations__org_id__code_scans_scans_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "time_before", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Time Before" } }, { "name": "time_after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Time After" } }, { "name": "after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "After" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } }, { "name": "scan_type", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "security", "performance", "db-queries", "test-coverage", "dead-code", "code-quality", "cleanup", "telemetry", "accessibility", "compliance", "general", "migration-docs", "red-team" ], "type": "string" }, { "type": "null" } ], "description": "Filter to scans of this scan type.", "title": "Scan Type" }, "description": "Filter to scans of this scan type." }, { "name": "repo_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Filter to scans that scanned this repository. Matches multi-repo scans even when the repository is not the scan's primary repo, so returned items may report a different repo_name.", "title": "Repo Name" }, "description": "Filter to scans that scanned this repository. Matches multi-repo scans even when the repository is not the scan's primary repo, so returned items may report a different repo_name." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_CodeScanResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/code-scans/findings": { "get": { "tags": [ "code-scans" ], "summary": "List Code Scan Findings", "description": "List code scan findings for the organization.\n\nFindings are returned newest first. Optionally filter by ``scan_id``,\n``repo_name``, ``severity``, ``status``, ``payoff``, and created/updated\ntimestamp bounds (``created_after``/``created_before``,\n``updated_after``/``updated_before``). Results are paginated with an opaque\ncursor (``after`` / ``first``).", "operationId": "handle_list_code_scan_findings_v3_organizations__org_id__code_scans_findings_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "After" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } }, { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ], "description": "Text search over finding title, description, and file path. Combines with other filters such as repo_name. Blank means no search. Returns 503 when search is unavailable for an organization.", "title": "Q" }, "description": "Text search over finding title, description, and file path. Combines with other filters such as repo_name. Blank means no search. Returns 503 when search is unavailable for an organization." }, { "name": "scan_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Filter to findings produced by this scan.", "title": "Scan Id" }, "description": "Filter to findings produced by this scan." }, { "name": "repo_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Filter to findings reported in this repository.", "title": "Repo Name" }, "description": "Filter to findings reported in this repository." }, { "name": "severity", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "enum": [ "critical", "high", "medium", "low" ], "type": "string" } }, { "type": "null" } ], "description": "Filter to findings with any of these severities (critical, high, medium, low).", "title": "Severity" }, "description": "Filter to findings with any of these severities (critical, high, medium, low)." }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "enum": [ "open", "dismissed", "resolved" ], "type": "string" } }, { "type": "null" } ], "description": "Filter to findings with any of these statuses (open, dismissed, resolved).", "title": "Status" }, "description": "Filter to findings with any of these statuses (open, dismissed, resolved)." }, { "name": "payoff", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "enum": [ "quick_win", "big_fix", "easy_fix", "deprioritize" ], "type": "string" }, "maxItems": 4 }, { "type": "null" } ], "description": "Filter to findings in any of these payoff quadrants (quick_win, big_fix, easy_fix, deprioritize). Unrated findings (null fix_effort) never match.", "title": "Payoff" }, "description": "Filter to findings in any of these payoff quadrants (quick_win, big_fix, easy_fix, deprioritize). Unrated findings (null fix_effort) never match." }, { "name": "created_after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Findings created at or after this unix timestamp (seconds).", "title": "Created After" }, "description": "Findings created at or after this unix timestamp (seconds)." }, { "name": "created_before", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Findings created at or before this unix timestamp (seconds).", "title": "Created Before" }, "description": "Findings created at or before this unix timestamp (seconds)." }, { "name": "updated_after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Findings updated at or after this unix timestamp (seconds).", "title": "Updated After" }, "description": "Findings updated at or after this unix timestamp (seconds)." }, { "name": "updated_before", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Findings updated at or before this unix timestamp (seconds).", "title": "Updated Before" }, "description": "Findings updated at or before this unix timestamp (seconds)." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_CodeScanFindingResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/code-scans/profiles": { "get": { "tags": [ "code-scans" ], "summary": "List Code Scan Profiles", "description": "List code scan profiles for the organization.\n\nReturns profile summaries (without guidance) newest first, including both\norg-owned and account-shared profiles. Results are paginated with an\nopaque cursor (``after`` / ``first``).", "operationId": "handle_list_code_scan_profiles_v3_organizations__org_id__code_scans_profiles_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "After" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_CodeScanProfileSummaryResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/code-scans/profiles/{profile_id}": { "get": { "tags": [ "code-scans" ], "summary": "Get Code Scan Profile", "description": "Get a code scan profile by ID.\n\nReturns the profile's metadata, visibility (org-owned or shared\naccount-wide), and all of its guidance fields. Returns ``404`` when the\nprofile does not exist or is not visible to the organization.", "operationId": "handle_get_code_scan_profile_v3_organizations__org_id__code_scans_profiles__profile_id__get", "parameters": [ { "name": "profile_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Profile Id" } }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodeScanProfileDetailResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/code-scans/{scan_id}": { "get": { "tags": [ "code-scans" ], "summary": "Get Code Scan", "description": "Get a single code scan, including the files attached to it.\n\nReturns ``404`` when the scan is not in the organization.", "operationId": "handle_get_code_scan_v3_organizations__org_id__code_scans__scan_id__get", "parameters": [ { "name": "scan_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Scan Id" } }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodeScanResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/code-scans/{scan_id}/profile": { "put": { "tags": [ "code-scans" ], "summary": "Switch Code Scan Profile", "description": "Switch the profile applied to future incremental runs of a scan.\n\nIncremental re-scans pick up their profile through the scan's profile\nlink, so repointing the link changes the profile used from the next run\nonward. Completed runs and their findings are unaffected. The new\nprofile must have the same scan type and mode as the current one, and\nthe scan must not have an active run (``409`` otherwise).", "operationId": "handle_switch_code_scan_profile_v3_organizations__org_id__code_scans__scan_id__profile_put", "parameters": [ { "name": "scan_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Scan Id" } }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodeScanProfileSwitchRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodeScanProfileSwitchResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/code-scans/{scan_id}/effort": { "put": { "tags": [ "code-scans" ], "summary": "Update Code Scan Effort", "description": "Set the effort applied to future incremental runs of a scan.\n\nCompleted runs and their findings are unaffected. The scan must not\nhave an active run (``409`` otherwise).", "operationId": "handle_update_code_scan_effort_v3_organizations__org_id__code_scans__scan_id__effort_put", "parameters": [ { "name": "scan_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Scan Id" } }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodeScanEffortUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodeScanEffortResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/code-scans/{scan_id}/scan-new-commits": { "post": { "tags": [ "code-scans" ], "summary": "Scan New Commits", "description": "Immediately trigger an incremental (diff) scan of new commits.\n\nRe-runs the scan against only the commits landed since it last completed.\nThis is the one-off, on-demand form of the auto-scan schedule. Returns\n``409`` if the scan has no completed run to extend or is already in\nprogress.", "operationId": "handle_scan_new_commits_v3_organizations__org_id__code_scans__scan_id__scan_new_commits_post", "parameters": [ { "name": "scan_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Scan Id" } }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScanNewCommitsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/code-scans/{scan_id}/cancel": { "post": { "tags": [ "code-scans" ], "summary": "Cancel Code Scan", "description": "Cancel an in-flight scan and stop its session and support sessions.\n\nKeeps the scan, findings so far, and auto-scan schedule. Returns 404 for\nmissing or archived scans, and 409 for a non-cancellable scan.", "operationId": "handle_cancel_code_scan_v3_organizations__org_id__code_scans__scan_id__cancel_post", "parameters": [ { "name": "scan_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Scan Id" } }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelCodeScanResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/code-scans/{scan_id}/recover": { "post": { "tags": [ "code-scans" ], "summary": "Recover Code Scan", "description": "Recover a scan that failed because its session stopped.\n\nSends the scan's existing session a message to continue, resuming it if\nsuspended, and sets the scan back to ``running``. Returns ``409`` if the\nscan is not ``failed`` or its session has ended; scan new commits instead.", "operationId": "handle_recover_code_scan_v3_organizations__org_id__code_scans__scan_id__recover_post", "parameters": [ { "name": "scan_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Scan Id" } }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecoverCodeScanResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/code-scans/{scan_id}/findings/{finding_id}/remediate": { "post": { "tags": [ "code-scans" ], "summary": "Remediate Code Scan Finding", "description": "Launch a Devin session to remediate a code scan finding.\n\nThe session analyzes the vulnerable code, implements a fix, and opens a\npull request. The session is attributed to the calling principal (the\nservice user or PAT that made the request). Returns ``409`` if the finding\nalready has a remediation session.", "operationId": "handle_remediate_code_scan_finding_v3_organizations__org_id__code_scans__scan_id__findings__finding_id__remediate_post", "parameters": [ { "name": "scan_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Scan Id" } }, { "name": "finding_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Finding Id" } }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/V3RemediateFindingRequest" }, { "type": "null" } ], "title": "Body" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemediateFindingResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/code-scans/{scan_id}/findings/remediate": { "post": { "tags": [ "code-scans" ], "summary": "Remediate Code Scan Findings", "description": "Launch one Devin session to remediate several findings of a code scan.\n\nA batch of two or more findings (which may span repositories) gets a\nplanner session that groups them and launches a fix session per group,\neach on its own branch with its own pull request. A single finding gets a\nfix session directly. The session is attributed to the calling principal.\nReturns ``409`` if any finding already has a remediation session, in which\ncase none of them is claimed.\n\nInstead of ``finding_ids``, ``select_all`` remediates every open finding\nmatching its filters that is not already being remediated.", "operationId": "handle_remediate_code_scan_findings_v3_organizations__org_id__code_scans__scan_id__findings_remediate_post", "parameters": [ { "name": "scan_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Scan Id" } }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemediateFindingsRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemediateFindingsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/code-scans/ingestion": { "post": { "tags": [ "code-scans" ], "summary": "Start Ingestion Scan", "description": "Start an ingestion-mode code scan on one or more repositories in the organization.\n\nThe scan is enqueued and launched asynchronously by the scan dispatcher.\nOnly ingest-mode profiles are accepted; a non-ingest profile is rejected\nwith ``400``. Optional attachment URLs (uploaded via the attachments API)\nare provided to the scan. Returns ``409`` when the organization's scan\nbacklog is at capacity.", "operationId": "handle_start_ingestion_scan_v3_organizations__org_id__code_scans_ingestion_post", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartIngestionScanRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodeScanResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/code-scans/{scan_id}/auto-scan": { "post": { "tags": [ "code-scans" ], "summary": "Create Auto-Scan Schedule", "description": "Create the recurring auto-scan schedule for a code scan.\n\nAuto-scan is backed by an automation with a ``schedule:recurring`` trigger\n(carrying the rrule) and a ``scan_new_commits`` action targeting this\nscan; when the schedule fires, commits landed since the last scan are\nscanned. Create-only: returns ``409`` if the scan already has a schedule\n(delete it first to change it).", "operationId": "handle_create_auto_scan_schedule_v3_organizations__org_id__code_scans__scan_id__auto_scan_post", "parameters": [ { "name": "scan_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Scan Id" } }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutoScanScheduleCreateRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutoScanScheduleResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "delete": { "tags": [ "code-scans" ], "summary": "Delete Auto-Scan Schedule", "description": "Remove the recurring auto-scan schedule for a code scan.\n\nDeletes the underlying schedule automation. Idempotent: returns ``204``\neven when no schedule is configured.", "operationId": "handle_delete_auto_scan_schedule_v3_organizations__org_id__code_scans__scan_id__auto_scan_delete", "parameters": [ { "name": "scan_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Scan Id" } }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "204": { "description": "Successful Response" }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/code-scans/{scan_id}/findings/{finding_id}": { "patch": { "tags": [ "code-scans" ], "summary": "Update Code Scan Finding Status", "description": "Update a finding's status without stopping sessions or modifying PRs.", "operationId": "handle_update_code_scan_finding_status_v3_organizations__org_id__code_scans__scan_id__findings__finding_id__patch", "parameters": [ { "name": "scan_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Scan Id" } }, { "name": "finding_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Finding Id" } }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodeScanFindingStatusUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodeScanFindingStatusResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/code-scans/{scan_id}/findings": { "patch": { "tags": [ "code-scans" ], "summary": "Update Code Scan Findings Status", "description": "Update the status of several findings at once, applying the same\ndismissal or resolution note to each, without stopping sessions or\nmodifying PRs. Select findings by ``finding_ids`` (``404`` if any is not\npart of the scan, in which case none is updated) or by ``select_all``\nfilters, resolved server-side.", "operationId": "handle_update_code_scan_findings_status_v3_organizations__org_id__code_scans__scan_id__findings_patch", "parameters": [ { "name": "scan_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Scan Id" } }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodeScanFindingsStatusUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodeScanFindingsStatusResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/code-scans/{scan_id}/findings/{finding_id}/unlink-session": { "post": { "tags": [ "code-scans" ], "summary": "Unlink Code Scan Finding Session", "description": "Detach a finding from its remediation session so it can be remediated\nagain. The session is not stopped.", "operationId": "handle_unlink_code_scan_finding_session_v3_organizations__org_id__code_scans__scan_id__findings__finding_id__unlink_session_post", "parameters": [ { "name": "scan_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Scan Id" } }, { "name": "finding_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Finding Id" } }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "204": { "description": "Successful Response" }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/code-scans/{scan_id}/findings/unlink-session": { "post": { "tags": [ "code-scans" ], "summary": "Unlink Code Scan Findings Session", "description": "Detach several findings from their remediation sessions so they can be\nremediated again. The sessions are not stopped.", "operationId": "handle_unlink_code_scan_findings_session_v3_organizations__org_id__code_scans__scan_id__findings_unlink_session_post", "parameters": [ { "name": "scan_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Scan Id" } }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnlinkFindingsSessionRequest" } } } }, "responses": { "204": { "description": "Successful Response" }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/code-scans": { "post": { "tags": [ "code-scans" ], "summary": "Start Code Scan", "description": "Start a new code scan on a repository in the organization.\n\nThe scan is enqueued and launched asynchronously by the scan dispatcher.\nThe scan is attributed to the calling principal (the service user or PAT\nthat made the request). Returns ``409`` when the organization's scan\nbacklog is at capacity.", "operationId": "handle_start_code_scan_v3_organizations__org_id__code_scans_post", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrgCodeScanCreateRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodeScanResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/oncall/schemas": { "get": { "tags": [ "oncall" ], "summary": "Get Oncall trigger schemas and defaults", "description": "Trigger event schemas responders accept, plus the defaults the create\nendpoints apply (network policy, Devin mode, runbook) and whether the org\nhas Slack connected (a precondition for responders and incidents).", "operationId": "handle_get_oncall_schemas_v3_organizations__org_id__oncall_schemas_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OncallSchemasResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/oncall/responders": { "get": { "tags": [ "oncall" ], "summary": "List Oncall responders", "description": "List the org's Oncall responders.", "operationId": "handle_list_responders_v3_organizations__org_id__oncall_responders_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "After" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_OncallResponderResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "post": { "tags": [ "oncall" ], "summary": "Create Oncall responder", "description": "Create an Oncall responder (a triage_session automation).\n\n``triggers`` holds up to 10 OR'd triggers from one provider; every Slack\ncondition group needs a channel restriction or at least one filter. Omitted ``runbook`` uses the server\ndefault, omitted ``session_settings.net_policy`` the deployment default\npolicy, omitted ``tools.slack_channels`` a grant for the watched channels\n(or All public channels when any group has no channel restriction),\nand ``run_as`` defaults to ``organization``.", "operationId": "handle_create_responder_v3_organizations__org_id__oncall_responders_post", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OncallResponderCreateRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OncallResponderResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/oncall/responders/{responder_id}": { "get": { "tags": [ "oncall" ], "summary": "Get Oncall responder", "description": "Get a single Oncall responder.", "operationId": "handle_get_responder_v3_organizations__org_id__oncall_responders__responder_id__get", "parameters": [ { "name": "responder_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Responder Id" } }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OncallResponderResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "patch": { "tags": [ "oncall" ], "summary": "Update Oncall responder", "description": "Update an Oncall responder (merge patch).\n\nOmitted fields and omitted group members keep their stored values;\nexplicit nulls clear (``run_as: null`` resets to organization); the\n``triggers``, ``tools.mcp_servers``, ``tools.slack_channels`` and\n``session.tags`` lists replace wholesale; ``metadata`` merges per key.", "operationId": "handle_update_responder_v3_organizations__org_id__oncall_responders__responder_id__patch", "parameters": [ { "name": "responder_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Responder Id" } }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OncallResponderUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OncallResponderResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "delete": { "tags": [ "oncall" ], "summary": "Delete Oncall responder", "description": "Delete an Oncall responder.", "operationId": "handle_delete_responder_v3_organizations__org_id__oncall_responders__responder_id__delete", "parameters": [ { "name": "responder_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Responder Id" } }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OncallResponderResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/snapshot-setup/blueprints": { "get": { "tags": [ "snapshot_setup" ], "summary": "List org- and repo-tier blueprints", "operationId": "list_org_blueprints_v3_organizations__org_id__snapshot_setup_blueprints_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "repo_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Filter to a specific repository (e.g. 'org/repo').", "title": "Repo Name" }, "description": "Filter to a specific repository (e.g. 'org/repo')." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlueprintList" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "post": { "tags": [ "snapshot_setup" ], "summary": "Create an org- or repo-tier blueprint", "description": "Create a blueprint. ``type`` is inferred from ``repo_name``.\n\n``source`` defaults to ``database``. With ``source='git'`` the YAML\n(and any ``includes``) is read from ``.devin/blueprint.yaml`` on the\nrepo's default branch \u2014 404 when the file is absent, 422 when it is\ninvalid, 502 when the git provider is unreachable.\n\nPer spec, this never auto-triggers a build \u2014 callers must\n``POST /builds`` explicitly.", "operationId": "create_org_blueprint_v3_organizations__org_id__snapshot_setup_blueprints_post", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrgBlueprintBody" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Blueprint" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/snapshot-setup/blueprints/{blueprint_id}": { "get": { "tags": [ "snapshot_setup" ], "summary": "Get a single blueprint", "operationId": "get_org_blueprint_v3_organizations__org_id__snapshot_setup_blueprints__blueprint_id__get", "parameters": [ { "name": "blueprint_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Blueprint Id" } }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Blueprint" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "patch": { "tags": [ "snapshot_setup" ], "summary": "Update a blueprint's contents, position, source and/or commit-build settings", "description": "Partial update for a single blueprint. Does NOT auto-trigger a build.\n\nFields honored:\n\n- ``contents`` \u2014 writes a new YAML version for the blueprint.\n- ``position`` \u2014 sets the repo-tier blueprint's execution position.\n Returns ``400`` on an org-tier blueprint (those have no position).\n- ``source`` \u2014 switches the repo between ``git`` and ``database`` mode.\n Root repo-tier blueprints only. ``{\"source\": \"database\", \"contents\":\n ...}`` detaches with ``contents`` as the new (single) version.\n- ``build_on_default_branch_commit`` / ``report_check_runs`` \u2014 per-repo\n commit builds and their GitHub check runs. Root blueprints of\n github.com repos only.\n\nReturns ``400`` when the body is empty.", "operationId": "update_org_blueprint_v3_organizations__org_id__snapshot_setup_blueprints__blueprint_id__patch", "parameters": [ { "name": "blueprint_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Blueprint Id" } }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateOrgBlueprintBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Blueprint" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "delete": { "tags": [ "snapshot_setup" ], "summary": "Soft-delete a blueprint", "operationId": "delete_org_blueprint_v3_organizations__org_id__snapshot_setup_blueprints__blueprint_id__delete", "parameters": [ { "name": "blueprint_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Blueprint Id" } }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "204": { "description": "Successful Response" }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/snapshot-setup/blueprints/{blueprint_id}/contents": { "get": { "tags": [ "snapshot_setup" ], "summary": "Presigned URL for the blueprint's YAML", "operationId": "get_org_blueprint_contents_v3_organizations__org_id__snapshot_setup_blueprints__blueprint_id__contents_get", "parameters": [ { "name": "blueprint_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Blueprint Id" } }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PresignedDownload" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/snapshot-setup/blueprints/{blueprint_id}/files": { "get": { "tags": [ "snapshot_setup" ], "summary": "List blueprint files", "operationId": "list_org_blueprint_files_v3_organizations__org_id__snapshot_setup_blueprints__blueprint_id__files_get", "parameters": [ { "name": "blueprint_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Blueprint Id" } }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlueprintFileList" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "post": { "tags": [ "snapshot_setup" ], "summary": "Upload a blueprint file", "operationId": "upload_org_blueprint_file_v3_organizations__org_id__snapshot_setup_blueprints__blueprint_id__files_post", "parameters": [ { "name": "blueprint_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Blueprint Id" } }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "name", "in": "query", "required": true, "schema": { "type": "string", "title": "Name" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_upload_org_blueprint_file_v3_organizations__org_id__snapshot_setup_blueprints__blueprint_id__files_post" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlueprintFile" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/snapshot-setup/blueprints/{blueprint_id}/files/{file_id}/contents": { "get": { "tags": [ "snapshot_setup" ], "summary": "Presigned URL for a blueprint file", "operationId": "get_org_blueprint_file_contents_v3_organizations__org_id__snapshot_setup_blueprints__blueprint_id__files__file_id__contents_get", "parameters": [ { "name": "blueprint_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Blueprint Id" } }, { "name": "file_id", "in": "path", "required": true, "schema": { "type": "string", "title": "File Id" } }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PresignedDownload" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/snapshot-setup/blueprints/{blueprint_id}/files/{file_id}": { "delete": { "tags": [ "snapshot_setup" ], "summary": "Delete a blueprint file", "operationId": "delete_org_blueprint_file_v3_organizations__org_id__snapshot_setup_blueprints__blueprint_id__files__file_id__delete", "parameters": [ { "name": "blueprint_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Blueprint Id" } }, { "name": "file_id", "in": "path", "required": true, "schema": { "type": "string", "title": "File Id" } }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "204": { "description": "Successful Response" }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/snapshot-setup/builds": { "post": { "tags": [ "snapshot_setup" ], "summary": "Trigger a manual build", "description": "Manually trigger a snapshot build using the org's current blueprints.", "operationId": "trigger_org_build_v3_organizations__org_id__snapshot_setup_builds_post", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TriggerBuildBody" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Build" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "get": { "tags": [ "snapshot_setup" ], "summary": "List builds for the org", "operationId": "list_org_builds_v3_organizations__org_id__snapshot_setup_builds_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "After" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "pending", "running", "succeeded", "failed", "cancelled" ], "type": "string" }, { "type": "null" } ], "description": "Filter by spec status.", "title": "Status" }, "description": "Filter by spec status." }, { "name": "active", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "If true, returns 0 or 1 items: the build whose image is currently used by new sessions.", "title": "Active" }, "description": "If true, returns 0 or 1 items: the build whose image is currently used by new sessions." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_Build_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/snapshot-setup/builds/{build_id}": { "get": { "tags": [ "snapshot_setup" ], "summary": "Get a single build", "operationId": "get_org_build_v3_organizations__org_id__snapshot_setup_builds__build_id__get", "parameters": [ { "name": "build_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Build Id" } }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Build" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/snapshot-setup/builds/{build_id}/cancel": { "post": { "tags": [ "snapshot_setup" ], "summary": "Cancel an in-flight build", "operationId": "cancel_org_build_v3_organizations__org_id__snapshot_setup_builds__build_id__cancel_post", "parameters": [ { "name": "build_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Build Id" } }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Build" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/snapshot-setup/builds/{build_id}/pin": { "post": { "tags": [ "snapshot_setup" ], "summary": "Pin the org to a specific successful build", "description": "Pin a successful build (less than 7 days old).\n\nTranslates the SDK's 400 errors into 409 (per spec: \"409 if the\nbuild is not succeeded, or older than 7 days\").", "operationId": "pin_org_build_v3_organizations__org_id__snapshot_setup_builds__build_id__pin_post", "parameters": [ { "name": "build_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Build Id" } }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PinBuildBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Build" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "delete": { "tags": [ "snapshot_setup" ], "summary": "Unpin a build (no-op if not pinned)", "description": "Unpin the org if and only if it is currently pinned to ``build_id``.\n\nNo-op (still 204) when the org is not pinned to this build.", "operationId": "unpin_org_build_v3_organizations__org_id__snapshot_setup_builds__build_id__pin_delete", "parameters": [ { "name": "build_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Build Id" } }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "204": { "description": "Successful Response" }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/snapshot-setup/builds/{build_id}/logs": { "get": { "tags": [ "snapshot_setup" ], "summary": "Presigned URL for the build's log file", "operationId": "get_org_build_logs_v3_organizations__org_id__snapshot_setup_builds__build_id__logs_get", "parameters": [ { "name": "build_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Build Id" } }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PresignedDownload" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/repositories": { "get": { "tags": [ "repositories" ], "summary": "List repositories available to an organization", "operationId": "handle_list_repositories_v3_organizations__org_id__repositories_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "After" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 100, "title": "First" } }, { "name": "filter_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filter Name" } }, { "name": "only_repo_paths", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Only Repo Paths" } }, { "name": "exclude_repo_paths", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Exclude Repo Paths" } }, { "name": "provider_repository_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" }, "maxItems": 100 }, { "type": "null" } ], "description": "Only return repositories with these provider repository IDs (the `provider_repository_id` field of each item). Repeat the parameter to pass several IDs.", "title": "Provider Repository Id" }, "description": "Only return repositories with these provider repository IDs (the `provider_repository_id` field of each item). Repeat the parameter to pass several IDs." }, { "name": "load_indexing_status", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Load Indexing Status" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_RepositoryResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/repositories/indexing": { "put": { "tags": [ "repositories" ], "summary": "Bulk index repositories", "description": "Idempotently enables indexing for a batch of repositories and triggers indexing jobs.", "operationId": "handle_bulk_index_repositories_v3_organizations__org_id__repositories_indexing_put", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkIndexRepositoriesRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RepositoryIndexingResponse" }, "title": "Response Handle Bulk Index Repositories V3 Organizations Org Id Repositories Indexing Put" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "delete": { "tags": [ "repositories" ], "summary": "Bulk remove repositories from indexing", "description": "Disables indexing and clears configured branches for a batch of repositories.", "operationId": "handle_bulk_remove_repositories_from_indexing_v3_organizations__org_id__repositories_indexing_delete", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoveRepositoriesRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RepositoryIndexingResponse" }, "title": "Response Handle Bulk Remove Repositories From Indexing V3 Organizations Org Id Repositories Indexing Delete" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "get": { "tags": [ "repositories" ], "summary": "List indexed repositories", "operationId": "handle_list_indexed_repositories_v3_organizations__org_id__repositories_indexing_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "After" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } }, { "name": "filter_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Case-insensitive substring filter on the repository path.", "title": "Filter Name" }, "description": "Case-insensitive substring filter on the repository path." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_RepositoryIndexingResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/repositories/{repository_path}/indexing": { "put": { "tags": [ "repositories" ], "summary": "Index a repository", "description": "Idempotently enables indexing for a single repository and triggers indexing jobs.", "operationId": "handle_index_single_repository_v3_organizations__org_id__repositories__repository_path__indexing_put", "parameters": [ { "name": "repository_path", "in": "path", "required": true, "schema": { "type": "string", "title": "Repository Path" } }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/IndexRepositoryRequest" }, { "type": "null" } ], "title": "Payload" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepositoryIndexingResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "delete": { "tags": [ "repositories" ], "summary": "Remove a repository from indexing", "description": "Disables indexing and clears configured branches for a single repository.", "operationId": "handle_remove_single_repository_from_indexing_v3_organizations__org_id__repositories__repository_path__indexing_delete", "parameters": [ { "name": "repository_path", "in": "path", "required": true, "schema": { "type": "string", "title": "Repository Path" } }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepositoryIndexingResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "get": { "tags": [ "repositories" ], "summary": "Get indexing status for a repository", "operationId": "handle_get_repository_indexing_status_v3_organizations__org_id__repositories__repository_path__indexing_get", "parameters": [ { "name": "repository_path", "in": "path", "required": true, "schema": { "type": "string", "title": "Repository Path" } }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepoIndexingStatusResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/repositories/{repository_path}/indexing/branches/{branch_name}": { "delete": { "tags": [ "repositories" ], "summary": "Remove a branch from indexing", "operationId": "handle_remove_branch_v3_organizations__org_id__repositories__repository_path__indexing_branches__branch_name__delete", "parameters": [ { "name": "repository_path", "in": "path", "required": true, "schema": { "type": "string", "title": "Repository Path" } }, { "name": "branch_name", "in": "path", "required": true, "schema": { "type": "string", "title": "Branch Name" } }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepositoryIndexingResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3beta1/organizations/{org_id}/members/users": { "get": { "tags": [ "users" ], "summary": "List Organization Users", "description": "List users with direct membership in the organization.", "operationId": "handle_list_organization_users_v3beta1_organizations__org_id__members_users_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "After" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } }, { "name": "email", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Filter by exact email address", "title": "Email" }, "description": "Filter by exact email address" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_User_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3beta1/organizations/{org_id}/members/idp-users": { "get": { "tags": [ "users" ], "summary": "List Organization IDP Group Users", "description": "List users whose organization membership is derived from IDP group assignments.", "operationId": "handle_list_organization_idp_users_v3beta1_organizations__org_id__members_idp_users_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "After" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } }, { "name": "email", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Filter by exact email address", "title": "Email" }, "description": "Filter by exact email address" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_IdpGroupUser_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3beta1/organizations/{org_id}/members/users/{user_id}": { "get": { "tags": [ "users" ], "summary": "Get Organization User", "description": "Get an organization member by ID. Returns both direct and IDP-group-derived role assignments.", "operationId": "handle_get_organization_user_v3beta1_organizations__org_id__members_users__user_id__get", "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "User Id" }, "description": "User ID" }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserWithIdpRoles" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3beta1/organizations/{org_id}/default-platform": { "get": { "tags": [ "organization-settings" ], "summary": "Get Organization Default Platform", "description": "Get the organization's default placement for new sessions.\n\nThis is the organization-wide default shown under Settings > Devin; a\nuser's personal default, when set, takes precedence for their own\nsessions. A stored default that is no longer available to the\norganization is still returned (and skipped at session creation).", "operationId": "handle_get_org_default_platform_v3beta1_organizations__org_id__default_platform_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrgDefaultPlatformResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "put": { "tags": [ "organization-settings" ], "summary": "Set Organization Default Platform", "description": "Set or clear the organization's default placement for new sessions.\n\nAccepts a hosted platform label, a shared outpost pool name\n(``platform``), or a shared outpost pool ID (``outpost_pool_id``).\nOutposts-only organizations only accept outpost pools. Sending neither\nclears the default.", "operationId": "handle_update_org_default_platform_v3beta1_organizations__org_id__default_platform_put", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrgDefaultPlatformUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrgDefaultPlatformResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3beta1/organizations/{org_id}/security-profiles": { "get": { "tags": [ "security-profiles" ], "summary": "List org security profiles", "description": "List the organization's own security profiles. Enterprise-shared\nprofiles are listed on the enterprise security-profiles path.", "operationId": "handle_list_security_profiles_v3beta1_organizations__org_id__security_profiles_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "After" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_SecurityProfileResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "post": { "tags": [ "security-profiles" ], "summary": "Create an org security profile", "description": "Create an organization-owned security profile.", "operationId": "handle_create_security_profile_v3beta1_organizations__org_id__security_profiles_post", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityProfileCreateRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityProfileResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3beta1/organizations/{org_id}/security-profiles/{profile_id}": { "get": { "tags": [ "security-profiles" ], "summary": "Get an org security profile", "description": "Get one of the organization's own security profiles by ID.", "operationId": "handle_get_security_profile_v3beta1_organizations__org_id__security_profiles__profile_id__get", "parameters": [ { "name": "profile_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Profile Id" } }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityProfileResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "patch": { "tags": [ "security-profiles" ], "summary": "Update an org security profile", "description": "Update an organization-owned security profile. Omitted fields are\nleft unchanged; explicit null clears net_policy / mcp_config.", "operationId": "handle_update_security_profile_v3beta1_organizations__org_id__security_profiles__profile_id__patch", "parameters": [ { "name": "profile_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Profile Id" } }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityProfileUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityProfileResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "delete": { "tags": [ "security-profiles" ], "summary": "Delete an org security profile", "description": "Delete an organization-owned security profile. Fails with 409 while\nbindings (defaults, playbooks, automations, sessions) still reference it;\nthe 409 detail lists the referencing resource types.", "operationId": "handle_delete_security_profile_v3beta1_organizations__org_id__security_profiles__profile_id__delete", "parameters": [ { "name": "profile_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Profile Id" } }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "204": { "description": "Successful Response" }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3beta1/organizations/{org_id}/security-profile-settings": { "get": { "tags": [ "security-profiles" ], "summary": "Get org security profile settings", "description": "Get the organization's default security-profile selections.", "operationId": "handle_get_security_profile_settings_v3beta1_organizations__org_id__security_profile_settings_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityProfileSettingsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "patch": { "tags": [ "security-profiles" ], "summary": "Update org security profile settings", "description": "Update the organization's default security-profile selections.\nOmitted fields are left unchanged. A pinned profile may be org-owned or\none of the org's enterprise's shared profiles.", "operationId": "handle_update_security_profile_settings_v3beta1_organizations__org_id__security_profile_settings_patch", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityProfileSettingsUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityProfileSettingsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } } }, "components": { "schemas": { "ACULimitResponse": { "properties": { "cycle_acu_limit": { "type": "integer", "title": "Cycle Acu Limit" }, "scope": { "type": "string", "enum": [ "enterprise", "org", "user" ], "title": "Scope" }, "org_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Org Id" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Id" } }, "type": "object", "required": [ "cycle_acu_limit", "scope" ], "title": "ACULimitResponse" }, "ActiveUserMetricsListResponse": { "items": { "$ref": "#/components/schemas/ActiveUserMetricsResponse" }, "type": "array", "title": "ActiveUserMetricsListResponse", "description": "Validated list of active user metrics with ascending order and no overlapping periods." }, "ActiveUserMetricsResponse": { "properties": { "start_time": { "type": "integer", "title": "Start Time" }, "end_time": { "type": "integer", "title": "End Time" }, "active_users": { "type": "integer", "title": "Active Users" } }, "type": "object", "required": [ "start_time", "end_time", "active_users" ], "title": "ActiveUserMetricsResponse", "description": "Single entry for active users over time." }, "ActorResponse": { "properties": { "type": { "type": "string", "enum": [ "user", "service_user" ], "title": "Type", "description": "Kind of principal." }, "id": { "type": "string", "title": "Id", "description": "User id or service-user id." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Display name, resolved server-side; null when deleted." } }, "type": "object", "required": [ "type", "id" ], "title": "ActorResponse", "description": "A user or service-user principal attributed to an action or resource." }, "AcusByProduct": { "properties": { "devin": { "type": "number", "title": "Devin" }, "cascade": { "type": "number", "title": "Cascade" }, "terminal": { "type": "number", "title": "Terminal" }, "review": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Review" }, "automation": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Automation" } }, "type": "object", "required": [ "devin", "cascade", "terminal" ], "title": "AcusByProduct", "description": "ACUs per product for one day; the buckets sum to the day's ``acus``.\n\n``devin`` is ACUs from Devin sessions a person or service user started,\nincluding code-scan and on-call sessions. ``automation`` is ACUs spent by\nautomations: sessions an automation started plus its code steps that run\nwithout a session. ``automation`` is ``null`` where the per-product\nbreakdown is not available." }, "AiGatewayMetric": { "type": "string", "enum": [ "requests", "tokens", "inter_delta_gap", "request_itl", "ttft", "e2e_latency", "output_tps", "streaming_share" ], "title": "AiGatewayMetric" }, "AiGatewayMetricPointResponse": { "properties": { "timestamp": { "type": "integer", "title": "Timestamp", "description": "Actual bucket start, in Unix seconds." }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Value", "description": "Bucket value; null means no observation." }, "bucket_duration_seconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Bucket Duration Seconds", "description": "Actual complete bucket duration; null for boundary/in-progress or unknown-width buckets." }, "per_second": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Per Second", "description": "Counter value / complete bucket duration (QPS or aggregate token/s); otherwise null." }, "per_minute": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Per Minute", "description": "Counter per_second \u00d7 60 (including aggregate TPM); otherwise null." } }, "type": "object", "required": [ "timestamp", "value", "bucket_duration_seconds", "per_second", "per_minute" ], "title": "AiGatewayMetricPointResponse" }, "AiGatewayMetricProvenanceResponse": { "properties": { "source": { "type": "string", "const": "otel", "title": "Source", "default": "otel" }, "metric_name": { "type": "string", "title": "Metric Name", "description": "Source OTel instrument exported to Datadog." }, "kind": { "type": "string", "enum": [ "counter", "distribution", "ratio" ], "title": "Kind", "description": "Counter, distribution, or derived ratio." }, "environment": { "type": "string", "const": "production", "title": "Environment", "default": "production" }, "scope": { "type": "string", "const": "account", "title": "Scope", "default": "account" } }, "type": "object", "required": [ "metric_name", "kind" ], "title": "AiGatewayMetricProvenanceResponse" }, "AiGatewayMetricSeriesResponse": { "properties": { "dimensions": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Dimensions", "description": "Fixed metric-specific dimensions." }, "points": { "items": { "$ref": "#/components/schemas/AiGatewayMetricPointResponse" }, "type": "array", "title": "Points", "description": "Time-ordered actual buckets." } }, "type": "object", "required": [ "dimensions", "points" ], "title": "AiGatewayMetricSeriesResponse" }, "AiGatewayMetricsResponse": { "properties": { "metric": { "$ref": "#/components/schemas/AiGatewayMetric" }, "unit": { "type": "string", "enum": [ "request", "token", "ms", "token/s", "percent" ], "title": "Unit" }, "aggregation": { "type": "string", "enum": [ "sum", "avg", "p50", "p90", "p95", "p99", "ratio" ], "title": "Aggregation" }, "time_after": { "type": "integer", "title": "Time After", "description": "Inclusive requested start." }, "time_before": { "type": "integer", "title": "Time Before", "description": "Exclusive requested end." }, "requested_interval_seconds": { "type": "integer", "title": "Requested Interval Seconds" }, "effective_interval_seconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Effective Interval Seconds", "description": "Observed timestamp spacing; null if fewer than two timestamps." }, "sampled": { "type": "boolean", "const": false, "title": "Sampled", "description": "OTel measurements are independent of trace sampling; not lossless or billing-grade.", "default": false }, "provenance": { "$ref": "#/components/schemas/AiGatewayMetricProvenanceResponse" }, "series": { "items": { "$ref": "#/components/schemas/AiGatewayMetricSeriesResponse" }, "type": "array", "title": "Series" } }, "type": "object", "required": [ "metric", "unit", "aggregation", "time_after", "time_before", "requested_interval_seconds", "effective_interval_seconds", "provenance", "series" ], "title": "AiGatewayMetricsResponse" }, "AiGatewayModelResponse": { "properties": { "id": { "type": "string", "title": "Id", "description": "Id to send as `model` to the AI Gateway: a model family or a single model." }, "name": { "type": "string", "title": "Name", "description": "Display name." }, "effective_start_date": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Effective Start Date", "description": "Inclusive start of the matched pricing rule, as Unix seconds. Null for list prices or an open start." }, "effective_end_date": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Effective End Date", "description": "Exclusive end of the matched pricing rule, as Unix seconds. Null for list prices or an open end." }, "members": { "items": { "type": "string" }, "type": "array", "title": "Members", "description": "Model UIDs of the family's members, which all share this price and effective dates. Empty for a single model." }, "currency": { "type": "string", "const": "USD", "title": "Currency", "default": "USD" }, "unit": { "type": "string", "const": "per_token", "title": "Unit", "default": "per_token" }, "price": { "$ref": "#/components/schemas/AiGatewayTokenPricesResponse", "description": "The price the account pays." } }, "additionalProperties": false, "type": "object", "required": [ "id", "name", "members", "price" ], "title": "AiGatewayModelResponse" }, "AiGatewayModelsResponse": { "properties": { "models": { "items": { "$ref": "#/components/schemas/AiGatewayModelResponse" }, "type": "array", "title": "Models" } }, "additionalProperties": false, "type": "object", "required": [ "models" ], "title": "AiGatewayModelsResponse" }, "AiGatewayTokenPricesResponse": { "properties": { "input": { "type": "string", "title": "Input" }, "output": { "type": "string", "title": "Output" }, "cache_write": { "type": "string", "title": "Cache Write" }, "cache_read": { "type": "string", "title": "Cache Read" } }, "additionalProperties": false, "type": "object", "required": [ "input", "output", "cache_write", "cache_read" ], "title": "AiGatewayTokenPricesResponse", "description": "Token prices in USD per token, as decimal strings (for example\n\"0.0000006\" for 0.60 USD per million tokens)." }, "ApiKeyResponse": { "properties": { "api_key_id": { "type": "string", "title": "Api Key Id" }, "api_key_name": { "type": "string", "title": "Api Key Name" }, "created_at": { "type": "integer", "title": "Created At" }, "expires_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Expires At" }, "revoked_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Revoked At" }, "last_used_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Last Used At" }, "is_active": { "type": "boolean", "title": "Is Active" } }, "type": "object", "required": [ "api_key_id", "api_key_name", "created_at", "expires_at", "revoked_at", "last_used_at", "is_active" ], "title": "ApiKeyResponse", "description": "Shared response model for API key details (used by both PAT and service user endpoints)." }, "ApiKeyWithTokenResponse": { "properties": { "api_key_id": { "type": "string", "title": "Api Key Id" }, "api_key_name": { "type": "string", "title": "Api Key Name" }, "token": { "type": "string", "title": "Token", "description": "The raw API token. This is only shown once at creation/rotation time." } }, "type": "object", "required": [ "api_key_id", "api_key_name", "token" ], "title": "ApiKeyWithTokenResponse", "description": "Shared response model for API key creation/rotation (includes one-time token)." }, "AttachmentResponse": { "properties": { "attachment_id": { "type": "string", "title": "Attachment Id" }, "name": { "type": "string", "title": "Name" }, "url": { "type": "string", "title": "Url" } }, "type": "object", "required": [ "attachment_id", "name", "url" ], "title": "AttachmentResponse" }, "AuditLogAction": { "type": "string", "enum": [ "login", "create_org", "update_org", "delete_org", "revoke_all_enterprise_api_keys", "add_enterprise_member", "delete_member", "add_member", "assign_roles", "update_role", "create_role", "delete_role", "add_group_membership", "update_group_membership", "delete_group_membership", "create_idp_group", "update_idp_group", "delete_idp_group", "add_idp_group_member", "remove_idp_group_member", "create_scim_user", "update_scim_user", "delete_scim_user", "create_knowledge", "edit_knowledge", "delete_knowledge", "create_folder", "update_folder", "delete_folder", "create_session", "sleep_session", "terminate_session", "archive_session", "unarchive_session", "schedule_session_deletion", "cancel_session_deletion", "send_message", "authorize_ssh_access", "grant_ssh_access", "enroll_ssh_key", "remove_ssh_key", "expose_port", "deploy_app", "create_app", "update_app", "stop_app", "delete_app", "share_app", "share_org_apps", "create_artifact", "publish_artifact_version", "update_artifact", "unpublish_artifact", "share_preview", "request_local_tools_access", "authorize_local_tools_access", "revoke_local_tools_access", "request_local_tools_approval_mode", "create_service_api_key", "revoke_enterprise_api_key", "create_gitlab_integration", "update_gitlab_integration", "reconnect_gitlab_integration", "delete_gitlab_integration", "create_perforce_integration", "update_perforce_integration", "delete_perforce_integration", "create_gitlab_app_config", "delete_gitlab_app_config", "create_bitbucket_app_config", "delete_bitbucket_app_config", "install_gitlab_webhook", "create_azure_devops_integration", "reconnect_azure_devops_integration", "delete_azure_devops_integration", "create_tracker_connection", "update_tracker_connection", "rotate_tracker_connection_token", "delete_tracker_connection", "link_work_item", "unlink_work_item", "remove_repo_from_devin", "update_enterprise_hypervisor_settings", "update_enterprise_settings", "update_commit_signing_mode", "update_commit_email", "update_webhook_ip_access_list", "update_git_manager_outpost_ip_access_list", "update_org_settings", "update_code_snippet_telemetry", "update_local_controls", "update_local_enterprise_config", "update_local_org_config", "update_local_tier_config", "ai_guardrail_violation", "update_ai_guardrail", "approve_deploy", "approve_test_app", "permission_response", "search_query", "create_org_api_key", "create_user_api_key", "view_org_api_key", "view_user_api_key", "create_secret", "update_secret", "delete_secret", "create_playbook", "update_playbook", "delete_playbook", "create_billing_tag", "add_billing_tag_member", "assign_billing_tag_session", "enable_persona", "disable_persona", "delete_persona", "start_repo_setup", "delete_repo_setup", "finish_repo_setup", "github_integration_deleted", "create_github_integration", "update_github_owned_public_repos_in_automations", "delete_github_integration", "refresh_github_integration", "create_bitbucket_integration", "update_bitbucket_integration", "delete_bitbucket_integration", "create_gerrit_integration", "delete_gerrit_integration", "mcp_server_install", "mcp_server_update", "mcp_server_enable", "mcp_server_disable", "mcp_server_delete", "mcp_server_secret_link", "mcp_server_secret_unlink", "link_jira_agent_installation", "unlink_jira_agent_installation", "mcp_server_credential_set", "mcp_server_credential_delete", "mcp_server_oauth_initiate", "mcp_server_oauth_tokens_granted", "mcp_server_oauth_tokens_revoked", "mcp_enterprise_server_targets_update", "mcp_enterprise_server_credential_set", "mcp_enterprise_server_credential_delete", "customer_network_ca_bundle_set", "customer_network_ca_bundle_delete", "create_mcp_validation_session", "mcp_server_tools_list_secrets_resolved", "mcp_server_connect_secrets_resolved", "set_account_managed_plugins", "set_org_managed_plugins", "set_user_managed_plugins", "set_managed_plugin_bundle", "delete_managed_plugin_bundle", "secure_mode_profile_created", "secure_mode_profile_updated", "secure_mode_profile_deleted", "secure_mode_binding_created", "secure_mode_binding_updated", "secure_mode_binding_deleted", "create_service_user", "update_service_user", "delete_service_user", "assign_service_user_role", "remove_service_user_role", "enable_service_user_for_automations", "disable_service_user_for_automations", "set_default_automation_service_user", "create_git_permission", "delete_git_permission", "update_git_permission", "transfer_canonical_repo", "update_provider_sync_policy", "create_provider_sync_purge_preview", "purge_provider_sync_human_access", "git_pr_author_collaborator", "git_pr_author_collaborator_denied", "git_pr_merge", "git_pr_merge_denied", "create_maintenance_task", "update_maintenance_task", "delete_maintenance_task", "create_snapshot_script", "schedule_snapshot_script", "execute_snapshot_script", "update_repo_setup_steering_knowledge", "delete_repo_setup_steering_knowledge", "set_org_group_limits", "create_join_request", "approve_join_request", "automatic_join_event", "reject_join_request", "create_seat_request", "approve_seat_request", "decline_seat_request", "create_service_user_api_key", "revoke_service_user_api_key", "rotate_service_user_api_key", "create_pat", "revoke_pat", "rotate_pat", "update_pat_policy", "bulk_revoke_pats", "policy_revoke_pat", "create_pat_request", "approve_pat_request", "deny_pat_request", "cancel_pat_request", "complete_pat_request", "create_blueprint", "create_blueprint_version", "rollback_blueprint_version", "delete_blueprint", "reorder_blueprints", "create_enterprise_blueprint", "create_enterprise_blueprint_version", "rollback_enterprise_blueprint_version", "delete_enterprise_blueprint", "accept_skill_pr", "trigger_blueprint_build", "cancel_blueprint_build", "create_environment", "update_environment", "delete_environment", "upload_blueprint_file", "delete_blueprint_file", "sync_repo_blueprints", "detach_blueprint_from_git", "create_blueprint_pr", "update_blueprint_settings", "pin_build", "unpin_build", "delete_build", "trigger_automation", "create_automation", "update_automation", "delete_automation", "reset_automation_monitor", "update_automation_scratch", "regenerate_automation_webhook_secret", "automation_target_write_approver", "automation_target_write_approver_denied", "acknowledge_session_hard_cap", "create_audit_log_export", "update_audit_log_export", "delete_audit_log_export", "start_code_scan", "switch_code_scan_profile", "create_code_scan_profile", "update_code_scan_profile", "update_code_scan_effort", "update_code_scan_finding_status", "update_code_scan_finding_content", "unlink_code_scan_finding_session", "import_code_scan", "update_code_scan_platform", "rehost_code_scan", "archive_code_scan", "create_outpost_pool", "update_outpost_pool", "delete_outpost_pool", "claim_outpost_session", "release_outpost_session", "fail_outpost_session", "create_gateway", "regenerate_gateway_token", "update_gateway_hostnames", "update_gateway_dial_address", "delete_gateway", "update_review_comment_language", "report_pr_review_triage", "set_review_repo_billing_target", "delete_review_repo_billing_target", "create_review_trigger", "update_review_trigger", "delete_review_trigger", "create_review_profile", "update_review_profile", "update_review_settings", "update_merge_manager_memory", "delete_merge_manager_memory", "create_federated_identity_provider", "update_federated_identity_provider", "delete_federated_identity_provider", "create_federated_credential", "revoke_federated_credential", "update_service_user_key_policy", "exchange_federated_token" ], "title": "AuditLogAction" }, "AuditLogResponse": { "properties": { "audit_log_id": { "type": "string", "title": "Audit Log Id" }, "action": { "$ref": "#/components/schemas/AuditLogAction" }, "created_at": { "type": "integer", "title": "Created At" }, "org_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Org Id" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Id" }, "user_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Email" }, "service_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Service User Id" }, "service_user_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Service User Name" }, "data": { "additionalProperties": true, "type": "object", "title": "Data" } }, "type": "object", "required": [ "audit_log_id", "action", "created_at", "org_id", "user_id", "user_email", "service_user_id", "service_user_name", "data" ], "title": "AuditLogResponse" }, "AutoScanScheduleCreateRequest": { "properties": { "rrule": { "type": "string", "minLength": 1, "title": "Rrule", "description": "iCal RRULE string (e.g. \"FREQ=DAILY\") driving the schedule on which new commits are scanned." }, "enabled": { "type": "boolean", "title": "Enabled", "description": "Whether the schedule starts enabled.", "default": true }, "effort": { "anyOf": [ { "type": "string", "enum": [ "normal", "deep" ] }, { "type": "null" } ], "title": "Effort", "description": "Effort to apply to future incremental runs of the scan, including the scheduled ones: 'normal' or 'deep'. Omit to keep the scan's current effort. Rejected with 409 while a scan run is active." } }, "type": "object", "required": [ "rrule" ], "title": "AutoScanScheduleCreateRequest", "description": "Request to create a scan's recurring auto-scan schedule." }, "AutoScanScheduleResponse": { "properties": { "scan_id": { "type": "string", "title": "Scan Id", "description": "The scan the schedule belongs to." }, "automation_id": { "type": "string", "title": "Automation Id", "description": "ID of the automation backing the schedule." }, "rrule": { "type": "string", "title": "Rrule", "description": "iCal RRULE string driving the schedule." }, "enabled": { "type": "boolean", "title": "Enabled", "description": "Whether the schedule is enabled." } }, "type": "object", "required": [ "scan_id", "automation_id", "rrule", "enabled" ], "title": "AutoScanScheduleResponse", "description": "The recurring auto-scan schedule configured for a code scan." }, "AutomationCodeScanFindingRemediation": { "properties": { "severities": { "items": { "type": "string", "enum": [ "critical", "high", "medium", "low" ] }, "type": "array", "minItems": 1, "title": "Severities", "description": "Finding severities to remediate." }, "max_findings_per_scan": { "anyOf": [ { "type": "integer", "minimum": 1.0 }, { "type": "null" } ], "title": "Max Findings Per Scan", "description": "Most findings remediated per scan; defaults to 50." } }, "additionalProperties": false, "type": "object", "title": "AutomationCodeScanFindingRemediation", "description": "Assign Devin to findings of the scans this action starts." }, "AutomationCodeScanRepo": { "properties": { "repo_name": { "type": "string", "title": "Repo Name", "description": "Repository (owner/name)." }, "host": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Host" } }, "additionalProperties": false, "type": "object", "required": [ "repo_name" ], "title": "AutomationCodeScanRepo" }, "AutomationComparisonCondition": { "properties": { "field": { "type": "string", "title": "Field" }, "operator": { "type": "string", "enum": [ "eq", "neq" ], "title": "Operator" }, "value": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ], "title": "Value" } }, "additionalProperties": false, "type": "object", "required": [ "field", "operator", "value" ], "title": "AutomationComparisonCondition" }, "AutomationConcurrency": { "properties": { "max_concurrent_runs": { "anyOf": [ { "type": "integer", "minimum": 1.0 }, { "type": "null" } ], "title": "Max Concurrent Runs", "description": "Maximum in-flight runs for this automation; further triggered events wait in its queue. A run stops counting toward the limit once its session finishes and is awaiting further instructions, not only when the session stops. null = unlimited." }, "max_queue_depth": { "anyOf": [ { "type": "integer", "minimum": 0.0 }, { "type": "null" } ], "title": "Max Queue Depth", "description": "Maximum triggered events waiting in the automation's queue to run; events beyond this are dropped. Requires max_concurrent_runs to be set. null = unlimited." } }, "additionalProperties": false, "type": "object", "title": "AutomationConcurrency" }, "AutomationConditionGroup": { "properties": { "all": { "items": { "oneOf": [ { "$ref": "#/components/schemas/AutomationComparisonCondition" }, { "$ref": "#/components/schemas/AutomationStringCondition" }, { "$ref": "#/components/schemas/AutomationNumericCondition" }, { "$ref": "#/components/schemas/AutomationEmptyCondition" }, { "$ref": "#/components/schemas/AutomationRangeCondition" }, { "$ref": "#/components/schemas/AutomationListCondition" }, { "$ref": "#/components/schemas/AutomationMatchCondition" }, { "$ref": "#/components/schemas/AutomationRecurrenceCondition" }, { "$ref": "#/components/schemas/AutomationGlobCondition" } ], "discriminator": { "propertyName": "operator", "mapping": { "between": "#/components/schemas/AutomationRangeCondition", "contains": "#/components/schemas/AutomationStringCondition", "ends_with": "#/components/schemas/AutomationStringCondition", "eq": "#/components/schemas/AutomationComparisonCondition", "globs": "#/components/schemas/AutomationGlobCondition", "gt": "#/components/schemas/AutomationNumericCondition", "gte": "#/components/schemas/AutomationNumericCondition", "in": "#/components/schemas/AutomationListCondition", "is_empty": "#/components/schemas/AutomationEmptyCondition", "is_not_empty": "#/components/schemas/AutomationEmptyCondition", "lt": "#/components/schemas/AutomationNumericCondition", "lte": "#/components/schemas/AutomationNumericCondition", "matches": "#/components/schemas/AutomationMatchCondition", "neq": "#/components/schemas/AutomationComparisonCondition", "not_contains": "#/components/schemas/AutomationStringCondition", "not_ends_with": "#/components/schemas/AutomationStringCondition", "not_globs": "#/components/schemas/AutomationGlobCondition", "not_in": "#/components/schemas/AutomationListCondition", "not_matches": "#/components/schemas/AutomationMatchCondition", "not_starts_with": "#/components/schemas/AutomationStringCondition", "recurrence": "#/components/schemas/AutomationRecurrenceCondition", "starts_with": "#/components/schemas/AutomationStringCondition" } } }, "type": "array", "title": "All", "description": "AND: every condition in the group must match." } }, "additionalProperties": false, "type": "object", "required": [ "all" ], "title": "AutomationConditionGroup" }, "AutomationConditions-Input": { "properties": { "any": { "items": { "$ref": "#/components/schemas/AutomationConditionGroup" }, "type": "array", "title": "Any", "description": "OR of AND-groups (fixed two-level DNF)." } }, "additionalProperties": false, "type": "object", "required": [ "any" ], "title": "AutomationConditions" }, "AutomationConditions-Output": { "properties": { "any": { "items": { "$ref": "#/components/schemas/AutomationConditionGroup" }, "type": "array", "title": "Any", "description": "OR of AND-groups (fixed two-level DNF)." } }, "additionalProperties": false, "type": "object", "required": [ "any" ], "title": "AutomationConditions" }, "AutomationCreateRequest": { "properties": { "name": { "type": "string", "maxLength": 500, "minLength": 1, "title": "Name" }, "triggers": { "items": { "$ref": "#/components/schemas/AutomationTriggerRequest-Input" }, "type": "array", "title": "Triggers", "description": "Fires when any trigger matches; once per event. At most one webhook:incoming trigger." }, "actions": { "items": { "oneOf": [ { "$ref": "#/components/schemas/AutomationStartSessionAction-Input" }, { "$ref": "#/components/schemas/AutomationMessageSessionAction" }, { "$ref": "#/components/schemas/AutomationMonitorSessionAction" } ], "discriminator": { "propertyName": "type", "mapping": { "message_session": "#/components/schemas/AutomationMessageSessionAction", "monitor_session": "#/components/schemas/AutomationMonitorSessionAction", "start_session": "#/components/schemas/AutomationStartSessionAction-Input" } } }, "type": "array", "title": "Actions", "description": "Non-empty. Caps: at most one start_session; monitor_session must be the only action." }, "enabled": { "type": "boolean", "title": "Enabled", "default": true }, "notifications": { "anyOf": [ { "$ref": "#/components/schemas/AutomationNotifications" }, { "type": "null" } ] }, "tools": { "anyOf": [ { "$ref": "#/components/schemas/AutomationTools" }, { "type": "null" } ] }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Metadata", "description": "Org-visible key/value labels for organizing/filtering automations. At most 16 pairs; keys at most 32 chars; values at most 128.", "default": {} }, "limits": { "anyOf": [ { "$ref": "#/components/schemas/AutomationLimits" }, { "type": "null" } ] }, "concurrency": { "anyOf": [ { "$ref": "#/components/schemas/AutomationConcurrency" }, { "type": "null" } ] }, "session_settings": { "anyOf": [ { "$ref": "#/components/schemas/AutomationSessionSettings-Input" }, { "type": "null" } ], "description": "Applied to sessions this automation spawns." }, "security_profile": { "anyOf": [ { "$ref": "#/components/schemas/AutomationSecurityProfileSelection" }, { "type": "null" } ], "description": "The automation's own security-profile binding; omitted = inherit from the org/enterprise. Requires the security-profile management permission." }, "run_as": { "oneOf": [ { "$ref": "#/components/schemas/AutomationRunAsOrganization" }, { "$ref": "#/components/schemas/AutomationRunAsCreator" }, { "$ref": "#/components/schemas/AutomationRunAsServiceUser" } ], "title": "Run As", "description": "Required: explicitly choose the identity spawned sessions run under (organization, creator, or service_user).", "discriminator": { "propertyName": "type", "mapping": { "creator": "#/components/schemas/AutomationRunAsCreator", "organization": "#/components/schemas/AutomationRunAsOrganization", "service_user": "#/components/schemas/AutomationRunAsServiceUser" } } }, "slack_reply_access": { "type": "string", "enum": [ "devin_users", "slack_users", "external_slack_users" ], "title": "Slack Reply Access", "description": "Who may reply into existing sessions from Slack threads: devin_users (linked Devin accounts only), slack_users (anyone in the organization's connected Slack workspaces), or external_slack_users (also Slack Connect users). Does not affect who can trigger the automation.", "default": "slack_users" }, "teams_reply_access": { "type": "string", "enum": [ "devin_users", "teams_users" ], "title": "Teams Reply Access", "description": "Who may reply into existing sessions from Microsoft Teams threads: devin_users (linked Devin accounts only) or teams_users (anyone in the organization's connected Microsoft tenant; the default). Does not affect who can trigger the automation.", "default": "teams_users" }, "template_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Template Id", "description": "Create-only provenance marker; resolve ids via the templates endpoint. When set and tools.mcp_servers is omitted, the template's required_mcps apply." }, "script_check": { "anyOf": [ { "$ref": "#/components/schemas/AutomationScriptCheckRequest" }, { "type": "null" } ], "description": "Optional script Preflight check: a script that runs before the actions and decides per trigger whether to proceed, skip, or fan out. Validated and written with the automation." }, "llm_check": { "anyOf": [ { "$ref": "#/components/schemas/AutomationLlmCheckRequest" }, { "type": "null" } ], "description": "Optional LLM check: a fast model that decides per trigger event whether the automation runs." } }, "additionalProperties": false, "type": "object", "required": [ "name", "triggers", "actions", "run_as" ], "title": "AutomationCreateRequest" }, "AutomationEmailNotification": { "properties": { "when": { "type": "string", "enum": [ "always", "dispatch_failed", "dispatch_succeeded" ], "title": "When" }, "recipients": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Recipients", "description": "null = the automation creator; required for service-user-created automations." } }, "additionalProperties": false, "type": "object", "required": [ "when" ], "title": "AutomationEmailNotification" }, "AutomationEmptyCondition": { "properties": { "field": { "type": "string", "title": "Field" }, "operator": { "type": "string", "enum": [ "is_empty", "is_not_empty" ], "title": "Operator" }, "value": { "type": "null", "title": "Value" } }, "additionalProperties": false, "type": "object", "required": [ "field", "operator" ], "title": "AutomationEmptyCondition", "description": "Unary operator: matches on the field's emptiness; `value` carries no data." }, "AutomationEventSchemaResponse": { "properties": { "event_type": { "type": "string", "title": "Event Type" }, "name": { "type": "string", "title": "Name" }, "category": { "type": "string", "title": "Category" }, "supported_replies": { "items": { "type": "string" }, "type": "array", "title": "Supported Replies", "description": "Valid replies[].type verbs for this event type." }, "fields": { "additionalProperties": { "$ref": "#/components/schemas/AutomationSchemaFieldDef" }, "type": "object", "title": "Fields", "description": "Condition field path \u2192 field definition (type, label, required, options, ...)." } }, "additionalProperties": false, "type": "object", "required": [ "event_type", "name", "category", "supported_replies", "fields" ], "title": "AutomationEventSchemaResponse" }, "AutomationGlobCondition": { "properties": { "field": { "type": "string", "title": "Field" }, "operator": { "type": "string", "enum": [ "globs", "not_globs" ], "title": "Operator" }, "value": { "items": { "type": "string" }, "type": "array", "title": "Value", "description": "Glob patterns; any changed path matches (github:push, gitlab:push)." } }, "additionalProperties": false, "type": "object", "required": [ "field", "operator", "value" ], "title": "AutomationGlobCondition" }, "AutomationHostnameDestination": { "properties": { "hostname": { "type": "string", "title": "Hostname" } }, "additionalProperties": false, "type": "object", "required": [ "hostname" ], "title": "AutomationHostnameDestination" }, "AutomationInvocationLimits": { "properties": { "max_per_window": { "type": "integer", "minimum": 1.0, "title": "Max Per Window" }, "window_seconds": { "type": "integer", "minimum": 60.0, "title": "Window Seconds" } }, "additionalProperties": false, "type": "object", "required": [ "max_per_window", "window_seconds" ], "title": "AutomationInvocationLimits" }, "AutomationIpv4Destination": { "properties": { "ipv4": { "type": "string", "title": "Ipv4" } }, "additionalProperties": false, "type": "object", "required": [ "ipv4" ], "title": "AutomationIpv4Destination" }, "AutomationIpv6Destination": { "properties": { "ipv6": { "type": "string", "title": "Ipv6" } }, "additionalProperties": false, "type": "object", "required": [ "ipv6" ], "title": "AutomationIpv6Destination" }, "AutomationLastInvocation": { "properties": { "fired_at": { "type": "integer", "title": "Fired At" }, "status": { "type": "string", "title": "Status", "description": "succeeded | failed | skipped \u2014 open enum, clients must tolerate new values." } }, "additionalProperties": false, "type": "object", "required": [ "fired_at", "status" ], "title": "AutomationLastInvocation" }, "AutomationLimits": { "properties": { "max_acu_limit": { "anyOf": [ { "type": "integer", "maximum": 1000.0, "minimum": 1.0 }, { "type": "null" } ], "title": "Max Acu Limit", "description": "Per spawned session (same name as the sessions API)." }, "invocations": { "anyOf": [ { "$ref": "#/components/schemas/AutomationInvocationLimits" }, { "type": "null" } ], "description": "Rate-limits the automation's own firing." } }, "additionalProperties": false, "type": "object", "title": "AutomationLimits" }, "AutomationListCondition": { "properties": { "field": { "type": "string", "title": "Field" }, "operator": { "type": "string", "enum": [ "in", "not_in" ], "title": "Operator" }, "value": { "items": { "type": "string" }, "type": "array", "title": "Value" } }, "additionalProperties": false, "type": "object", "required": [ "field", "operator", "value" ], "title": "AutomationListCondition" }, "AutomationLlmCheckRequest": { "properties": { "filter_prompt": { "type": "string", "maxLength": 4000, "minLength": 1, "title": "Filter Prompt", "description": "Plain-language description of which trigger events should run the automation. Events that do not match it are skipped." }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enabled", "description": "Whether the check gates the automation's runs. Omitted keeps the current state; a new configuration starts enabled." } }, "additionalProperties": false, "type": "object", "required": [ "filter_prompt" ], "title": "AutomationLlmCheckRequest", "description": "The automation's LLM check configuration. On update the filter prompt is\nreplaced; ``enabled`` alone may be omitted to keep its state." }, "AutomationMatchCondition": { "properties": { "field": { "type": "string", "title": "Field" }, "operator": { "type": "string", "enum": [ "matches", "not_matches" ], "title": "Operator" }, "value": { "type": "string", "title": "Value", "description": "Regular expression." } }, "additionalProperties": false, "type": "object", "required": [ "field", "operator", "value" ], "title": "AutomationMatchCondition" }, "AutomationMessageSessionAction": { "properties": { "type": { "type": "string", "const": "message_session", "title": "Type", "default": "message_session" }, "target_devin_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Devin Id", "description": "Must belong to the org; editing an automation containing this action requires write access to the target session (enable/disable-only edits exempt). Required unless auto_create is true, in which case it is set server-side once the first trigger creates the session; client-supplied values are ignored." }, "prompt": { "type": "string", "title": "Prompt", "description": "The triggering event's payload is appended automatically." }, "auto_create": { "type": "boolean", "title": "Auto Create", "description": "When true, the first trigger creates a new long-running session owned by the automation and subsequent triggers message it.", "default": false } }, "additionalProperties": false, "type": "object", "required": [ "prompt" ], "title": "AutomationMessageSessionAction" }, "AutomationMessageSessionActionUpdate": { "properties": { "type": { "type": "string", "const": "message_session", "title": "Type", "default": "message_session" }, "target_devin_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Devin Id", "description": "Must belong to the org; editing an automation containing this action requires write access to the target session (enable/disable-only edits exempt). Required unless auto_create is true, in which case it is set server-side once the first trigger creates the session; client-supplied values are ignored." }, "prompt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Prompt", "description": "The triggering event's payload is appended automatically. Required when creating or adding this action; on a merge-semantics update, omit it to keep the stored value (null is invalid)." }, "auto_create": { "type": "boolean", "title": "Auto Create", "description": "When true, the first trigger creates a new long-running session owned by the automation and subsequent triggers message it.", "default": false } }, "additionalProperties": false, "type": "object", "title": "AutomationMessageSessionActionUpdate" }, "AutomationMonitorSessionAction": { "properties": { "type": { "type": "string", "const": "monitor_session", "title": "Type", "default": "monitor_session" }, "setup_prompt": { "type": "string", "title": "Setup Prompt", "description": "Injected into the session's system prompt. Same reference-token grammar as prompt." }, "slack_monitor_config": { "$ref": "#/components/schemas/AutomationSlackMonitorConfig", "description": "Requires exactly one slack:message trigger on the same channel." } }, "additionalProperties": false, "type": "object", "required": [ "setup_prompt", "slack_monitor_config" ], "title": "AutomationMonitorSessionAction" }, "AutomationMonitorSessionActionUpdate": { "properties": { "type": { "type": "string", "const": "monitor_session", "title": "Type", "default": "monitor_session" }, "setup_prompt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Setup Prompt", "description": "Injected into the session's system prompt. Same reference-token grammar as prompt. Required when creating or adding this action; on a merge-semantics update, omit it to keep the stored value (null is invalid)." }, "slack_monitor_config": { "anyOf": [ { "$ref": "#/components/schemas/AutomationSlackMonitorConfig" }, { "type": "null" } ], "description": "Requires exactly one slack:message trigger on the same channel. Required when creating or adding this action; on a merge-semantics update, omit it to keep the stored value (null is invalid)." } }, "additionalProperties": false, "type": "object", "title": "AutomationMonitorSessionActionUpdate" }, "AutomationNetPolicy": { "properties": { "allow": { "items": { "anyOf": [ { "$ref": "#/components/schemas/AutomationHostnameDestination" }, { "$ref": "#/components/schemas/AutomationIpv4Destination" }, { "$ref": "#/components/schemas/AutomationIpv6Destination" } ] }, "type": "array", "title": "Allow" } }, "additionalProperties": false, "type": "object", "required": [ "allow" ], "title": "AutomationNetPolicy" }, "AutomationNotifications": { "properties": { "email": { "anyOf": [ { "$ref": "#/components/schemas/AutomationEmailNotification" }, { "type": "null" } ] }, "slack": { "anyOf": [ { "$ref": "#/components/schemas/AutomationSlackNotification" }, { "type": "null" } ] } }, "additionalProperties": false, "type": "object", "title": "AutomationNotifications" }, "AutomationNumericCondition": { "properties": { "field": { "type": "string", "title": "Field" }, "operator": { "type": "string", "enum": [ "gt", "lt", "gte", "lte" ], "title": "Operator" }, "value": { "anyOf": [ { "type": "integer" }, { "type": "number" } ], "title": "Value" } }, "additionalProperties": false, "type": "object", "required": [ "field", "operator", "value" ], "title": "AutomationNumericCondition" }, "AutomationRangeCondition": { "properties": { "field": { "type": "string", "title": "Field" }, "operator": { "type": "string", "const": "between", "title": "Operator" }, "value": { "prefixItems": [ { "anyOf": [ { "type": "integer" }, { "type": "number" } ] }, { "anyOf": [ { "type": "integer" }, { "type": "number" } ] } ], "type": "array", "maxItems": 2, "minItems": 2, "title": "Value", "description": "Inclusive [low, high] range." } }, "additionalProperties": false, "type": "object", "required": [ "field", "operator", "value" ], "title": "AutomationRangeCondition" }, "AutomationReadinessScanAction": { "properties": { "type": { "type": "string", "const": "readiness_scan", "title": "Type", "default": "readiness_scan" }, "repo_name": { "type": "string", "title": "Repo Name" }, "devin_mode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Devin Mode" }, "max_scopes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Scopes" } }, "additionalProperties": false, "type": "object", "required": [ "repo_name" ], "title": "AutomationReadinessScanAction", "description": "Run an Agent Readiness assessment of the repository." }, "AutomationRecurrenceCondition": { "properties": { "field": { "type": "string", "title": "Field" }, "operator": { "type": "string", "const": "recurrence", "title": "Operator" }, "value": { "type": "string", "title": "Value", "description": "iCalendar RRULE for schedule:recurring's rrule field, e.g. FREQ=WEEKLY;BYDAY=MO;BYHOUR=9;BYMINUTE=0" } }, "additionalProperties": false, "type": "object", "required": [ "field", "operator", "value" ], "title": "AutomationRecurrenceCondition" }, "AutomationRemediateFindingAction": { "properties": { "type": { "type": "string", "const": "remediate_finding", "title": "Type", "default": "remediate_finding" } }, "additionalProperties": false, "type": "object", "title": "AutomationRemediateFindingAction", "description": "Launch the built-in remediation session for the triggering code-scan\nfinding. Fully determined by the ``code_scan:finding`` event, so it carries\nno configuration." }, "AutomationReply": { "properties": { "type": { "type": "string", "enum": [ "notify_thread", "attach_thread", "post_response" ], "title": "Type", "description": "notify_thread: dispatch-time one-way 'session started' breadcrumb in the triggering thread (Slack triggers). attach_thread: dispatch-time two-way binding to the triggering thread (Slack triggers). post_response: deliver the agent's response to the triggering context." } }, "additionalProperties": false, "type": "object", "required": [ "type" ], "title": "AutomationReply" }, "AutomationResponse": { "properties": { "automation_id": { "type": "string", "title": "Automation Id" }, "name": { "type": "string", "title": "Name" }, "enabled": { "type": "boolean", "title": "Enabled" }, "triggers": { "items": { "$ref": "#/components/schemas/AutomationTriggerResponse" }, "type": "array", "title": "Triggers" }, "actions": { "items": { "oneOf": [ { "$ref": "#/components/schemas/AutomationStartSessionAction-Output" }, { "$ref": "#/components/schemas/AutomationMessageSessionAction" }, { "$ref": "#/components/schemas/AutomationMonitorSessionAction" } ], "discriminator": { "propertyName": "type", "mapping": { "message_session": "#/components/schemas/AutomationMessageSessionAction", "monitor_session": "#/components/schemas/AutomationMonitorSessionAction", "start_session": "#/components/schemas/AutomationStartSessionAction-Output" } } }, "type": "array", "title": "Actions" }, "notifications": { "anyOf": [ { "$ref": "#/components/schemas/AutomationNotifications" }, { "type": "null" } ] }, "tools": { "anyOf": [ { "$ref": "#/components/schemas/AutomationTools" }, { "type": "null" } ] }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Metadata", "default": {} }, "limits": { "anyOf": [ { "$ref": "#/components/schemas/AutomationLimits" }, { "type": "null" } ] }, "concurrency": { "anyOf": [ { "$ref": "#/components/schemas/AutomationConcurrency" }, { "type": "null" } ] }, "session_settings": { "anyOf": [ { "$ref": "#/components/schemas/AutomationSessionSettings-Output" }, { "type": "null" } ] }, "security_profile": { "anyOf": [ { "$ref": "#/components/schemas/AutomationSecurityProfileResponse" }, { "type": "null" } ], "description": "The automation's security-profile binding and the resolved governing profiles. null when security profiles are not enabled for the organization." }, "run_as": { "oneOf": [ { "$ref": "#/components/schemas/AutomationRunAsOrganization" }, { "$ref": "#/components/schemas/AutomationRunAsCreator" }, { "$ref": "#/components/schemas/AutomationRunAsServiceUser" } ], "title": "Run As", "description": "Identity the spawned sessions run under. organization: the org's automation identity. When the organization has a default service user for automations, sessions run as that service user and the response returns run_as service_user with its id; saving requires every permission that service user holds. Without one, creating an automation or saving an enabled one is rejected. MCP servers installed with a personal (user-scoped) connection that service user has not connected cannot be selected, and switching an automation to organization removes them from its selection. creator: personal automation \u2014 runs with the creator's own permissions and is visible only to the creator and org admins; rejected for service-user-created automations. service_user: runs as the given service user, with its roles, grants and ACU limits; requires permission to manage that service user. Required on create; null on update resets to organization.", "discriminator": { "propertyName": "type", "mapping": { "creator": "#/components/schemas/AutomationRunAsCreator", "organization": "#/components/schemas/AutomationRunAsOrganization", "service_user": "#/components/schemas/AutomationRunAsServiceUser" } } }, "slack_reply_access": { "type": "string", "enum": [ "devin_users", "slack_users", "external_slack_users" ], "title": "Slack Reply Access", "description": "Who may reply into existing sessions from Slack threads: devin_users (linked Devin accounts only), slack_users (anyone in the organization's connected Slack workspaces), or external_slack_users (also Slack Connect users). Does not affect who can trigger the automation.", "default": "slack_users" }, "teams_reply_access": { "type": "string", "enum": [ "devin_users", "teams_users" ], "title": "Teams Reply Access", "description": "Who may reply into existing sessions from Microsoft Teams threads: devin_users (linked Devin accounts only) or teams_users (anyone in the organization's connected Microsoft tenant; the default). Does not affect who can trigger the automation.", "default": "teams_users" }, "template_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Template Id" }, "created_by": { "$ref": "#/components/schemas/ActorResponse" }, "last_edited_by": { "anyOf": [ { "$ref": "#/components/schemas/ActorResponse" }, { "type": "null" } ] }, "created_at": { "type": "integer", "title": "Created At" }, "updated_at": { "type": "integer", "title": "Updated At" }, "last_invocation": { "anyOf": [ { "$ref": "#/components/schemas/AutomationLastInvocation" }, { "type": "null" } ] }, "next_run_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Next Run At", "description": "When the automation's schedule triggers next fire. null when it has no schedule trigger, is disabled, or every schedule has passed its end date." } }, "additionalProperties": false, "type": "object", "required": [ "automation_id", "name", "enabled", "triggers", "actions", "created_by", "created_at", "updated_at" ], "title": "AutomationResponse" }, "AutomationRunAsCreator": { "properties": { "type": { "type": "string", "const": "creator", "title": "Type", "default": "creator" } }, "additionalProperties": false, "type": "object", "title": "AutomationRunAsCreator" }, "AutomationRunAsOrganization": { "properties": { "type": { "type": "string", "const": "organization", "title": "Type", "default": "organization" } }, "additionalProperties": false, "type": "object", "title": "AutomationRunAsOrganization" }, "AutomationRunAsServiceUser": { "properties": { "type": { "type": "string", "const": "service_user", "title": "Type", "default": "service_user" }, "service_user_id": { "type": "string", "title": "Service User Id" } }, "additionalProperties": false, "type": "object", "required": [ "service_user_id" ], "title": "AutomationRunAsServiceUser" }, "AutomationScanNewCommitsAction": { "properties": { "type": { "type": "string", "const": "scan_new_commits", "title": "Type", "default": "scan_new_commits" }, "scan_id": { "type": "string", "title": "Scan Id", "description": "The finished code scan to extend with newly landed commits." } }, "additionalProperties": false, "type": "object", "required": [ "scan_id" ], "title": "AutomationScanNewCommitsAction" }, "AutomationScanNewCommitsActionUpdate": { "properties": { "type": { "type": "string", "const": "scan_new_commits", "title": "Type", "default": "scan_new_commits" }, "scan_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scan Id", "description": "The finished code scan to extend with newly landed commits. Required when creating or adding this action; on a merge-semantics update, omit it to keep the stored value (null is invalid)." } }, "additionalProperties": false, "type": "object", "title": "AutomationScanNewCommitsActionUpdate" }, "AutomationSchemaFieldDef": { "properties": { "type": { "type": "string", "enum": [ "string", "number", "boolean", "date", "select", "rrule", "slack_channel", "linear_team", "incident_io_team", "incident_io_severity", "incident_io_status", "incident_io_incident_type", "pagerduty_service", "pagerduty_team", "pagerduty_priority", "github_repo", "gitlab_repo", "azure_devops_repo", "bitbucket_data_center_repo", "linear_label", "linear_state", "linear_assignee", "linear_project", "jira_project", "jira_site", "jira_label", "jira_status", "jira_assignee", "jira_epic", "slack_user", "slack_reaction", "slack_usergroup", "pylon_tag", "pylon_status", "board", "teams_team", "teams_channel", "teams_reaction", "file_paths" ], "title": "Type" }, "label": { "type": "string", "title": "Label" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "required": { "type": "boolean", "title": "Required", "default": false }, "fixed": { "type": "boolean", "title": "Fixed", "default": false }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Placeholder" }, "min": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Min" }, "max": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Max" }, "unit": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Unit" }, "granularity": { "anyOf": [ { "type": "string", "enum": [ "date", "datetime" ] }, { "type": "null" } ], "title": "Granularity" }, "options": { "anyOf": [ { "items": { "$ref": "#/components/schemas/AutomationSchemaSelectOption" }, "type": "array" }, { "type": "null" } ], "title": "Options" }, "multiple": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Multiple" } }, "additionalProperties": false, "type": "object", "required": [ "type", "label" ], "title": "AutomationSchemaFieldDef", "description": "Flattened view of a condition field definition.\n\nKind-specific attributes (``options``, ``min``/``max``/``unit``,\n``granularity``, ``placeholder``) are populated only for the relevant\n``type``." }, "AutomationSchemaSelectOption": { "properties": { "value": { "type": "string", "title": "Value" }, "label": { "type": "string", "title": "Label" } }, "additionalProperties": false, "type": "object", "required": [ "value", "label" ], "title": "AutomationSchemaSelectOption" }, "AutomationSchemasOncall": { "properties": { "setup_complete": { "type": "boolean", "title": "Setup Complete", "description": "Whether the organization has finished Devin Oncall setup, i.e. Oncall responders can be created." }, "can_manage": { "type": "boolean", "title": "Can Manage", "description": "Whether the caller has the Manage Oncall permission, which creating and editing Oncall responders requires." } }, "additionalProperties": false, "type": "object", "required": [ "setup_complete", "can_manage" ], "title": "AutomationSchemasOncall" }, "AutomationSchemasResponse": { "properties": { "skills_serve_playbooks": { "type": "boolean", "title": "Skills Serve Playbooks", "description": "Whether this account uses Skills in place of Playbooks.", "default": false }, "default_net_policy": { "anyOf": [ { "$ref": "#/components/schemas/AutomationNetPolicy" }, { "type": "null" } ], "description": "Network policy clients should start new automations from: the deployment's Git Manager-only policy (add only the destinations the task requires), or null when the governing security profile (see security_profile) has a network policy. In that case sessions use the profile's policy; omit session_settings.net_policy unless the task must restrict further." }, "security_profile": { "anyOf": [ { "$ref": "#/components/schemas/AutomationSchemasSecurityProfile" }, { "type": "null" } ], "description": "Security profile governing this organization's automation sessions, or null when none applies." }, "update_semantics": { "type": "string", "title": "Update Semantics", "description": "PATCH semantics active for this organization: 'replace_groups' (a config group present in the request replaces the stored group wholesale) or 'merge_patch' (RFC 7396 for objects: omitted members of a present group keep their stored values, explicit nulls clear; list membership still replaces wholesale \u2014 deletion is resending the list without the element \u2014 but each sent element merges onto the stored element of the same type when that type appears exactly once on both sides; repeated types must be restated fully). Open enum \u2014 clients must tolerate new values." }, "sources": { "additionalProperties": { "additionalProperties": { "$ref": "#/components/schemas/AutomationEventSchemaResponse" }, "type": "object" }, "type": "object", "title": "Sources", "description": "Event source \u2192 event name \u2192 schema." }, "available_devin_modes": { "items": { "type": "string", "enum": [ "normal", "fast", "lite", "ultra", "fusion", "swe-2-medium", "swe-2-high", "swe-2-max" ] }, "type": "array", "title": "Available Devin Modes", "description": "Modes session_settings.devin_mode accepts for a new selection right now, as the organization's automation identity: the stable modes it can spawn plus, when the organization's preview rollout allows, the research previews. A stored mode outside this list is preserved by edits that do not change it." }, "default_fallback_devin_mode": { "anyOf": [ { "type": "string", "enum": [ "normal", "fast", "lite", "ultra", "fusion" ] }, { "type": "null" } ], "title": "Default Fallback Devin Mode", "description": "Stable mode to prefill session_settings.fallback_devin_mode with when a research preview is selected: the organization's default mode when it is stable and available, else the first available stable mode; null when none is available." }, "script_check_available": { "type": "boolean", "title": "Script Check Available", "description": "Whether this organization can configure a script Preflight check (the automation-code-step rollout). When false the script_check field is rejected with 403.", "default": false } }, "additionalProperties": false, "type": "object", "required": [ "default_net_policy", "update_semantics", "sources" ], "title": "AutomationSchemasResponse" }, "AutomationSchemasSecurityProfile": { "properties": { "name": { "type": "string", "title": "Name", "description": "Profile name, for display." }, "governs_network": { "type": "boolean", "title": "Governs Network", "description": "Whether the profile has a network policy. When true, sessions are already restricted to the profile's destinations and an automation needs its own session_settings.net_policy only to restrict further." }, "mcp_servers": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Mcp Servers", "description": "MCP server slugs the profile allows (the ceiling for tools.mcp_servers), or null when the profile does not restrict MCP servers." } }, "additionalProperties": false, "type": "object", "required": [ "name", "governs_network", "mcp_servers" ], "title": "AutomationSchemasSecurityProfile", "description": "The security profile that governs this organization's automation\nsessions (enterprise, organization, or automations default binding)." }, "AutomationScriptCheckRequest": { "properties": { "runtime": { "type": "string", "title": "Runtime", "description": "Script runtime. One of: python, node, bash." }, "source": { "type": "string", "minLength": 1, "title": "Source", "description": "The script source (at most 256KB). It reads the trigger event from $EVENT_FILE, may read/write a small JSON object at $STATE_FILE that persists across runs, and must write its decision to $OUTPUT_FILE: {\"run\": true}, {\"run\": false, \"reason\": \"...\"}, or {\"items\": [...]} (one action run per item)." }, "timeout_seconds": { "type": "integer", "maximum": 300.0, "minimum": 1.0, "title": "Timeout Seconds", "description": "Wall-clock limit for one run; a run past it fails closed (no actions start).", "default": 60 }, "secret_names": { "items": { "type": "string" }, "type": "array", "title": "Secret Names", "description": "Org secrets exposed to the script as environment variables. Requires the manage-org-secrets permission whenever non-empty." }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enabled", "description": "Whether the script gates the automation's runs. Omitted keeps the current state; a new configuration starts enabled." } }, "additionalProperties": false, "type": "object", "required": [ "runtime", "source" ], "title": "AutomationScriptCheckRequest", "description": "The automation's Preflight check configuration. On update the whole\ngroup is replaced; ``enabled`` alone may be omitted to keep its state." }, "AutomationSecurityProfileResponse": { "properties": { "selection": { "type": "string", "enum": [ "inherit", "none", "profile" ], "title": "Selection", "description": "The automation's own binding: inherit (no binding), none (explicit opt-out), or profile (pins profile_id). Sessions resolve the full enterprise -> org -> automation chain: the automation's network policy only ever narrows the governing profiles' policies, and an opt-out cannot escape a mandatory org/enterprise profile." }, "profile_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Id" }, "warnings": { "items": { "type": "string" }, "type": "array", "title": "Warnings", "description": "Non-blocking configuration conflicts, e.g. a recommended MCP server whose endpoint hostname the governing profile blocks (spawned sessions will not be able to connect to that server). Only remote MCP endpoint hostnames are checked; an empty list does not guarantee every MCP or network destination will work. Populated on single-automation reads and writes; empty in list responses.", "default": [] } }, "additionalProperties": false, "type": "object", "required": [ "selection" ], "title": "AutomationSecurityProfileResponse" }, "AutomationSecurityProfileSelection": { "properties": { "profile_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Id", "description": "Security profile to bind to this automation. null records an explicit opt-out (no profile, even when the org or enterprise has a recommended default). Writing this field requires the security-profile management permission; an opt-out cannot escape a mandatory org/enterprise profile." } }, "additionalProperties": false, "type": "object", "title": "AutomationSecurityProfileSelection", "description": "The automation's own security-profile binding." }, "AutomationSessionConfig-Input": { "properties": { "repos": { "items": { "type": "string" }, "type": "array", "title": "Repos", "description": "Read-only: derived from repo tokens in the prompt.", "default": [] }, "tags": { "items": { "type": "string" }, "type": "array", "title": "Tags", "description": "Session tags. For tagging-enforced enterprises exactly one allowed value is required.", "default": [] }, "playbook_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Playbook Id", "description": "Read-only: derived from the first @playbook: token in the prompt." }, "platform": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Platform", "description": "VM platform for the session. When null, the session uses the organization's default platform at invocation time." }, "bypass_approval": { "type": "boolean", "title": "Bypass Approval", "description": "Auto-approves child-session creation (the only check this flag bypasses); any future bypassable check requires a new field.", "default": false }, "notifications": { "anyOf": [ { "$ref": "#/components/schemas/AutomationSessionNotificationsConfig" }, { "type": "null" } ], "description": "Session-content notifications (Slack and Microsoft Teams)." } }, "additionalProperties": false, "type": "object", "title": "AutomationSessionConfig" }, "AutomationSessionConfig-Output": { "properties": { "repos": { "items": { "type": "string" }, "type": "array", "title": "Repos", "description": "Read-only: derived from repo tokens in the prompt.", "default": [] }, "tags": { "items": { "type": "string" }, "type": "array", "title": "Tags", "description": "Session tags. For tagging-enforced enterprises exactly one allowed value is required.", "default": [] }, "playbook_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Playbook Id", "description": "Read-only: derived from the first @playbook: token in the prompt." }, "platform": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Platform", "description": "VM platform for the session. When null, the session uses the organization's default platform at invocation time." }, "bypass_approval": { "type": "boolean", "title": "Bypass Approval", "description": "Auto-approves child-session creation (the only check this flag bypasses); any future bypassable check requires a new field.", "default": false }, "notifications": { "anyOf": [ { "$ref": "#/components/schemas/AutomationSessionNotificationsConfig" }, { "type": "null" } ], "description": "Session-content notifications (Slack and Microsoft Teams)." } }, "additionalProperties": false, "type": "object", "title": "AutomationSessionConfig" }, "AutomationSessionNotificationsConfig": { "properties": { "slack": { "anyOf": [ { "$ref": "#/components/schemas/AutomationSessionSlackConfig" }, { "type": "null" } ], "description": "Gives the session a Slack home: two-way for post_updates/forward_thread and post_response after its initial delivery binds the thread." }, "teams": { "anyOf": [ { "$ref": "#/components/schemas/AutomationSessionTeamsConfig" }, { "type": "null" } ], "description": "Posts the session's final response to the Microsoft Teams channel as a new top-level post, then binds its thread for replies (available for any trigger). Cannot be combined with a slack post_response/post_updates home or a post_response reply." } }, "additionalProperties": false, "type": "object", "title": "AutomationSessionNotificationsConfig", "description": "Where the spawned session's content goes, as opposed to the\nautomation-level ``notifications`` group (dispatch-status pings)." }, "AutomationSessionSettings-Input": { "properties": { "devin_mode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Devin Mode", "description": "null = org default. One of normal, fast, lite, ultra, fusion, or a research preview the organization can use (see schemas.available_devin_modes). Research previews require fallback_devin_mode; a stored preview the organization can no longer use stays stored (unrelated edits preserve it) and its sessions start on fallback_devin_mode." }, "fallback_devin_mode": { "anyOf": [ { "type": "string", "enum": [ "normal", "fast", "lite", "ultra", "fusion" ] }, { "type": "null" } ], "title": "Fallback Devin Mode", "description": "Stable mode sessions start in when devin_mode is a research preview that is unavailable at run time. Required with a preview devin_mode (see schemas.default_fallback_devin_mode), rejected with a stable or null devin_mode; cleared with devin_mode." }, "net_policy": { "anyOf": [ { "$ref": "#/components/schemas/AutomationNetPolicy" }, { "type": "null" } ] } }, "additionalProperties": false, "type": "object", "title": "AutomationSessionSettings", "description": "Applied to every session this automation spawns (including monitor\nsessions)." }, "AutomationSessionSettings-Output": { "properties": { "devin_mode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Devin Mode", "description": "null = org default. One of normal, fast, lite, ultra, fusion, or a research preview the organization can use (see schemas.available_devin_modes). Research previews require fallback_devin_mode; a stored preview the organization can no longer use stays stored (unrelated edits preserve it) and its sessions start on fallback_devin_mode." }, "fallback_devin_mode": { "anyOf": [ { "type": "string", "enum": [ "normal", "fast", "lite", "ultra", "fusion" ] }, { "type": "null" } ], "title": "Fallback Devin Mode", "description": "Stable mode sessions start in when devin_mode is a research preview that is unavailable at run time. Required with a preview devin_mode (see schemas.default_fallback_devin_mode), rejected with a stable or null devin_mode; cleared with devin_mode." }, "net_policy": { "anyOf": [ { "$ref": "#/components/schemas/AutomationNetPolicy" }, { "type": "null" } ] } }, "additionalProperties": false, "type": "object", "title": "AutomationSessionSettings", "description": "Applied to every session this automation spawns (including monitor\nsessions)." }, "AutomationSessionSlackConfig": { "properties": { "mode": { "type": "string", "enum": [ "post_updates", "forward_thread", "post_response" ], "title": "Mode", "description": "post_updates: the session converses in a thread in the channel (available for non-Slack triggers). forward_thread: the same, plus a backlink posted in the triggering thread (requires a Slack trigger). post_response: the session's final response is posted to the channel as a top-level message, then its thread is bound for replies and follow-up messages (available for any trigger)." }, "channel_id": { "type": "string", "title": "Channel Id" } }, "additionalProperties": false, "type": "object", "required": [ "mode", "channel_id" ], "title": "AutomationSessionSlackConfig" }, "AutomationSessionTeamsConfig": { "properties": { "team_id": { "type": "string", "title": "Team Id", "description": "Entra group id of a team the Devin app is installed in on the organization's Microsoft Teams connection." }, "channel_id": { "type": "string", "title": "Channel Id", "description": "Conversation id of a channel in that team." } }, "additionalProperties": false, "type": "object", "required": [ "team_id", "channel_id" ], "title": "AutomationSessionTeamsConfig" }, "AutomationSlackChannel": { "properties": { "team_id": { "type": "string", "title": "Team Id" }, "channel_id": { "type": "string", "title": "Channel Id" } }, "additionalProperties": false, "type": "object", "required": [ "team_id", "channel_id" ], "title": "AutomationSlackChannel" }, "AutomationSlackMonitorConfig": { "properties": { "source_channel_id": { "type": "string", "title": "Source Channel Id" }, "team_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Team Id" } }, "additionalProperties": false, "type": "object", "required": [ "source_channel_id" ], "title": "AutomationSlackMonitorConfig" }, "AutomationSlackNotification": { "properties": { "when": { "type": "string", "enum": [ "always", "dispatch_failed", "dispatch_succeeded" ], "title": "When" }, "channel_id": { "type": "string", "title": "Channel Id" } }, "additionalProperties": false, "type": "object", "required": [ "when", "channel_id" ], "title": "AutomationSlackNotification" }, "AutomationSlackTriageConfig": { "properties": { "source_channel_id": { "type": "string", "title": "Source Channel Id", "description": "Primary Slack channel ID. Omit for a trigger without channel restrictions; every condition group must still have a completed filter.", "default": "" }, "team_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Team Id" } }, "additionalProperties": false, "type": "object", "title": "AutomationSlackTriageConfig" }, "AutomationStartCodeScanAction": { "properties": { "type": { "type": "string", "const": "start_code_scan", "title": "Type", "default": "start_code_scan" }, "scan_mode": { "type": "string", "enum": [ "single", "multi" ], "title": "Scan Mode", "default": "single" }, "repo_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Repo Name", "description": "Repository to scan (owner/name); single mode." }, "host": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Host" }, "repos": { "anyOf": [ { "items": { "$ref": "#/components/schemas/AutomationCodeScanRepo" }, "type": "array" }, { "type": "null" } ], "title": "Repos", "description": "Repositories covered by the one scan; multi mode." }, "profile_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Id" }, "scan_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scan Type" }, "code_scan_effort": { "type": "string", "enum": [ "deep", "lite" ], "title": "Code Scan Effort", "default": "deep" }, "interactive": { "type": "boolean", "title": "Interactive", "default": false }, "finding_remediation": { "anyOf": [ { "$ref": "#/components/schemas/AutomationCodeScanFindingRemediation" }, { "type": "null" } ] } }, "additionalProperties": false, "type": "object", "title": "AutomationStartCodeScanAction", "description": "Start a fresh code scan each time the automation fires. ``scan_mode``\nselects ``single`` (one scan of ``repo_name``) or ``multi`` (one scan\nspanning ``repos``)." }, "AutomationStartSessionAction-Input": { "properties": { "type": { "type": "string", "const": "start_session", "title": "Type", "default": "start_session" }, "prompt": { "type": "string", "title": "Prompt", "description": "The single source of truth: plain text with inline reference tokens (@{owner}/{repo}, @{path}, @playbook:{id}, @skills:{name}, !{macro}, ${SECRET_NAME}). Kind-prefixed tokens are validated at save; unknown ids are a 400. The triggering event's payload is appended automatically." }, "session": { "$ref": "#/components/schemas/AutomationSessionConfig-Input", "description": "Config for the spawned session." } }, "additionalProperties": false, "type": "object", "required": [ "prompt" ], "title": "AutomationStartSessionAction" }, "AutomationStartSessionAction-Output": { "properties": { "type": { "type": "string", "const": "start_session", "title": "Type", "default": "start_session" }, "prompt": { "type": "string", "title": "Prompt", "description": "The single source of truth: plain text with inline reference tokens (@{owner}/{repo}, @{path}, @playbook:{id}, @skills:{name}, !{macro}, ${SECRET_NAME}). Kind-prefixed tokens are validated at save; unknown ids are a 400. The triggering event's payload is appended automatically." }, "session": { "$ref": "#/components/schemas/AutomationSessionConfig-Output", "description": "Config for the spawned session." } }, "additionalProperties": false, "type": "object", "required": [ "prompt" ], "title": "AutomationStartSessionAction" }, "AutomationStartSessionActionUpdate": { "properties": { "type": { "type": "string", "const": "start_session", "title": "Type", "default": "start_session" }, "prompt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Prompt", "description": "The single source of truth: plain text with inline reference tokens (@{owner}/{repo}, @{path}, @playbook:{id}, @skills:{name}, !{macro}, ${SECRET_NAME}). Kind-prefixed tokens are validated at save; unknown ids are a 400. The triggering event's payload is appended automatically. Required when creating or adding this action; on a merge-semantics update, omit it to keep the stored value (null is invalid)." }, "session": { "$ref": "#/components/schemas/AutomationSessionConfig-Input", "description": "Config for the spawned session." } }, "additionalProperties": false, "type": "object", "title": "AutomationStartSessionActionUpdate" }, "AutomationStringCondition": { "properties": { "field": { "type": "string", "title": "Field" }, "operator": { "type": "string", "enum": [ "contains", "not_contains", "starts_with", "not_starts_with", "ends_with", "not_ends_with" ], "title": "Operator" }, "value": { "type": "string", "title": "Value" } }, "additionalProperties": false, "type": "object", "required": [ "field", "operator", "value" ], "title": "AutomationStringCondition" }, "AutomationTeamsChannel": { "properties": { "team_id": { "type": "string", "title": "Team Id", "description": "Entra group id of the Microsoft Teams team, or '*'." }, "channel_id": { "type": "string", "title": "Channel Id", "description": "Teams channel id ('19:...@thread.tacv2'), or '*'." } }, "additionalProperties": false, "type": "object", "required": [ "team_id", "channel_id" ], "title": "AutomationTeamsChannel" }, "AutomationTemplateResponse": { "properties": { "template_id": { "type": "string", "title": "Template Id" }, "name": { "type": "string", "title": "Name" }, "description": { "type": "string", "title": "Description" }, "category": { "type": "string", "title": "Category" }, "required_integrations": { "items": { "type": "string" }, "type": "array", "title": "Required Integrations" }, "required_mcps": { "items": { "type": "string" }, "type": "array", "title": "Required Mcps" }, "triggers": { "items": { "$ref": "#/components/schemas/AutomationTriggerRequest-Output" }, "type": "array", "title": "Triggers" }, "actions": { "items": { "oneOf": [ { "$ref": "#/components/schemas/AutomationStartSessionAction-Output" }, { "$ref": "#/components/schemas/AutomationMessageSessionAction" }, { "$ref": "#/components/schemas/AutomationMonitorSessionAction" } ], "discriminator": { "propertyName": "type", "mapping": { "message_session": "#/components/schemas/AutomationMessageSessionAction", "monitor_session": "#/components/schemas/AutomationMonitorSessionAction", "start_session": "#/components/schemas/AutomationStartSessionAction-Output" } } }, "type": "array", "title": "Actions" }, "docs_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Docs Url" }, "featured": { "type": "boolean", "title": "Featured", "default": false } }, "additionalProperties": false, "type": "object", "required": [ "template_id", "name", "description", "category", "required_integrations", "required_mcps", "triggers", "actions" ], "title": "AutomationTemplateResponse" }, "AutomationTemplatesResponse": { "properties": { "templates": { "items": { "$ref": "#/components/schemas/AutomationTemplateResponse" }, "type": "array", "title": "Templates" } }, "additionalProperties": false, "type": "object", "required": [ "templates" ], "title": "AutomationTemplatesResponse" }, "AutomationTools": { "properties": { "mcp_servers": { "items": { "type": "string" }, "type": "array", "title": "Mcp Servers", "description": "Marketplace slugs (the slug field of the mcp-servers resource, e.g. 'github', 'notion') enabled for spawned sessions. Servers installed with a personal (user-scoped) connection require run_as creator; selecting them with run_as organization is rejected when the default service user has no personal token for them, and switching an automation's run_as to organization removes them from the stored selection.", "default": [] }, "slack_channels": { "items": { "$ref": "#/components/schemas/AutomationSlackChannel" }, "type": "array", "title": "Slack Channels", "description": "Channels the session's Slack tools may post to.", "default": [] }, "slack_dm_scope": { "anyOf": [ { "type": "string", "enum": [ "org_members", "workspace" ] }, { "type": "null" } ], "title": "Slack Dm Scope", "description": "Allow spawned sessions to open 1:1 Slack DMs in the organization's connected workspaces. 'org_members' (enterprise accounts only) restricts DM targets to members of the organization; 'workspace' (non-enterprise accounts only) allows any eligible workspace member. Omit or null to disable DMs." }, "teams_channels": { "items": { "$ref": "#/components/schemas/AutomationTeamsChannel" }, "type": "array", "title": "Teams Channels", "description": "Microsoft Teams channels the session's Teams tool may read and post to. Teams must have the Devin app installed. A single {team_id: '*', channel_id: '*'} entry grants every channel of every team the Devin app is installed in. The grant is capped by the organization's Teams Default Access; the channel of a teams:message trigger is always granted.", "default": [] }, "teams_dm_scope": { "anyOf": [ { "type": "string", "const": "installed_users" }, { "type": "null" } ], "title": "Teams Dm Scope", "description": "Allow spawned sessions to open 1:1 Microsoft Teams DMs. DMs only reach users who installed the Devin app in Teams personally. Capped by Teams Default Access and the governing security profile." }, "linear_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Linear Enabled", "description": "Grant Linear tools." }, "jira_projects": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "minItems": 1 }, { "type": "null" } ], "title": "Jira Projects", "description": "Jira project ids the session's Jira tools are limited to. Null (the default) allows every project the run identity can access. Projects required by the automation's Jira triggers are always included. While a project list is set, the Atlassian MCP server is not loaded, since it cannot be limited to projects. On update, omitting this member keeps the stored list; send null to clear it." } }, "additionalProperties": false, "type": "object", "title": "AutomationTools" }, "AutomationTriageSessionAction": { "properties": { "type": { "type": "string", "const": "triage_session", "title": "Type", "default": "triage_session" }, "kind": { "type": "string", "enum": [ "auto_triage", "generic_assistant" ], "title": "Kind", "description": "Which persona the session runs: the issue-tracking auto-triage agent or the general-purpose assistant.", "default": "auto_triage" }, "setup_prompt": { "type": "string", "title": "Setup Prompt", "description": "How to triage the channel: what counts as an issue, how to investigate, and where to route findings." }, "slack_triage_config": { "$ref": "#/components/schemas/AutomationSlackTriageConfig", "description": "Slack triage configuration. Use {} when the trigger has no channel restriction; routing comes from each matching Slack message." } }, "additionalProperties": false, "type": "object", "required": [ "setup_prompt", "slack_triage_config" ], "title": "AutomationTriageSessionAction", "description": "Auto-triage v2: each message in the source Slack channel is grouped\ninto a tracked issue by a per-automation grouping session; genuinely new\nissues spawn an investigation session." }, "AutomationTriageSessionActionUpdate": { "properties": { "type": { "type": "string", "const": "triage_session", "title": "Type", "default": "triage_session" }, "kind": { "type": "string", "enum": [ "auto_triage", "generic_assistant" ], "title": "Kind", "description": "Which persona the session runs: the issue-tracking auto-triage agent or the general-purpose assistant.", "default": "auto_triage" }, "setup_prompt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Setup Prompt", "description": "How to triage the channel: what counts as an issue, how to investigate, and where to route findings. Required when creating or adding this action; on a merge-semantics update, omit it to keep the stored value (null is invalid)." }, "slack_triage_config": { "anyOf": [ { "$ref": "#/components/schemas/AutomationSlackTriageConfig" }, { "type": "null" } ], "description": "Requires exactly one slack:message trigger on the same channel. Required when creating or adding this action; on a merge-semantics update, omit it to keep the stored value (null is invalid)." } }, "additionalProperties": false, "type": "object", "title": "AutomationTriageSessionActionUpdate" }, "AutomationTriggerRequest-Input": { "properties": { "event_type": { "type": "string", "enum": [ "github:issue_comment", "github:issues", "github:pull_request", "github:pull_request_review", "github:pull_request_review_comment", "github:check_run", "github:workflow_run", "github:push", "gitlab:merge_request", "gitlab:note", "gitlab:issue", "gitlab:issue_note", "gitlab:push", "gitlab:pipeline", "azure_devops:pull_request", "azure_devops:pull_request_comment", "azure_devops:push", "azure_devops:build", "bitbucket_data_center:pull_request", "bitbucket_data_center:pull_request_comment", "bitbucket_data_center:push", "schedule:recurring", "slack:message", "slack:reaction_added", "slack:usergroup_mentioned", "slack:app_mentioned", "teams:message", "teams:reaction_added", "linear:create", "linear:label_added", "linear:assigned", "linear:status_changed", "linear:priority_changed", "linear:moved", "jira:issue_created", "jira:issue_updated", "jira:label_added", "jira:status_changed", "jira:assigned", "jira:commented", "pylon:issue_created", "pylon:issue_tag_added", "pylon:issue_status_changed", "incident_io:incident_created", "incident_io:status_changed", "incident_io:severity_changed", "incident_io:follow_up_created", "pagerduty:incident_triggered", "pagerduty:incident_acknowledged", "pagerduty:incident_resolved", "pagerduty:incident_updated", "webhook:incoming", "snapshot_build:completed", "board:ticket_updated" ], "title": "Event Type", "description": "Trigger event type, e.g. 'github:pull_request'." }, "conditions": { "anyOf": [ { "$ref": "#/components/schemas/AutomationConditions-Input" }, { "type": "null" } ], "description": "null matches every event, except Slack message triggers require a channel restriction or at least one completed filter in every group. is_thread_reply alone does not satisfy this requirement." }, "replies": { "items": { "$ref": "#/components/schemas/AutomationReply" }, "type": "array", "title": "Replies", "description": "Where this trigger's session binds and its response is delivered. Only the matched trigger's replies execute, all entries independently; entries are deduplicated.", "default": [] } }, "additionalProperties": false, "type": "object", "required": [ "event_type" ], "title": "AutomationTriggerRequest" }, "AutomationTriggerRequest-Output": { "properties": { "event_type": { "type": "string", "enum": [ "github:issue_comment", "github:issues", "github:pull_request", "github:pull_request_review", "github:pull_request_review_comment", "github:check_run", "github:workflow_run", "github:push", "gitlab:merge_request", "gitlab:note", "gitlab:issue", "gitlab:issue_note", "gitlab:push", "gitlab:pipeline", "azure_devops:pull_request", "azure_devops:pull_request_comment", "azure_devops:push", "azure_devops:build", "bitbucket_data_center:pull_request", "bitbucket_data_center:pull_request_comment", "bitbucket_data_center:push", "schedule:recurring", "slack:message", "slack:reaction_added", "slack:usergroup_mentioned", "slack:app_mentioned", "teams:message", "teams:reaction_added", "linear:create", "linear:label_added", "linear:assigned", "linear:status_changed", "linear:priority_changed", "linear:moved", "jira:issue_created", "jira:issue_updated", "jira:label_added", "jira:status_changed", "jira:assigned", "jira:commented", "pylon:issue_created", "pylon:issue_tag_added", "pylon:issue_status_changed", "incident_io:incident_created", "incident_io:status_changed", "incident_io:severity_changed", "incident_io:follow_up_created", "pagerduty:incident_triggered", "pagerduty:incident_acknowledged", "pagerduty:incident_resolved", "pagerduty:incident_updated", "webhook:incoming", "snapshot_build:completed", "board:ticket_updated" ], "title": "Event Type", "description": "Trigger event type, e.g. 'github:pull_request'." }, "conditions": { "anyOf": [ { "$ref": "#/components/schemas/AutomationConditions-Output" }, { "type": "null" } ], "description": "null matches every event, except Slack message triggers require a channel restriction or at least one completed filter in every group. is_thread_reply alone does not satisfy this requirement." }, "replies": { "items": { "$ref": "#/components/schemas/AutomationReply" }, "type": "array", "title": "Replies", "description": "Where this trigger's session binds and its response is delivered. Only the matched trigger's replies execute, all entries independently; entries are deduplicated.", "default": [] } }, "additionalProperties": false, "type": "object", "required": [ "event_type" ], "title": "AutomationTriggerRequest" }, "AutomationTriggerResponse": { "properties": { "trigger_id": { "type": "string", "title": "Trigger Id", "description": "Re-minted when triggers is replaced \u2014 not stable across edits." }, "event_type": { "type": "string", "title": "Event Type" }, "conditions": { "anyOf": [ { "$ref": "#/components/schemas/AutomationConditions-Output" }, { "type": "null" } ] }, "replies": { "items": { "$ref": "#/components/schemas/AutomationReply" }, "type": "array", "title": "Replies", "default": [] }, "webhook": { "anyOf": [ { "$ref": "#/components/schemas/AutomationWebhookResponse" }, { "type": "null" } ], "description": "Only on webhook:incoming triggers." } }, "additionalProperties": false, "type": "object", "required": [ "trigger_id", "event_type" ], "title": "AutomationTriggerResponse" }, "AutomationUpdateRequest": { "properties": { "name": { "anyOf": [ { "type": "string", "maxLength": 500, "minLength": 1 }, { "type": "null" } ], "title": "Name" }, "triggers": { "anyOf": [ { "items": { "$ref": "#/components/schemas/AutomationTriggerRequest-Input" }, "type": "array" }, { "type": "null" } ], "title": "Triggers" }, "actions": { "anyOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/AutomationStartSessionActionUpdate" }, { "$ref": "#/components/schemas/AutomationMessageSessionActionUpdate" }, { "$ref": "#/components/schemas/AutomationMonitorSessionActionUpdate" } ], "discriminator": { "propertyName": "type", "mapping": { "message_session": "#/components/schemas/AutomationMessageSessionActionUpdate", "monitor_session": "#/components/schemas/AutomationMonitorSessionActionUpdate", "start_session": "#/components/schemas/AutomationStartSessionActionUpdate" } } }, "type": "array" }, { "type": "null" } ], "title": "Actions" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enabled" }, "notifications": { "anyOf": [ { "$ref": "#/components/schemas/AutomationNotifications" }, { "type": "null" } ] }, "tools": { "anyOf": [ { "$ref": "#/components/schemas/AutomationTools" }, { "type": "null" } ] }, "metadata": { "anyOf": [ { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": "object" }, { "type": "null" } ], "title": "Metadata" }, "limits": { "anyOf": [ { "$ref": "#/components/schemas/AutomationLimits" }, { "type": "null" } ] }, "concurrency": { "anyOf": [ { "$ref": "#/components/schemas/AutomationConcurrency" }, { "type": "null" } ] }, "session_settings": { "anyOf": [ { "$ref": "#/components/schemas/AutomationSessionSettings-Input" }, { "type": "null" } ] }, "security_profile": { "anyOf": [ { "$ref": "#/components/schemas/AutomationSecurityProfileSelection" }, { "type": "null" } ], "description": "The automation's own security-profile binding: a profile_id pins that profile, {\"profile_id\": null} records an explicit opt-out, and explicit null reverts to inheriting from the org/enterprise. Requires the security-profile management permission." }, "run_as": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/AutomationRunAsOrganization" }, { "$ref": "#/components/schemas/AutomationRunAsCreator" }, { "$ref": "#/components/schemas/AutomationRunAsServiceUser" } ], "description": "Identity the spawned sessions run under. organization: the org's automation identity. When the organization has a default service user for automations, sessions run as that service user and the response returns run_as service_user with its id; saving requires every permission that service user holds. Without one, creating an automation or saving an enabled one is rejected. MCP servers installed with a personal (user-scoped) connection that service user has not connected cannot be selected, and switching an automation to organization removes them from its selection. creator: personal automation \u2014 runs with the creator's own permissions and is visible only to the creator and org admins; rejected for service-user-created automations. service_user: runs as the given service user, with its roles, grants and ACU limits; requires permission to manage that service user. Required on create; null on update resets to organization.", "discriminator": { "propertyName": "type", "mapping": { "creator": "#/components/schemas/AutomationRunAsCreator", "organization": "#/components/schemas/AutomationRunAsOrganization", "service_user": "#/components/schemas/AutomationRunAsServiceUser" } } }, { "type": "null" } ], "title": "Run As", "description": "null resets to organization." }, "slack_reply_access": { "anyOf": [ { "type": "string", "enum": [ "devin_users", "slack_users", "external_slack_users" ] }, { "type": "null" } ], "title": "Slack Reply Access", "description": "null resets to slack_users." }, "teams_reply_access": { "anyOf": [ { "type": "string", "enum": [ "devin_users", "teams_users" ] }, { "type": "null" } ], "title": "Teams Reply Access", "description": "null resets to teams_users." }, "script_check": { "$ref": "#/components/schemas/AutomationScriptCheckRequest", "title": "Script Check", "description": "Replace the automation's script Preflight check (script, runtime, timeout, secrets, enabled state). Omitted keeps the current one; null is rejected, disable it with enabled=false instead." }, "llm_check": { "$ref": "#/components/schemas/AutomationLlmCheckRequest", "title": "Llm Check", "description": "Replace the automation's LLM check (filter prompt and enabled state). Omitted keeps the current one; null is rejected, disable it with enabled=false instead." } }, "additionalProperties": false, "type": "object", "title": "AutomationUpdateRequest", "description": "PATCH fields merge member-wise by default: omitted members are kept,\nexplicit nulls clear, and empty groups are no-ops. Metadata merges per key,\nwith null values deleting keys. Lists replace wholesale (deletion = resend\nthe list without the element), while each sent element merges onto the\nstored element of the same type when that type occurs exactly once on both\nsides. Element members that are required on create (``prompt``,\n``setup_prompt``, the monitor/triage slack configs, ``scan_id``) may be\nomitted when a counterpart exists \u2014 they carry like any other member;\nexplicit null is rejected." }, "AutomationWebhookResponse": { "properties": { "url": { "type": "string", "title": "Url", "description": "The inbox external systems POST to (header X-Webhook-Secret)." }, "secret": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Secret", "description": "Present only when newly minted (create or re-add); never retrievable again. Replacing triggers preserves the existing secret." } }, "additionalProperties": false, "type": "object", "required": [ "url" ], "title": "AutomationWebhookResponse" }, "Blueprint": { "properties": { "blueprint_id": { "type": "string", "title": "Blueprint Id" }, "type": { "type": "string", "enum": [ "enterprise", "org", "repo" ], "title": "Type" }, "repo_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Repo Name" }, "source": { "anyOf": [ { "type": "string", "enum": [ "git", "database" ] }, { "type": "null" } ], "title": "Source", "description": "Where the YAML is authored: 'git' (synced from .devin/blueprint.yaml in the repo) or 'database' (edited via the API/UI). Always null for enterprise- and org-tier blueprints." }, "build_on_default_branch_commit": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Build On Default Branch Commit", "description": "Whether each push to the repo's default branch builds the environment. Null unless this is a repo's root blueprint." }, "report_check_runs": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Report Check Runs", "description": "Whether each commit build is reported as a GitHub check run on the commit. Null unless this is a repo's root blueprint." }, "created_at": { "type": "integer", "title": "Created At" }, "updated_at": { "type": "integer", "title": "Updated At" } }, "type": "object", "required": [ "blueprint_id", "type", "repo_name", "created_at", "updated_at" ], "title": "Blueprint", "description": "Public ``Blueprint`` resource shape.\n\nNote: the ``type`` enum may grow in the future; clients MUST gracefully\nhandle unknown values. YAML contents are fetched separately via\n``GET /blueprints/{id}/contents``." }, "BlueprintFile": { "properties": { "file_id": { "type": "string", "title": "File Id" }, "blueprint_id": { "type": "string", "title": "Blueprint Id" }, "name": { "type": "string", "title": "Name" }, "env_var_name": { "type": "string", "title": "Env Var Name" }, "size_bytes": { "type": "integer", "title": "Size Bytes" }, "created_at": { "type": "integer", "title": "Created At" }, "updated_at": { "type": "integer", "title": "Updated At" } }, "type": "object", "required": [ "file_id", "blueprint_id", "name", "env_var_name", "size_bytes", "created_at", "updated_at" ], "title": "BlueprintFile", "description": "Public ``BlueprintFile`` resource shape." }, "BlueprintFileList": { "properties": { "data": { "items": { "$ref": "#/components/schemas/BlueprintFile" }, "type": "array", "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "BlueprintFileList", "description": "List envelope for blueprint files." }, "BlueprintList": { "properties": { "data": { "items": { "$ref": "#/components/schemas/Blueprint" }, "type": "array", "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "BlueprintList", "description": "List envelope for blueprints (returned in execution order)." }, "Body_handle_upload_attachment_v3_organizations__org_id__attachments_post": { "properties": { "file": { "type": "string", "contentMediaType": "application/octet-stream", "title": "File" } }, "type": "object", "required": [ "file" ], "title": "Body_handle_upload_attachment_v3_organizations__org_id__attachments_post" }, "Body_upload_enterprise_blueprint_file_endpoint_v3_enterprise_snapshot_setup_blueprints__blueprint_id__files_post": { "properties": { "file": { "type": "string", "contentMediaType": "application/octet-stream", "title": "File" } }, "type": "object", "required": [ "file" ], "title": "Body_upload_enterprise_blueprint_file_endpoint_v3_enterprise_snapshot_setup_blueprints__blueprint_id__files_post" }, "Body_upload_org_blueprint_file_v3_organizations__org_id__snapshot_setup_blueprints__blueprint_id__files_post": { "properties": { "file": { "type": "string", "contentMediaType": "application/octet-stream", "title": "File" } }, "type": "object", "required": [ "file" ], "title": "Body_upload_org_blueprint_file_v3_organizations__org_id__snapshot_setup_blueprints__blueprint_id__files_post" }, "Build": { "properties": { "build_id": { "type": "string", "title": "Build Id" }, "status": { "type": "string", "enum": [ "pending", "running", "succeeded", "failed", "cancelled" ], "title": "Status" }, "trigger": { "anyOf": [ { "type": "string", "enum": [ "manual", "auto" ] }, { "type": "null" } ], "title": "Trigger" }, "triggered_by_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Triggered By User Id" }, "pinned": { "type": "boolean", "title": "Pinned" }, "started_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Started At" }, "completed_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Completed At" }, "created_at": { "type": "integer", "title": "Created At" }, "updated_at": { "type": "integer", "title": "Updated At" } }, "type": "object", "required": [ "build_id", "status", "trigger", "triggered_by_user_id", "pinned", "started_at", "completed_at", "created_at", "updated_at" ], "title": "Build", "description": "Public ``Build`` resource shape \u2014 opaque \"did this succeed yet?\" view.\n\nPer spec, no platform/snapshot/per-job introspection is exposed. Future\nadditions (``triggered_by_repo``, build metadata, etc.) are additive." }, "BulkIndexRepositoriesRequest": { "properties": { "repositories": { "items": { "$ref": "#/components/schemas/RepositoryIndexingItem" }, "type": "array", "maxItems": 100, "minItems": 1, "title": "Repositories" } }, "type": "object", "required": [ "repositories" ], "title": "BulkIndexRepositoriesRequest" }, "CancelCodeScanResponse": { "properties": { "scan_id": { "type": "string", "title": "Scan Id", "description": "The cancelled scan." }, "status": { "type": "string", "const": "cancelled", "title": "Status", "description": "Scan status after cancellation." }, "session_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Session Id", "description": "The archived scan session, or null for a queued scan." } }, "type": "object", "required": [ "scan_id", "status", "session_id" ], "title": "CancelCodeScanResponse", "description": "A cancelled scan retained with its findings and schedule." }, "CategoryMetrics": { "properties": { "category": { "type": "string", "title": "Category" }, "sessions_count": { "type": "integer", "title": "Sessions Count" }, "acus": { "type": "number", "title": "Acus" }, "subcategories": { "items": { "$ref": "#/components/schemas/SubcategoryMetrics" }, "type": "array", "title": "Subcategories" } }, "type": "object", "required": [ "category", "sessions_count", "acus", "subcategories" ], "title": "CategoryMetrics" }, "CodeScanAttachmentResponse": { "properties": { "url": { "type": "string", "title": "Url", "description": "Devin attachment URL of the file." }, "filename": { "type": "string", "title": "Filename", "description": "Name of the attached file." } }, "type": "object", "required": [ "url", "filename" ], "title": "CodeScanAttachmentResponse", "description": "A file attached to a code scan at creation." }, "CodeScanAutoScanResponse": { "properties": { "automation_id": { "type": "string", "title": "Automation Id", "description": "Automation driving the recurring scan." }, "rrule": { "type": "string", "title": "Rrule", "description": "Recurring scan schedule as an iCal RRULE." }, "enabled": { "type": "boolean", "title": "Enabled", "description": "Whether the recurring scan schedule is enabled." } }, "type": "object", "required": [ "automation_id", "rrule", "enabled" ], "title": "CodeScanAutoScanResponse" }, "CodeScanCreateRequest": { "properties": { "repo_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Repo Name", "description": "Full name of the repository to scan. Provide exactly one of repo_name or repos." }, "host": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Host", "description": "Git host of the repository, if known." }, "repos": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ScanRepoRequest" }, "type": "array", "maxItems": 500 }, { "type": "null" } ], "title": "Repos", "description": "Repositories covered by one scan; the first entry is the scan's primary repository. Provide exactly one of repo_name or repos." }, "profile_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Id", "description": "Scan profile to apply to the scan." }, "scan_type": { "anyOf": [ { "type": "string", "enum": [ "security", "performance", "db-queries", "test-coverage", "dead-code", "code-quality", "cleanup", "telemetry", "accessibility", "compliance", "general", "migration-docs", "red-team" ] }, { "type": "null" } ], "title": "Scan Type", "description": "Type of scan to run. Must match the profile's scan type when a profile is given; defaults to the profile's type, or 'security' for profile-less scans. Non-security types require a profile and are rejected without one." }, "commit_sha": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Commit Sha", "description": "Commit to check out before scanning." }, "effort": { "anyOf": [ { "type": "string", "enum": [ "normal", "deep" ] }, { "type": "null" } ], "title": "Effort", "description": "Scan effort: 'normal' (default) uses lower model reasoning effort with larger investigation batches; 'deep' runs the full pipeline." }, "interactive": { "type": "boolean", "title": "Interactive", "description": "When true, the scan pauses for user review between threat modeling and investigation.", "default": false }, "devin_mode": { "anyOf": [ { "type": "string", "enum": [ "fusion", "swe-2" ] }, { "type": "null" } ], "title": "Devin Mode", "description": "Agent the scan's sessions run on: 'fusion' or 'swe-2' (SWE-2 Max for 'deep' effort, SWE-2 High for 'normal'). Applies only when the mode is enabled for the organization; otherwise, and when omitted, the scan runs on the default agent." }, "platform": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "title": "Platform", "description": "Where the scan's sessions run: a platform label configured for the organization (e.g. 'linux', 'windows', 'macos') or the name of an outpost (BYOB) pool, case-insensitive; platforms take priority when a name matches both. Omitted means the organization default. Unrecognized values are rejected with a 400 whose error body lists the available platform labels and outpost pool names." }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Locale", "description": "BCP-47 language tag (e.g. 'ja') for the scan's user-facing output: finding titles, descriptions, and reports. Omitted means English." } }, "type": "object", "title": "CodeScanCreateRequest", "description": "Request body for starting a new code scan." }, "CodeScanEffortResponse": { "properties": { "scan_id": { "type": "string", "title": "Scan Id", "description": "Unique identifier for the scan." }, "effort": { "type": "string", "enum": [ "normal", "deep" ], "title": "Effort", "description": "Effort applied to future incremental runs of the scan." } }, "type": "object", "required": [ "scan_id", "effort" ], "title": "CodeScanEffortResponse", "description": "Effort configured on a scan." }, "CodeScanEffortUpdateRequest": { "properties": { "effort": { "type": "string", "enum": [ "normal", "deep" ], "title": "Effort", "description": "Effort to apply to future incremental runs of the scan: 'normal' uses lower model reasoning effort with larger investigation batches; 'deep' runs the full pipeline." } }, "type": "object", "required": [ "effort" ], "title": "CodeScanEffortUpdateRequest", "description": "Request to change the effort configured on a scan." }, "CodeScanFindingResponse": { "properties": { "finding_id": { "type": "string", "title": "Finding Id", "description": "Unique identifier for the finding." }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title", "description": "Title of the finding, if any." }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Detailed description of the vulnerability, if any." }, "recommendation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Recommendation", "description": "Suggested remediation for the finding, if any." }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note", "description": "Additional note attached to the finding, if any." }, "related_finding_ids": { "items": { "type": "string" }, "type": "array", "title": "Related Finding Ids", "description": "Finding IDs of the other links in a realized attack chain. Set only on the chain's sink finding." }, "code_owners": { "items": { "type": "string" }, "type": "array", "title": "Code Owners", "description": "Code owners associated with the affected code." }, "reference_snippets": { "items": { "$ref": "#/components/schemas/CodeScanReferenceSnippetResponse" }, "type": "array", "title": "Reference Snippets", "description": "Code snippets referenced by the finding as supporting evidence." }, "severity": { "type": "string", "enum": [ "critical", "high", "medium", "low" ], "title": "Severity", "description": "Severity of the finding: critical, high, medium, or low." }, "fix_effort": { "anyOf": [ { "type": "string", "enum": [ "small", "large" ] }, { "type": "null" } ], "title": "Fix Effort", "description": "Size of the fix as rated by the scan: small or large. Null when the finding has not been rated." }, "payoff": { "anyOf": [ { "type": "string", "enum": [ "quick_win", "big_fix", "easy_fix", "deprioritize" ] }, { "type": "null" } ], "title": "Payoff", "description": "Severity x fix_effort quadrant: quick_win (critical/high, small fix), big_fix (critical/high, large fix), easy_fix (medium/low, small fix), deprioritize (medium/low, large fix). Null when unrated." }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category", "description": "Category (rule name) the finding was classified under, if any." }, "repo_name": { "type": "string", "title": "Repo Name", "description": "Repository the finding was reported in." }, "pr_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pr Url", "description": "URL of the remediation PR opened for this finding, if any." }, "scan_id": { "type": "string", "title": "Scan Id", "description": "Identifier of the scan that produced the finding." }, "code_scan_run_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code Scan Run Id", "description": "Identifier of the scan run that produced the finding, if known." }, "session_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Session Id", "description": "Session that remediated the finding (and opened the PR), if any." }, "orchestrator_session_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Orchestrator Session Id", "description": "Orchestrator session that ran the scan that produced the finding (the scan's Devin session), if any." }, "validation_result": { "anyOf": [ { "type": "string", "enum": [ "confirmed", "false_positive", "inconclusive" ] }, { "type": "null" } ], "title": "Validation Result", "description": "Recorded runtime validation outcome, if any: confirmed, false_positive, or inconclusive." }, "validation_session_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Validation Session Id", "description": "Session that recorded the runtime validation outcome, if any." }, "validation_evidence": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Validation Evidence", "description": "Evidence summary recorded by runtime validation, if any." }, "validation_artifacts": { "items": { "type": "string" }, "type": "array", "title": "Validation Artifacts", "description": "Attachment URLs recorded by runtime validation." }, "status": { "type": "string", "enum": [ "open", "dismissed", "resolved" ], "title": "Status", "description": "Finding status: open, dismissed, or resolved." }, "dismissal_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Dismissal Reason", "description": "Why the finding was dismissed (e.g. duplicate, false_positive), if it is dismissed and a reason was recorded." }, "created_at": { "type": "integer", "title": "Created At", "description": "When the finding was created (unix seconds)." }, "updated_at": { "type": "integer", "title": "Updated At", "description": "When the finding was last updated (unix seconds)." }, "threat_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Threat Id", "description": "The linked threat." } }, "type": "object", "required": [ "finding_id", "title", "description", "recommendation", "note", "code_owners", "reference_snippets", "severity", "category", "repo_name", "pr_url", "scan_id", "code_scan_run_id", "session_id", "orchestrator_session_id", "status", "created_at", "updated_at" ], "title": "CodeScanFindingResponse", "description": "A single code scan finding." }, "CodeScanFindingStatusResponse": { "properties": { "finding_id": { "type": "string", "title": "Finding Id", "description": "Unique identifier for the finding." }, "scan_id": { "type": "string", "title": "Scan Id", "description": "Scan that produced the finding." }, "status": { "type": "string", "enum": [ "open", "dismissed", "resolved" ], "title": "Status", "description": "Updated finding status." }, "session_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Session Id", "description": "Linked remediation session, if any. Cleared when reopened." } }, "type": "object", "required": [ "finding_id", "scan_id", "status", "session_id" ], "title": "CodeScanFindingStatusResponse" }, "CodeScanFindingStatusUpdateRequest": { "properties": { "status": { "type": "string", "enum": [ "open", "dismissed", "resolved" ], "title": "Status", "description": "New finding status. Reopening clears the remediation session link." }, "dismissal_reason": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ], "title": "Dismissal Reason", "description": "Why the finding was dismissed; only stored when status is dismissed." }, "dismissal_note": { "anyOf": [ { "type": "string", "maxLength": 5000 }, { "type": "null" } ], "title": "Dismissal Note", "description": "Free-form dismissal note; only stored when status is dismissed." }, "resolution_note": { "anyOf": [ { "type": "string", "maxLength": 5000 }, { "type": "null" } ], "title": "Resolution Note", "description": "How the finding was fixed; only stored when status is resolved." } }, "type": "object", "required": [ "status" ], "title": "CodeScanFindingStatusUpdateRequest" }, "CodeScanFindingsSelection": { "properties": { "status": { "anyOf": [ { "type": "string", "enum": [ "open", "dismissed", "resolved" ] }, { "type": "null" } ], "title": "Status", "description": "Only findings with this current status." }, "repo_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Repo Name", "description": "Only findings reported in this repository." }, "severity": { "anyOf": [ { "items": { "type": "string", "enum": [ "critical", "high", "medium", "low" ] }, "type": "array", "maxItems": 4, "minItems": 1 }, { "type": "null" } ], "title": "Severity", "description": "Only findings with any of these severities (critical, high, medium, low)." } }, "additionalProperties": false, "type": "object", "title": "CodeScanFindingsSelection", "description": "Filters selecting findings of a scan for a bulk status update." }, "CodeScanFindingsStatusResponse": { "properties": { "findings": { "items": { "$ref": "#/components/schemas/CodeScanFindingStatusResponse" }, "type": "array", "title": "Findings", "description": "The updated findings: in request order with duplicates removed for `finding_ids`, by severity (critical first) for `select_all`." } }, "type": "object", "required": [ "findings" ], "title": "CodeScanFindingsStatusResponse" }, "CodeScanFindingsStatusUpdateRequest": { "properties": { "finding_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "maxItems": 1000, "minItems": 1 }, { "type": "null" } ], "title": "Finding Ids", "description": "Findings to update; all must belong to the scan. The update is all or nothing: if any finding is missing, none is updated." }, "select_all": { "anyOf": [ { "$ref": "#/components/schemas/CodeScanFindingsSelection" }, { "type": "null" } ], "description": "Update every finding of the scan matching these filters, minus `exclude_finding_ids`. Fails with 400 when no finding or more than 1000 findings match." }, "exclude_finding_ids": { "items": { "type": "string" }, "type": "array", "maxItems": 1000, "title": "Exclude Finding Ids", "description": "With `select_all`: findings to leave out of the selection." }, "status": { "type": "string", "enum": [ "open", "dismissed", "resolved" ], "title": "Status", "description": "New status for every finding. Reopening clears the remediation session link." }, "dismissal_reason": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ], "title": "Dismissal Reason", "description": "Why the findings were dismissed; only stored when status is dismissed." }, "dismissal_note": { "anyOf": [ { "type": "string", "maxLength": 5000 }, { "type": "null" } ], "title": "Dismissal Note", "description": "Free-form dismissal note applied to every finding; only stored when status is dismissed." }, "resolution_note": { "anyOf": [ { "type": "string", "maxLength": 5000 }, { "type": "null" } ], "title": "Resolution Note", "description": "How the findings were fixed, applied to every finding; only stored when status is resolved." } }, "type": "object", "required": [ "status" ], "title": "CodeScanFindingsStatusUpdateRequest", "description": "Findings of one scan to update. Provide exactly one of ``finding_ids``\nor ``select_all``." }, "CodeScanMetricsResponse": { "properties": { "scans_count": { "type": "integer", "title": "Scans Count", "description": "Number of code scans created within the specified time range." }, "repos_scanned_count": { "type": "integer", "title": "Repos Scanned Count", "description": "Number of distinct repositories scanned." }, "prs_created_count": { "type": "integer", "title": "Prs Created Count", "description": "Number of PRs created by the scans' remediation sessions." }, "prs_open_count": { "type": "integer", "title": "Prs Open Count", "description": "Number of remediation PRs currently in the open state." }, "prs_merged_count": { "type": "integer", "title": "Prs Merged Count", "description": "Number of remediation PRs merged." }, "prs_closed_count": { "type": "integer", "title": "Prs Closed Count", "description": "Number of remediation PRs closed without being merged." }, "avg_pr_time_to_merge_seconds": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Avg Pr Time To Merge Seconds", "description": "Average time from PR creation to merge, in seconds. Null when no PRs have been merged." }, "avg_pr_open_duration_seconds": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Avg Pr Open Duration Seconds", "description": "Average time a PR is (or was) open, in seconds: creation to merge/close for finished PRs, creation to now for open PRs. Null when no PRs were created." }, "open_critical_findings_count": { "type": "integer", "title": "Open Critical Findings Count", "description": "Number of open findings with critical severity." }, "open_high_findings_count": { "type": "integer", "title": "Open High Findings Count", "description": "Number of open findings with high severity." }, "open_medium_findings_count": { "type": "integer", "title": "Open Medium Findings Count", "description": "Number of open findings with medium severity." }, "open_low_findings_count": { "type": "integer", "title": "Open Low Findings Count", "description": "Number of open findings with low severity." } }, "type": "object", "required": [ "scans_count", "repos_scanned_count", "prs_created_count", "prs_open_count", "prs_merged_count", "prs_closed_count", "avg_pr_time_to_merge_seconds", "avg_pr_open_duration_seconds", "open_critical_findings_count", "open_high_findings_count", "open_medium_findings_count", "open_low_findings_count" ], "title": "CodeScanMetricsResponse", "description": "Response model for code scan metrics.\n\nAll metrics are scoped to code scans created within the specified time\nrange: findings and remediation PRs are attributed to the scan that\nproduced them." }, "CodeScanProfileDetailResponse": { "properties": { "profile_id": { "type": "string", "title": "Profile Id", "description": "Unique identifier for the profile." }, "name": { "type": "string", "title": "Name", "description": "Name of the profile." }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Description of the profile, if any." }, "visibility": { "type": "string", "enum": [ "org", "account" ], "title": "Visibility", "description": "Whether the profile is owned by a single organization or shared across the whole account." }, "org_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Org Id", "description": "Organization that owns the profile. Null when the profile is shared account-wide." }, "scan_type": { "type": "string", "enum": [ "security", "performance", "db-queries", "test-coverage", "dead-code", "code-quality", "cleanup", "telemetry", "accessibility", "compliance", "general", "migration-docs", "red-team" ], "title": "Scan Type", "description": "Type of scan the profile configures." }, "mode": { "type": "string", "enum": [ "discover", "ingest" ], "title": "Mode", "description": "Profile mode: discover or ingest." }, "include_globs": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Include Globs", "description": "Glob patterns of files to include in the scan, if any." }, "exclude_globs": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Exclude Globs", "description": "Glob patterns of files to exclude from the scan, if any." }, "scan_paths": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Scan Paths", "description": "Repository-relative paths the scan is restricted to, if any. Null or empty means the whole repository." }, "batch_size": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Batch Size", "description": "Max files with signals per investigation batch, if set. Null means the scan uses the default. Can only be set on staging." }, "threat_model_guidance": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Threat Model Guidance", "description": "Guidance describing the threat model, if any." }, "investigation_guidance": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Investigation Guidance", "description": "Guidance for the investigation phase, if any." }, "triage_guidance": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Triage Guidance", "description": "Guidance for the triage phase, if any." }, "validation_guidance": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Validation Guidance", "description": "Guidance for the validation phase, if any." }, "validation_severities": { "anyOf": [ { "items": { "type": "string", "enum": [ "critical", "high", "medium", "low" ] }, "type": "array" }, { "type": "null" } ], "title": "Validation Severities", "description": "Finding severities runtime validation covers. Null means the default." }, "report_guidance": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Report Guidance", "description": "Guidance for the report phase, if any." }, "communication_guidance": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Communication Guidance", "description": "Guidance for the communication phase (acting on final findings, e.g. notifying owners or stakeholders), if any." }, "remediation_guidance": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Remediation Guidance", "description": "Guidance for the remediation phase, if any." }, "ingestion_source_guidance": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ingestion Source Guidance", "description": "Guidance describing the ingestion source, if any." }, "post_ingestion_guidance": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Post Ingestion Guidance", "description": "Guidance for the post-ingestion phase, if any." }, "type_config": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Type Config", "description": "Configuration specific to the profile's scan type, if any (e.g. a compliance profile's system, framework and criteria)." }, "created_at": { "type": "integer", "title": "Created At", "description": "When the profile was created (unix seconds)." } }, "type": "object", "required": [ "profile_id", "name", "description", "visibility", "org_id", "scan_type", "mode", "include_globs", "exclude_globs", "threat_model_guidance", "investigation_guidance", "triage_guidance", "validation_guidance", "report_guidance", "remediation_guidance", "ingestion_source_guidance", "post_ingestion_guidance", "created_at" ], "title": "CodeScanProfileDetailResponse", "description": "Full details of a code scan profile, including its guidance." }, "CodeScanProfileResponse": { "properties": { "profile_id": { "type": "string", "title": "Profile Id", "description": "Unique identifier for the profile." }, "name": { "type": "string", "title": "Name", "description": "Name of the profile." } }, "type": "object", "required": [ "profile_id", "name" ], "title": "CodeScanProfileResponse", "description": "Summary of the profile a scan ran under." }, "CodeScanProfileSummaryResponse": { "properties": { "profile_id": { "type": "string", "title": "Profile Id", "description": "Unique identifier for the profile." }, "name": { "type": "string", "title": "Name", "description": "Name of the profile." }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Description of the profile, if any." }, "visibility": { "type": "string", "enum": [ "org", "account" ], "title": "Visibility", "description": "Whether the profile is owned by a single organization or shared across the whole account." }, "org_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Org Id", "description": "Organization that owns the profile. Null when the profile is shared account-wide." }, "scan_type": { "type": "string", "enum": [ "security", "performance", "db-queries", "test-coverage", "dead-code", "code-quality", "cleanup", "telemetry", "accessibility", "compliance", "general", "migration-docs", "red-team" ], "title": "Scan Type", "description": "Type of scan the profile configures." }, "mode": { "type": "string", "enum": [ "discover", "ingest" ], "title": "Mode", "description": "Profile mode: discover or ingest." }, "created_at": { "type": "integer", "title": "Created At", "description": "When the profile was created (unix seconds)." } }, "type": "object", "required": [ "profile_id", "name", "description", "visibility", "org_id", "scan_type", "mode", "created_at" ], "title": "CodeScanProfileSummaryResponse", "description": "Summary of a code scan profile, without its guidance." }, "CodeScanProfileSwitchRequest": { "properties": { "profile_id": { "type": "string", "title": "Profile Id", "description": "Profile to apply to future incremental runs of the scan." } }, "type": "object", "required": [ "profile_id" ], "title": "CodeScanProfileSwitchRequest", "description": "Request to switch the profile linked to a scan." }, "CodeScanProfileSwitchResponse": { "properties": { "scan_id": { "type": "string", "title": "Scan Id", "description": "Unique identifier for the scan." }, "profile": { "$ref": "#/components/schemas/CodeScanProfileResponse", "description": "Profile now linked to the scan, used for future incremental runs." } }, "type": "object", "required": [ "scan_id", "profile" ], "title": "CodeScanProfileSwitchResponse", "description": "Result of switching the profile linked to a scan." }, "CodeScanReferenceSnippetResponse": { "properties": { "file_path": { "type": "string", "title": "File Path", "description": "Path to the referenced file." }, "start_line": { "type": "integer", "title": "Start Line", "description": "First line of the referenced range." }, "end_line": { "type": "integer", "title": "End Line", "description": "Last line of the referenced range." }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code", "description": "The referenced source code, if captured." }, "commentary": { "type": "string", "title": "Commentary", "description": "Explanation of why this snippet is relevant to the finding." } }, "type": "object", "required": [ "file_path", "start_line", "end_line", "commentary" ], "title": "CodeScanReferenceSnippetResponse", "description": "A code snippet referenced by a finding as supporting evidence." }, "CodeScanResponse": { "properties": { "scan_id": { "type": "string", "title": "Scan Id", "description": "Unique identifier for the scan." }, "org_id": { "type": "string", "title": "Org Id", "description": "Organization the scan belongs to." }, "repo_name": { "type": "string", "title": "Repo Name", "description": "Primary repository of the scan. Multi-repo scans cover additional repositories not listed here." }, "host": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Host", "description": "Git host of the repository, if known." }, "repo_full_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Repo Full Name", "description": "Host-qualified identity of the primary repository (e.g. github.com/org/repo). Null for Perforce depots, which have no git host." }, "status": { "type": "string", "enum": [ "waiting", "pending", "running", "awaiting_user_input", "completed", "failed", "cancelled" ], "title": "Status", "description": "Scan status: waiting, pending, running, awaiting_user_input, completed, failed, or cancelled." }, "profile": { "anyOf": [ { "$ref": "#/components/schemas/CodeScanProfileResponse" }, { "type": "null" } ], "description": "Profile the scan ran under, if any." }, "scan_type": { "type": "string", "enum": [ "security", "performance", "db-queries", "test-coverage", "dead-code", "code-quality", "cleanup", "telemetry", "accessibility", "compliance", "general", "migration-docs", "red-team" ], "title": "Scan Type", "description": "Type of scan, stamped at creation." }, "created_at": { "type": "integer", "title": "Created At", "description": "When the scan was created (unix seconds)." }, "effort": { "type": "string", "enum": [ "normal", "deep" ], "title": "Effort", "description": "Scan effort: 'normal' uses lower model reasoning effort with larger investigation batches; 'deep' runs the full pipeline." }, "platform": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Platform", "description": "Hosted platform label the scan's sessions run on. Null when the scan runs on an outpost pool or the organization default." }, "outpost_pool_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Outpost Pool Id", "description": "Outpost pool the scan's sessions run on, if one is set." }, "url": { "type": "string", "title": "Url", "description": "URL of the scan's page in the Devin webapp." }, "attachments": { "items": { "$ref": "#/components/schemas/CodeScanAttachmentResponse" }, "type": "array", "title": "Attachments", "description": "Files attached to the scan when it was created." } }, "type": "object", "required": [ "scan_id", "org_id", "repo_name", "host", "status", "profile", "scan_type", "created_at", "effort", "url" ], "title": "CodeScanResponse", "description": "A single code scan." }, "ConsumptionByDateResponse": { "properties": { "date": { "type": "integer", "title": "Date" }, "acus": { "type": "number", "title": "Acus" }, "acus_by_product": { "$ref": "#/components/schemas/AcusByProduct" } }, "type": "object", "required": [ "date", "acus", "acus_by_product" ], "title": "ConsumptionByDateResponse" }, "ConsumptionCycle": { "properties": { "before": { "type": "integer", "title": "Before" }, "after": { "type": "integer", "title": "After" } }, "type": "object", "required": [ "before", "after" ], "title": "ConsumptionCycle" }, "ConsumptionResponse": { "properties": { "total_acus": { "type": "number", "title": "Total Acus" }, "consumption_by_date": { "items": { "$ref": "#/components/schemas/ConsumptionByDateResponse" }, "type": "array", "title": "Consumption By Date" } }, "type": "object", "required": [ "total_acus", "consumption_by_date" ], "title": "ConsumptionResponse" }, "CreateApiKeyRequest": { "properties": { "name": { "type": "string", "maxLength": 256, "minLength": 1, "title": "Name" }, "expires_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Expires At", "description": "Optional expiration as a UNIX timestamp in seconds. Must be in the future if provided." } }, "type": "object", "required": [ "name" ], "title": "CreateApiKeyRequest" }, "CreateEnterpriseBlueprintBody": { "properties": { "contents": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Contents", "description": "YAML body for the new blueprint. Omit to create an empty blueprint." } }, "type": "object", "title": "CreateEnterpriseBlueprintBody" }, "CreateOrgBlueprintBody": { "properties": { "repo_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Repo Name", "description": "If set, creates a repo-tier blueprint for that repository. If omitted, creates an org-wide (org-tier) blueprint." }, "contents": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Contents", "description": "Optional initial YAML body for the blueprint. Not allowed with source='git' (contents come from the repo)." }, "source": { "anyOf": [ { "type": "string", "enum": [ "git", "database" ] }, { "type": "null" } ], "title": "Source", "description": "Repo-tier only. 'git' reads .devin/blueprint.yaml (and its includes) from the repo's default branch and keeps the blueprint in sync with it; 'database' stores the YAML in Devin. Defaults to 'database' when omitted." } }, "type": "object", "title": "CreateOrgBlueprintBody" }, "CursorPaginationParams": { "properties": { "after": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "After" }, "first": { "type": "integer", "maximum": 200.0, "minimum": 1.0, "title": "First", "default": 100 } }, "type": "object", "title": "CursorPaginationParams" }, "DefaultTagRequest": { "properties": { "tag": { "type": "string", "title": "Tag" } }, "type": "object", "required": [ "tag" ], "title": "DefaultTagRequest" }, "DefaultTagResponse": { "properties": { "default_tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Default Tag" } }, "type": "object", "required": [ "default_tag" ], "title": "DefaultTagResponse" }, "DevinBrainUserSelf": { "properties": { "principal_type": { "type": "string", "const": "devin_brain", "title": "Principal Type" }, "devin_id": { "type": "string", "title": "Devin Id" }, "org_id": { "type": "string", "title": "Org Id" }, "user_id": { "type": "string", "title": "User Id" }, "creator_service_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Creator Service User Id" } }, "type": "object", "required": [ "principal_type", "devin_id", "org_id", "user_id" ], "title": "DevinBrainUserSelf", "description": "Identity information for an authenticated Devin brain session." }, "DollarsByProduct": { "properties": { "cascade": { "type": "number", "title": "Cascade" }, "terminal": { "type": "number", "title": "Terminal" } }, "type": "object", "required": [ "cascade", "terminal" ], "title": "DollarsByProduct" }, "EnterpriseSecurityProfileDefaultSelection": { "properties": { "selection": { "type": "string", "enum": [ "none", "profile" ], "title": "Selection" }, "profile_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Id", "description": "Required when selection is 'profile'; must be omitted otherwise." } }, "additionalProperties": false, "type": "object", "required": [ "selection" ], "title": "EnterpriseSecurityProfileDefaultSelection", "description": "A two-state default: none (no default profile) or profile (pin\nprofile_id). There is no ``inherit`` at the enterprise level \u2014 nothing\nsits above the enterprise to inherit from." }, "EnterpriseSecurityProfileDefaultState": { "properties": { "selection": { "type": "string", "enum": [ "none", "profile" ], "title": "Selection" }, "profile_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Id" } }, "additionalProperties": false, "type": "object", "required": [ "selection" ], "title": "EnterpriseSecurityProfileDefaultState", "description": "Read view of the enterprise default binding." }, "EnterpriseSecurityProfileResponse": { "properties": { "profile_id": { "type": "string", "title": "Profile Id", "description": "The security profile's ID." }, "name": { "type": "string", "title": "Name" }, "net_policy": { "anyOf": [ { "$ref": "#/components/schemas/SecurityProfileNetPolicy" }, { "type": "null" } ], "description": "null = this profile has no network opinion (it does NOT mean deny-all)." }, "mcp_config": { "anyOf": [ { "$ref": "#/components/schemas/SecurityProfileMcpConfig" }, { "type": "null" } ], "description": "null = this profile has no MCP opinion." }, "git_access_level": { "type": "string", "enum": [ "read_only", "read_write" ], "title": "Git Access Level" }, "enforcement_level": { "type": "string", "enum": [ "recommended", "mandatory" ], "title": "Enforcement Level", "description": "recommended profiles can be overridden by descendant bindings; mandatory profiles are a floor that descendant policies only narrow." }, "devin_mcp_read_only": { "type": "boolean", "title": "Devin Mcp Read Only", "description": "When true, sessions may only call read-only Devin MCP tools (no session creation, automation management, or other write operations)." }, "remove_github_cli_token": { "type": "boolean", "title": "Remove Github Cli Token", "description": "When true, the GitHub CLI token is removed from the session's machine, preventing direct GitHub API access." }, "slack_channel_access": { "anyOf": [ { "$ref": "#/components/schemas/SecurityProfileSlackChannelAccess" }, { "type": "null" } ], "description": "Ceiling on the Slack channels sessions governed by this profile may read and post in. null = this profile has no opinion and the organization's Slack setting applies." }, "slack_dm_scope": { "anyOf": [ { "type": "string", "enum": [ "disabled", "org_members", "workspace" ] }, { "type": "null" } ], "title": "Slack Dm Scope", "description": "Ceiling on who may DM Devin in Slack under this profile. null = this profile has no opinion and the organization's Slack setting applies. 'workspace' is narrowed to 'org_members' for enterprise accounts." }, "teams_channel_access": { "anyOf": [ { "$ref": "#/components/schemas/SecurityProfileTeamsChannelAccess" }, { "type": "null" } ], "description": "Ceiling on the Microsoft Teams channels sessions governed by this profile may read and post in. null = this profile has no opinion and the organization's Teams Default Access applies." }, "teams_dm_scope": { "anyOf": [ { "type": "string", "enum": [ "disabled", "installed_users" ] }, { "type": "null" } ], "title": "Teams Dm Scope", "description": "Ceiling on who Devin may DM in Microsoft Teams under this profile. null = this profile has no opinion and the organization's Teams Default Access applies." }, "teams_group_chat_scope": { "anyOf": [ { "type": "string", "enum": [ "disabled", "origin_chat" ] }, { "type": "null" } ], "title": "Teams Group Chat Scope", "description": "Ceiling on which Teams group chats Devin may read under this profile; `origin_chat` = only the group chat the session was started from; null = no opinion, derived from the org's Teams Default Access like DMs." }, "created_at": { "type": "integer", "title": "Created At" }, "updated_at": { "type": "integer", "title": "Updated At" } }, "additionalProperties": false, "type": "object", "required": [ "profile_id", "name", "git_access_level", "enforcement_level", "devin_mcp_read_only", "remove_github_cli_token", "created_at", "updated_at" ], "title": "EnterpriseSecurityProfileResponse", "description": "An enterprise-owned security profile, shared with every org in the\nenterprise. The owning enterprise is implied by the caller's token." }, "EnterpriseSecurityProfileSettingsResponse": { "properties": { "default": { "$ref": "#/components/schemas/EnterpriseSecurityProfileDefaultState" } }, "additionalProperties": false, "type": "object", "required": [ "default" ], "title": "EnterpriseSecurityProfileSettingsResponse" }, "EnterpriseSecurityProfileSettingsUpdateRequest": { "properties": { "default": { "anyOf": [ { "$ref": "#/components/schemas/EnterpriseSecurityProfileDefaultSelection" }, { "type": "null" } ] } }, "additionalProperties": false, "type": "object", "title": "EnterpriseSecurityProfileSettingsUpdateRequest", "description": "PATCH semantics: omitted fields are left unchanged." }, "EnterpriseUser": { "properties": { "user_id": { "type": "string", "title": "User Id" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "role_assignments": { "items": { "$ref": "#/components/schemas/RoleAssignment" }, "type": "array", "title": "Role Assignments" }, "enterprise_joined_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Enterprise Joined At", "description": "When the user was added to this enterprise." }, "idp_identities": { "anyOf": [ { "items": { "$ref": "#/components/schemas/IdpIdentity" }, "type": "array" }, { "type": "null" } ], "title": "Idp Identities", "description": "The user's identities on the enterprise's SSO connections. Only returned when enabled for the enterprise." } }, "type": "object", "required": [ "user_id", "email", "name", "role_assignments" ], "title": "EnterpriseUser" }, "EnterpriseUserWithIdpRoles": { "properties": { "user_id": { "type": "string", "title": "User Id" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "role_assignments": { "items": { "$ref": "#/components/schemas/RoleAssignment" }, "type": "array", "title": "Role Assignments" }, "idp_role_assignments": { "items": { "$ref": "#/components/schemas/IdpRoleAssignment" }, "type": "array", "title": "Idp Role Assignments" }, "enterprise_joined_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Enterprise Joined At", "description": "When the user was added to this enterprise." }, "idp_identities": { "anyOf": [ { "items": { "$ref": "#/components/schemas/IdpIdentity" }, "type": "array" }, { "type": "null" } ], "title": "Idp Identities", "description": "The user's identities on the enterprise's SSO connections. Only returned when enabled for the enterprise." } }, "type": "object", "required": [ "user_id", "email", "name", "role_assignments" ], "title": "EnterpriseUserWithIdpRoles" }, "FolderSummary": { "properties": { "folder_id": { "type": "string", "title": "Folder Id" }, "name": { "type": "string", "title": "Name" }, "parent_folder_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Parent Folder Id" }, "path": { "type": "string", "title": "Path" }, "note_count": { "type": "integer", "title": "Note Count" } }, "type": "object", "required": [ "folder_id", "name", "path", "note_count" ], "title": "FolderSummary", "description": "One folder in the knowledge folder tree." }, "FolderTreeResponse": { "properties": { "folders": { "items": { "$ref": "#/components/schemas/FolderSummary" }, "type": "array", "title": "Folders" }, "root_note_count": { "type": "integer", "title": "Root Note Count" } }, "type": "object", "required": [ "folders", "root_note_count" ], "title": "FolderTreeResponse", "description": "Response for the folder-structure endpoint." }, "GitConnectionRepositoryResponse": { "properties": { "provider_repository_id": { "type": "string", "title": "Provider Repository Id" }, "git_connection_id": { "type": "string", "title": "Git Connection Id" }, "git_connection_host": { "type": "string", "title": "Git Connection Host" }, "repo_name": { "type": "string", "title": "Repo Name" }, "repo_path": { "type": "string", "title": "Repo Path" }, "repo_full_name": { "type": "string", "title": "Repo Full Name", "description": "Devin's identifier for the repository, used as repository_path by the indexing and blueprint endpoints: the path for github.com (e.g. 'org/repo'), host-prefixed for other git hosts (e.g. 'gitlab.example.com/group/repo'), or a perforce:// URI." }, "repo_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Repo Description" }, "last_updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Last Updated At" }, "repo_language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Repo Language" } }, "type": "object", "required": [ "provider_repository_id", "git_connection_id", "git_connection_host", "repo_name", "repo_path", "repo_full_name", "repo_description", "last_updated_at", "repo_language" ], "title": "GitConnectionRepositoryResponse" }, "GitConnectionResponse": { "properties": { "git_connection_id": { "type": "string", "title": "Git Connection Id" }, "git_provider_type": { "type": "string", "enum": [ "github_token", "github_individual_token", "github_app", "gitlab_token", "gitlab_project_token", "gitlab_group_token", "gitlab_oauth", "azure_devops_oauth", "azure_devops_token", "bitbucket_oauth", "bitbucket_token", "bitbucket_cloud_token", "perforce" ], "title": "Git Provider Type" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "host": { "type": "string", "title": "Host" }, "created_at": { "type": "integer", "title": "Created At" }, "perforce_depot_paths": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Perforce Depot Paths", "description": "Depot path scopes for perforce connections, e.g. [\"//depot/main/...\"]. Empty list when none are configured. Null for git connections, or for a perforce connection whose depot-path lookup failed." }, "web_viewer_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Web Viewer Url", "description": "Base URL of the customer's code viewer (e.g. Helix Swarm) used to render browsable file/changelist links" } }, "type": "object", "required": [ "git_connection_id", "git_provider_type", "name", "host", "created_at" ], "title": "GitConnectionResponse" }, "GitPermissionBulkCreateRequest": { "properties": { "permissions": { "items": { "$ref": "#/components/schemas/GitPermissionCreateRequest" }, "type": "array", "maxItems": 200, "title": "Permissions" } }, "type": "object", "required": [ "permissions" ], "title": "GitPermissionBulkCreateRequest" }, "GitPermissionCreateRequest": { "properties": { "git_connection_id": { "type": "string", "title": "Git Connection Id" }, "repo_path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Repo Path" }, "group_prefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Group Prefix" }, "prefix_path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Prefix Path" }, "depot_path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Depot Path" }, "read_only": { "type": "boolean", "title": "Read Only", "default": false } }, "type": "object", "required": [ "git_connection_id" ], "title": "GitPermissionCreateRequest" }, "GitPermissionResponse": { "properties": { "git_permission_id": { "type": "string", "title": "Git Permission Id" }, "git_connection_id": { "type": "string", "title": "Git Connection Id" }, "repo_path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Repo Path" }, "group_prefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Group Prefix" }, "prefix_path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Prefix Path" }, "depot_path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Depot Path" }, "read_only": { "type": "boolean", "title": "Read Only", "default": false }, "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Created At" } }, "type": "object", "required": [ "git_permission_id", "git_connection_id" ], "title": "GitPermissionResponse" }, "GitPermissionUpdateRequest": { "properties": { "read_only": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Read Only" } }, "type": "object", "title": "GitPermissionUpdateRequest" }, "GuardrailViolationResponse": { "properties": { "violation_id": { "type": "integer", "title": "Violation Id" }, "org_id": { "type": "string", "title": "Org Id" }, "session_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Session Id" }, "event_id": { "type": "string", "title": "Event Id" }, "guardrail_id": { "type": "string", "title": "Guardrail Id" }, "guardrail_name": { "type": "string", "title": "Guardrail Name" }, "confidence_score": { "type": "number", "title": "Confidence Score" }, "action_taken": { "type": "string", "title": "Action Taken" }, "reasoning": { "type": "string", "title": "Reasoning" }, "user_message": { "type": "string", "title": "User Message" }, "created_at": { "type": "integer", "title": "Created At" } }, "type": "object", "required": [ "violation_id", "org_id", "session_id", "event_id", "guardrail_id", "guardrail_name", "confidence_score", "action_taken", "reasoning", "user_message", "created_at" ], "title": "GuardrailViolationResponse" }, "HypervisorResponse": { "properties": { "hypervisor_id": { "type": "string", "title": "Hypervisor Id" }, "status": { "type": "string", "title": "Status" }, "utilization_percentage": { "type": "number", "title": "Utilization Percentage" }, "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Created At" }, "last_heartbeat": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Last Heartbeat" }, "cloud_provider_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cloud Provider Instance Id" } }, "type": "object", "required": [ "hypervisor_id", "status", "utilization_percentage", "created_at", "last_heartbeat", "cloud_provider_instance_id" ], "title": "HypervisorResponse" }, "IdpGroup": { "properties": { "idp_group_name": { "type": "string", "title": "Idp Group Name" }, "role_assignments": { "items": { "$ref": "#/components/schemas/RoleAssignment" }, "type": "array", "title": "Role Assignments" } }, "type": "object", "required": [ "idp_group_name", "role_assignments" ], "title": "IdpGroup" }, "IdpGroupResponse": { "properties": { "idp_group_name": { "type": "string", "title": "Idp Group Name" } }, "type": "object", "required": [ "idp_group_name" ], "title": "IdpGroupResponse" }, "IdpGroupUpdateRoleRequest": { "properties": { "role_id": { "type": "string", "title": "Role Id" } }, "type": "object", "required": [ "role_id" ], "title": "IdpGroupUpdateRoleRequest" }, "IdpGroupUser": { "properties": { "user_id": { "type": "string", "title": "User Id" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "idp_role_assignments": { "items": { "$ref": "#/components/schemas/IdpRoleAssignment" }, "type": "array", "title": "Idp Role Assignments" } }, "type": "object", "required": [ "user_id", "email", "name", "idp_role_assignments" ], "title": "IdpGroupUser", "description": "A user whose membership is derived from IDP group assignments." }, "IdpGroupsBulkCreateRequest": { "properties": { "idp_group_names": { "items": { "type": "string" }, "type": "array", "maxItems": 100, "minItems": 1, "title": "Idp Group Names" } }, "type": "object", "required": [ "idp_group_names" ], "title": "IdpGroupsBulkCreateRequest" }, "IdpIdentity": { "properties": { "connection_name": { "type": "string", "title": "Connection Name", "description": "Name of the SSO connection." }, "subject": { "type": "string", "title": "Subject", "description": "The user's subject identifier at the connection's identity provider (SAML NameID or OIDC `sub`)." } }, "type": "object", "required": [ "connection_name", "subject" ], "title": "IdpIdentity" }, "IdpRoleAssignment": { "properties": { "role": { "$ref": "#/components/schemas/Role" }, "org_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Org Id" }, "idp_group_name": { "type": "string", "title": "Idp Group Name" } }, "type": "object", "required": [ "role", "idp_group_name" ], "title": "IdpRoleAssignment", "description": "A role assignment inherited via IDP group membership." }, "IndexRepositoryRequest": { "properties": { "branch_names": { "items": { "type": "string" }, "type": "array", "title": "Branch Names" } }, "type": "object", "title": "IndexRepositoryRequest" }, "IpAccessListAddRequest": { "properties": { "ip_ranges": { "items": { "type": "string" }, "type": "array", "title": "Ip Ranges" } }, "type": "object", "required": [ "ip_ranges" ], "title": "IpAccessListAddRequest" }, "IpAccessListReplaceRequest": { "properties": { "ip_ranges": { "items": { "type": "string" }, "type": "array", "title": "Ip Ranges" } }, "type": "object", "required": [ "ip_ranges" ], "title": "IpAccessListReplaceRequest" }, "IpAccessListResponse": { "properties": { "ip_ranges": { "items": { "type": "string" }, "type": "array", "title": "Ip Ranges" } }, "type": "object", "required": [ "ip_ranges" ], "title": "IpAccessListResponse" }, "KnowledgeNoteCreateRequest": { "properties": { "name": { "type": "string", "title": "Name" }, "body": { "type": "string", "title": "Body" }, "trigger": { "type": "string", "title": "Trigger" }, "pinned_repo": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pinned Repo" }, "folder_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Folder Id" }, "is_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Enabled" } }, "type": "object", "required": [ "name", "body", "trigger" ], "title": "KnowledgeNoteCreateRequest" }, "KnowledgeNoteResponse": { "properties": { "note_id": { "type": "string", "title": "Note Id" }, "folder_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Folder Id" }, "folder_path": { "type": "string", "title": "Folder Path" }, "name": { "type": "string", "title": "Name" }, "body": { "type": "string", "title": "Body" }, "trigger": { "type": "string", "title": "Trigger" }, "is_enabled": { "type": "boolean", "title": "Is Enabled" }, "created_at": { "type": "integer", "title": "Created At" }, "updated_at": { "type": "integer", "title": "Updated At" }, "access_type": { "type": "string", "enum": [ "enterprise", "org" ], "title": "Access Type" }, "org_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Org Id" }, "macro": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Macro" }, "pinned_repo": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pinned Repo" } }, "type": "object", "required": [ "note_id", "folder_id", "folder_path", "name", "body", "trigger", "is_enabled", "created_at", "updated_at", "access_type", "org_id", "macro", "pinned_repo" ], "title": "KnowledgeNoteResponse" }, "NewScanBudget": { "properties": { "acu_limit": { "type": "integer", "maximum": 1000000.0, "minimum": 0.0, "title": "Acu Limit", "description": "Per-cycle ACU limit of a new budget that pays for the scan, its child sessions and its remediations." } }, "type": "object", "required": [ "acu_limit" ], "title": "NewScanBudget" }, "OncallEventSchemaResponse": { "properties": { "event_type": { "type": "string", "title": "Event Type" }, "name": { "type": "string", "title": "Name" }, "category": { "type": "string", "title": "Category" }, "supported_replies": { "items": { "type": "string" }, "type": "array", "title": "Supported Replies", "description": "Always empty: responders manage their own replies.", "default": [] }, "fields": { "additionalProperties": { "$ref": "#/components/schemas/AutomationSchemaFieldDef" }, "type": "object", "title": "Fields", "description": "Condition field path -> field definition." } }, "additionalProperties": false, "type": "object", "required": [ "event_type", "name", "category", "fields" ], "title": "OncallEventSchemaResponse" }, "OncallLimitsInvocationsPatch": { "properties": { "max_per_window": { "type": "integer", "minimum": 1.0, "title": "Max Per Window" }, "window_seconds": { "type": "integer", "minimum": 60.0, "title": "Window Seconds" } }, "additionalProperties": false, "type": "object", "required": [ "max_per_window", "window_seconds" ], "title": "OncallLimitsInvocationsPatch" }, "OncallLimitsPatch": { "properties": { "max_acu_limit": { "anyOf": [ { "type": "integer", "maximum": 1000.0, "minimum": 1.0 }, { "type": "null" } ], "title": "Max Acu Limit" }, "invocations": { "anyOf": [ { "$ref": "#/components/schemas/OncallLimitsInvocationsPatch" }, { "type": "null" } ] } }, "additionalProperties": false, "type": "object", "title": "OncallLimitsPatch" }, "OncallResponderCreateRequest": { "properties": { "name": { "type": "string", "maxLength": 500, "minLength": 1, "title": "Name" }, "triggers": { "items": { "$ref": "#/components/schemas/OncallTriggerRequest" }, "type": "array", "maxItems": 10, "minItems": 1, "title": "Triggers", "description": "Up to 10 triggers from one provider, OR'd; each has its own filter and no two may be identical. Slack: slack:message, slack:usergroup_mentioned or slack:app_mentioned triggers, all in one Slack workspace. Usergroup mentioned requires a usergroup eq filter with a Slack usergroup ID. App mentioned listens on the run-as service user's own Slack app and needs no filter. Each condition group must restrict channels (eq or in) or include at least one completed filter other than is_thread_reply. PagerDuty: pagerduty:* triggers (pagerduty_connection_id required); an event type may repeat with different filters. Teams: teams:message triggers; every condition group names one team (team_id eq) and its channels (channel_id eq/in). Linear: linear:* issue triggers (team_id filters scope the watched teams; Devin comments on the issue, and replies in that thread reach the session). Jira: jira:* issue triggers (project filters scope the watched projects; Devin comments on the issue with the session link)." }, "team_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Team Id", "description": "Slack workspace id (resolved server-side if omitted); rejected with Teams triggers, which carry team_id in conditions." }, "pagerduty_connection_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pagerduty Connection Id", "description": "The account's PagerDuty connection id; required with pagerduty:* triggers (Devin posts triage notes on the incident through it) and rejected with Slack triggers." }, "runbook": { "anyOf": [ { "type": "string", "maxLength": 50000 }, { "type": "null" } ], "title": "Runbook", "description": "Investigation instructions for triage sessions. Omit (or send blank) to use the server default (`default_runbook` in the schemas response). Only supply one when the user has specific investigation steps." }, "triage_issue_type": { "type": "string", "enum": [ "alerts", "bugs" ], "title": "Triage Issue Type", "description": "What the responder triages, which sets its issue workflow and triage behavior: 'alerts' for monitoring alerts and pages; 'bugs' for bug reports and support questions." }, "enabled": { "type": "boolean", "title": "Enabled", "default": true }, "tools": { "anyOf": [ { "$ref": "#/components/schemas/OncallTools" }, { "type": "null" } ] }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Metadata", "description": "User-defined tags; 'team' (and 'service' when obvious) are recommended so reports can group responders.", "default": {} }, "limits": { "anyOf": [ { "$ref": "#/components/schemas/AutomationLimits" }, { "type": "null" } ] }, "session_settings": { "anyOf": [ { "$ref": "#/components/schemas/OncallSessionSettings-Input" }, { "type": "null" } ], "description": "Omitted net_policy defaults to the deployment default policy; omitted devin_mode inherits the org default." }, "session": { "anyOf": [ { "$ref": "#/components/schemas/OncallSessionConfig" }, { "type": "null" } ] }, "run_as": { "oneOf": [ { "$ref": "#/components/schemas/AutomationRunAsOrganization" }, { "$ref": "#/components/schemas/AutomationRunAsCreator" }, { "$ref": "#/components/schemas/AutomationRunAsServiceUser" } ], "title": "Run As", "description": "Identity triage sessions run under; defaults to organization.", "discriminator": { "propertyName": "type", "mapping": { "creator": "#/components/schemas/AutomationRunAsCreator", "organization": "#/components/schemas/AutomationRunAsOrganization", "service_user": "#/components/schemas/AutomationRunAsServiceUser" } } }, "slack_reply_access": { "type": "string", "enum": [ "devin_users", "slack_users", "external_slack_users" ], "title": "Slack Reply Access", "description": "Who may reply into existing triage sessions from Slack threads: devin_users, slack_users (the organization's connected Slack workspaces), or external_slack_users (also Slack Connect users). Slack responders only.", "default": "slack_users" }, "teams_reply_access": { "anyOf": [ { "type": "string", "enum": [ "devin_users", "teams_users" ] }, { "type": "null" } ], "title": "Teams Reply Access", "description": "Teams responders: who may reply into existing triage sessions from Teams threads: devin_users or teams_users. Omitted = teams_users." } }, "additionalProperties": false, "type": "object", "required": [ "name", "triggers", "triage_issue_type" ], "title": "OncallResponderCreateRequest" }, "OncallResponderResponse": { "properties": { "id": { "type": "string", "title": "Id", "description": "Responder (automation) id." }, "name": { "type": "string", "title": "Name" }, "enabled": { "type": "boolean", "title": "Enabled" }, "triggers": { "items": { "$ref": "#/components/schemas/OncallTriggerResponse" }, "type": "array", "title": "Triggers", "description": "Automation-style triggers, OR'd: the responder runs once when any trigger matches. Slack responders: slack:message / slack:usergroup_mentioned / slack:app_mentioned triggers. PagerDuty responders: pagerduty:* triggers. Teams responders: teams:message triggers. Linear responders: linear:* issue triggers. Jira responders: jira:* issue triggers. Pylon responders: pylon:* issue triggers. Webhook responders: one incoming or managed webhook trigger. Schedule responders: one schedule:recurring trigger with a recurrence rule." }, "source": { "type": "string", "enum": [ "slack", "pagerduty", "webhook", "schedule", "teams", "linear", "jira", "pylon" ], "title": "Source", "description": "Alert provider the responder triages: slack, pagerduty, webhook, schedule, teams, linear, jira or pylon.", "default": "slack" }, "source_channel_id": { "type": "string", "title": "Source Channel Id", "description": "First Slack or Teams channel the responder's triggers watch; empty for unscoped Slack, PagerDuty, webhook, schedule, Linear, Jira or Pylon responders." }, "team_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Team Id", "description": "Slack workspace id, or the Microsoft Teams team id of source_channel_id for Teams responders." }, "pagerduty_connection_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pagerduty Connection Id", "description": "PagerDuty connection the responder posts incident notes through (PagerDuty responders only)." }, "webhook": { "anyOf": [ { "$ref": "#/components/schemas/AutomationWebhookResponse" }, { "type": "null" } ], "description": "Webhook responders only: the inbox URL external systems POST to (header X-Webhook-Secret) and, on the response to the create or the switch that generated it only, the one-time secret. The secret is not stored in recoverable form: if that response is lost (for example the connection dropped while the create committed), list responders to find the one that was created and call POST .../responders/{id}/webhook/regenerate-secret for a new one." }, "runbook": { "type": "string", "title": "Runbook", "description": "Investigation instructions for triage. Blank when the responder runs the server default runbook." }, "triage_issue_type": { "anyOf": [ { "type": "string", "enum": [ "alerts", "bugs" ] }, { "type": "null" } ], "title": "Triage Issue Type", "description": "What the responder triages: alerts or bugs (see OncallResponderCreateRequest.triage_issue_type). Null for a legacy responder created without one." }, "tools": { "anyOf": [ { "$ref": "#/components/schemas/OncallTools" }, { "type": "null" } ] }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Metadata", "description": "User-defined key/value tags (e.g. team, service). Reserved oncall_* keys are managed by the server.", "default": {} }, "limits": { "anyOf": [ { "$ref": "#/components/schemas/AutomationLimits" }, { "type": "null" } ] }, "session_settings": { "anyOf": [ { "$ref": "#/components/schemas/OncallSessionSettings-Output" }, { "type": "null" } ] }, "session": { "anyOf": [ { "$ref": "#/components/schemas/OncallSessionConfig" }, { "type": "null" } ], "description": "Session tags spawned sessions bill to." }, "run_as": { "oneOf": [ { "$ref": "#/components/schemas/AutomationRunAsOrganization" }, { "$ref": "#/components/schemas/AutomationRunAsCreator" }, { "$ref": "#/components/schemas/AutomationRunAsServiceUser" } ], "title": "Run As", "description": "Identity triage sessions run under.", "discriminator": { "propertyName": "type", "mapping": { "creator": "#/components/schemas/AutomationRunAsCreator", "organization": "#/components/schemas/AutomationRunAsOrganization", "service_user": "#/components/schemas/AutomationRunAsServiceUser" } } }, "slack_reply_access": { "type": "string", "enum": [ "devin_users", "slack_users", "external_slack_users" ], "title": "Slack Reply Access", "description": "Who may reply into existing triage sessions from Slack threads: devin_users, slack_users (the organization's connected Slack workspaces), or external_slack_users (also Slack Connect users).", "default": "slack_users" }, "teams_reply_access": { "type": "string", "enum": [ "devin_users", "teams_users" ], "title": "Teams Reply Access", "description": "Teams responders: who may reply into existing triage sessions from Teams threads: devin_users (linked Devin accounts only) or teams_users (anyone in the organization's connected Microsoft tenant; the default).", "default": "teams_users" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By" }, "created_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Updated At" } }, "additionalProperties": false, "type": "object", "required": [ "id", "name", "enabled", "triggers", "source_channel_id", "runbook" ], "title": "OncallResponderResponse" }, "OncallResponderUpdateRequest": { "properties": { "name": { "anyOf": [ { "type": "string", "maxLength": 500, "minLength": 1 }, { "type": "null" } ], "title": "Name" }, "triggers": { "anyOf": [ { "items": { "$ref": "#/components/schemas/OncallTriggerRequest" }, "type": "array", "maxItems": 10, "minItems": 1 }, { "type": "null" } ], "title": "Triggers", "description": "Replaces the trigger set. Switching provider (Slack, PagerDuty, Teams) rebuilds the responder's provider config from this request." }, "team_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Team Id" }, "pagerduty_connection_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pagerduty Connection Id", "description": "Omitted -> preserve; required when triggers switch the responder to PagerDuty." }, "runbook": { "anyOf": [ { "type": "string", "maxLength": 50000 }, { "type": "null" } ], "title": "Runbook", "description": "Blank resets to the server default runbook." }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enabled" }, "tools": { "anyOf": [ { "$ref": "#/components/schemas/OncallToolsPatch" }, { "type": "null" } ] }, "metadata": { "anyOf": [ { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": "object" }, { "type": "null" } ], "title": "Metadata" }, "limits": { "anyOf": [ { "$ref": "#/components/schemas/OncallLimitsPatch" }, { "type": "null" } ] }, "session_settings": { "anyOf": [ { "$ref": "#/components/schemas/OncallSessionSettingsPatch" }, { "type": "null" } ] }, "session": { "anyOf": [ { "$ref": "#/components/schemas/OncallSessionConfig" }, { "type": "null" } ] }, "run_as": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/AutomationRunAsOrganization" }, { "$ref": "#/components/schemas/AutomationRunAsCreator" }, { "$ref": "#/components/schemas/AutomationRunAsServiceUser" } ], "description": "Identity triage sessions run under: organization, creator, or a service user (requires permission to manage that service user).", "discriminator": { "propertyName": "type", "mapping": { "creator": "#/components/schemas/AutomationRunAsCreator", "organization": "#/components/schemas/AutomationRunAsOrganization", "service_user": "#/components/schemas/AutomationRunAsServiceUser" } } }, { "type": "null" } ], "title": "Run As", "description": "Omitted -> preserve the responder's existing run_as; null resets to organization." }, "slack_reply_access": { "anyOf": [ { "type": "string", "enum": [ "devin_users", "slack_users", "external_slack_users" ] }, { "type": "null" } ], "title": "Slack Reply Access", "description": "Omitted -> preserve the responder's existing setting; null resets to slack_users." }, "teams_reply_access": { "anyOf": [ { "type": "string", "enum": [ "devin_users", "teams_users" ] }, { "type": "null" } ], "title": "Teams Reply Access", "description": "Teams responders. Omitted -> preserve; null resets to teams_users." } }, "additionalProperties": false, "type": "object", "title": "OncallResponderUpdateRequest", "description": "Partial update (RFC 7396-style): omitted fields and omitted group\nmembers keep their stored value; explicit nulls clear; ``triggers``,\n``tools.mcp_servers``, ``tools.slack_channels`` and ``session.tags`` lists\nreplace wholesale; ``metadata`` merges per key (null value deletes the\nkey)." }, "OncallSchemasResponse": { "properties": { "default_net_policy": { "anyOf": [ { "$ref": "#/components/schemas/AutomationNetPolicy" }, { "type": "null" } ], "description": "Network policy applied to a new responder when session_settings.net_policy is omitted: the deployment's Git Manager-only policy, or null when the governing security profile (see security_profile) has a network policy, in which case the responder inherits it and its sessions use the profile's policy." }, "security_profile": { "anyOf": [ { "$ref": "#/components/schemas/AutomationSchemasSecurityProfile" }, { "type": "null" } ], "description": "Security profile governing this organization's automation sessions (responders included), or null when none applies." }, "default_devin_mode": { "anyOf": [ { "type": "string", "enum": [ "normal", "fast", "lite", "ultra", "fusion" ] }, { "type": "null" } ], "title": "Default Devin Mode", "description": "Mode applied to new responders / incidents when session_settings.devin_mode is omitted: the best of ultra > fusion > normal the organization can use, or null when none of those is available and sessions inherit the organization default." }, "available_devin_modes": { "items": { "type": "string", "enum": [ "normal", "fast", "lite", "ultra", "fusion" ] }, "type": "array", "title": "Available Devin Modes", "description": "Every mode the organization may set on responders / incidents (including fast and lite, which are never picked by default)." }, "default_runbook": { "type": "string", "title": "Default Runbook", "description": "Runbook applied when a responder's runbook is blank." }, "update_semantics": { "type": "string", "const": "merge_patch", "title": "Update Semantics", "description": "PATCH semantics: omitted fields / group members keep their stored values, explicit nulls clear, lists replace wholesale.", "default": "merge_patch" }, "slack_connected": { "type": "boolean", "title": "Slack Connected", "description": "Whether the organization has a Slack connection." }, "pagerduty_connection_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pagerduty Connection Id", "description": "The account's PagerDuty connection id when PagerDuty responders are available to this organization (pass it as pagerduty_connection_id on a responder with pagerduty:* triggers); null when PagerDuty is not connected or the feature is not enabled." }, "teams_connected": { "type": "boolean", "title": "Teams Connected", "description": "Whether Microsoft Teams responders are available: the organization has a Teams connection and the feature is enabled. Teams does not count toward the Slack connection incidents require.", "default": false }, "webhook_responders_enabled": { "type": "boolean", "title": "Webhook Responders Enabled", "description": "Whether webhook responders (one webhook:incoming trigger) are available to this organization.", "default": false }, "linear_connected": { "type": "boolean", "title": "Linear Connected", "description": "Whether Linear responders (linear:* issue triggers) are available: the account has a Linear connection and the feature is enabled.", "default": false }, "jira_connected": { "type": "boolean", "title": "Jira Connected", "description": "Whether Jira responders (jira:* issue triggers) are available: the account has a Jira connection and the feature is enabled.", "default": false }, "pylon_connected": { "type": "boolean", "title": "Pylon Connected", "description": "Whether Pylon responders (pylon:* issue triggers) are available: the account has a Pylon connection with automation triggers turned on and the feature is enabled.", "default": false }, "sources": { "additionalProperties": { "additionalProperties": { "$ref": "#/components/schemas/OncallEventSchemaResponse" }, "type": "object" }, "type": "object", "title": "Sources", "description": "Event source -> event name -> schema. 'pagerduty' is present only when pagerduty_connection_id is set; 'webhook' only when webhook_responders_enabled is true; 'teams' only when teams_connected is true; 'linear' / 'jira' / 'pylon' only when linear_connected / jira_connected / pylon_connected is true." } }, "additionalProperties": false, "type": "object", "required": [ "default_net_policy", "default_devin_mode", "available_devin_modes", "default_runbook", "slack_connected", "sources" ], "title": "OncallSchemasResponse" }, "OncallSessionConfig": { "properties": { "tags": { "anyOf": [ { "items": { "type": "string", "maxLength": 255 }, "type": "array", "maxItems": 16 }, { "type": "null" } ], "title": "Tags", "description": "Session tags (cost codes) the spawned sessions bill to. Validated as the run identity; organizations that enforce required session tags must supply exactly one allowed tag." } }, "additionalProperties": false, "type": "object", "title": "OncallSessionConfig", "description": "Session-level configuration that automations carry on their action\n(``actions[].session``); Oncall exposes only the tags." }, "OncallSessionSettings-Input": { "properties": { "devin_mode": { "anyOf": [ { "type": "string", "enum": [ "normal", "fast", "lite", "ultra", "fusion" ] }, { "type": "null" } ], "title": "Devin Mode", "description": "Mode for spawned sessions: normal, fusion, fast, ultra, or lite. Omitted on create = the best mode the run identity can spawn (Ultra, else Fusion, else Normal); explicit null = org default." }, "net_policy": { "anyOf": [ { "$ref": "#/components/schemas/AutomationNetPolicy" }, { "type": "null" } ], "description": "Network policy for spawned sessions. Omitted on create = the deployment default (Git Manager-only) policy; explicit null = unrestricted." } }, "additionalProperties": false, "type": "object", "title": "OncallSessionSettings", "description": "Per-session settings for the sessions a responder / incident spawns." }, "OncallSessionSettings-Output": { "properties": { "devin_mode": { "anyOf": [ { "type": "string", "enum": [ "normal", "fast", "lite", "ultra", "fusion" ] }, { "type": "null" } ], "title": "Devin Mode", "description": "Mode for spawned sessions: normal, fusion, fast, ultra, or lite. Omitted on create = the best mode the run identity can spawn (Ultra, else Fusion, else Normal); explicit null = org default." }, "net_policy": { "anyOf": [ { "$ref": "#/components/schemas/AutomationNetPolicy" }, { "type": "null" } ], "description": "Network policy for spawned sessions. Omitted on create = the deployment default (Git Manager-only) policy; explicit null = unrestricted." } }, "additionalProperties": false, "type": "object", "title": "OncallSessionSettings", "description": "Per-session settings for the sessions a responder / incident spawns." }, "OncallSessionSettingsPatch": { "properties": { "devin_mode": { "anyOf": [ { "type": "string", "enum": [ "normal", "fast", "lite", "ultra", "fusion" ] }, { "type": "null" } ], "title": "Devin Mode" }, "net_policy": { "anyOf": [ { "$ref": "#/components/schemas/AutomationNetPolicy" }, { "type": "null" } ] } }, "additionalProperties": false, "type": "object", "title": "OncallSessionSettingsPatch" }, "OncallTools": { "properties": { "mcp_servers": { "items": { "type": "string" }, "type": "array", "title": "Mcp Servers", "description": "Marketplace MCP server slugs enabled for spawned sessions. Servers installed with a personal (user-scoped) connection require run_as creator.", "default": [] }, "slack_channels": { "items": { "$ref": "#/components/schemas/AutomationSlackChannel" }, "type": "array", "title": "Slack Channels", "description": "Slack channels spawned sessions may read/post in (tool grant, independent of the trigger's channel filter). Incident settings accept the wildcard pair team_id='*', channel_id='*' for all public channels.", "default": [] }, "teams_channels": { "items": { "$ref": "#/components/schemas/AutomationTeamsChannel" }, "type": "array", "title": "Teams Channels", "description": "Microsoft Teams channels spawned sessions may read/post in (tool grant, independent of the trigger). Omitted on a Teams responder create = the watched channels.", "default": [] }, "slack_dm_scope": { "anyOf": [ { "type": "string", "enum": [ "org_members", "workspace" ] }, { "type": "null" } ], "title": "Slack Dm Scope", "description": "Allow spawned sessions to open 1:1 Slack DMs in the organization's connected workspaces: 'org_members' (enterprise accounts) or 'workspace' (non-enterprise accounts). Omit or null to disable DMs. Responders only." }, "teams_dm_scope": { "anyOf": [ { "type": "string", "const": "installed_users" }, { "type": "null" } ], "title": "Teams Dm Scope", "description": "Allow spawned sessions to open 1:1 Microsoft Teams DMs with users who installed the Devin app personally. Omit or null to disable DMs. Responders only." }, "linear_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Linear Enabled", "description": "Enable Linear tools; null = org default." }, "jira_projects": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "minItems": 1 }, { "type": "null" } ], "title": "Jira Projects", "description": "Jira project ids the sessions' Jira tools are limited to; null (the default) allows every project the run identity can access. On update, omitting this member keeps the stored list; send null to clear it. Responders only." } }, "additionalProperties": false, "type": "object", "title": "OncallTools", "description": "Tools granted to spawned sessions; mirrors Automations ``tools``." }, "OncallToolsPatch": { "properties": { "mcp_servers": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Mcp Servers" }, "slack_channels": { "anyOf": [ { "items": { "$ref": "#/components/schemas/AutomationSlackChannel" }, "type": "array" }, { "type": "null" } ], "title": "Slack Channels" }, "teams_channels": { "anyOf": [ { "items": { "$ref": "#/components/schemas/AutomationTeamsChannel" }, "type": "array" }, { "type": "null" } ], "title": "Teams Channels" }, "slack_dm_scope": { "anyOf": [ { "type": "string", "enum": [ "org_members", "workspace" ] }, { "type": "null" } ], "title": "Slack Dm Scope" }, "teams_dm_scope": { "anyOf": [ { "type": "string", "const": "installed_users" }, { "type": "null" } ], "title": "Teams Dm Scope" }, "linear_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Linear Enabled" }, "jira_projects": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "minItems": 1 }, { "type": "null" } ], "title": "Jira Projects" } }, "additionalProperties": false, "type": "object", "title": "OncallToolsPatch", "description": "Merge-patch view of ``tools``: only members present in the request\nchange; explicit null clears a member." }, "OncallTriggerRequest": { "properties": { "managed_webhook_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Managed Webhook Id", "description": "ID of the managed source, required only for webhook:managed." }, "event_type": { "type": "string", "enum": [ "slack:message", "slack:usergroup_mentioned", "slack:app_mentioned", "pagerduty:incident_triggered", "pagerduty:incident_acknowledged", "pagerduty:incident_resolved", "pagerduty:incident_updated", "teams:message", "webhook:incoming", "webhook:managed", "schedule:recurring", "linear:create", "linear:label_added", "linear:status_changed", "linear:assigned", "linear:priority_changed", "linear:moved", "jira:issue_created", "jira:issue_updated", "jira:label_added", "jira:status_changed", "jira:assigned", "pylon:issue_created", "pylon:issue_tag_added", "pylon:issue_status_changed" ], "title": "Event Type", "description": "Trigger event type: 'slack:message', 'slack:usergroup_mentioned' or 'slack:app_mentioned' (the run-as service user's own Slack app), a 'pagerduty:incident_*' event (requires pagerduty_connection_id), 'teams:message', or 'webhook:incoming' (exactly one, no conditions; the response's webhook field carries the inbox URL and, on create, the one-time secret), or 'webhook:managed' (exactly one, with managed_webhook_id). All of a responder's triggers use one provider. Use schedule:recurring with an rrule condition for a scheduled responder." }, "conditions": { "anyOf": [ { "$ref": "#/components/schemas/AutomationConditions-Input" }, { "type": "null" } ], "description": "Automation-style DNF filter over the event. Every Slack AND group requires a channel restriction or at least one completed filter. is_thread_reply alone does not count. For pagerduty:* triggers the filter is optional (e.g. incident.service / incident.priority). Every teams:message AND group needs team_id eq and channel_id eq/in." }, "replies": { "items": { "$ref": "#/components/schemas/AutomationReply" }, "type": "array", "title": "Replies", "description": "Must be empty: Oncall responders manage their own thread replies.", "default": [] } }, "additionalProperties": false, "type": "object", "required": [ "event_type" ], "title": "OncallTriggerRequest" }, "OncallTriggerResponse": { "properties": { "trigger_id": { "type": "string", "title": "Trigger Id", "description": "Re-minted when triggers is replaced \u2014 not stable across edits." }, "event_type": { "type": "string", "title": "Event Type" }, "managed_webhook_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Managed Webhook Id" }, "conditions": { "anyOf": [ { "$ref": "#/components/schemas/AutomationConditions-Output" }, { "type": "null" } ] }, "replies": { "items": { "$ref": "#/components/schemas/AutomationReply" }, "type": "array", "title": "Replies", "default": [] } }, "additionalProperties": false, "type": "object", "required": [ "trigger_id", "event_type" ], "title": "OncallTriggerResponse" }, "OrgCodeScanCreateRequest": { "properties": { "repo_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Repo Name", "description": "Full name of the repository to scan. Provide exactly one of repo_name or repos." }, "host": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Host", "description": "Git host of the repository, if known." }, "repos": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ScanRepoRequest" }, "type": "array", "maxItems": 500 }, { "type": "null" } ], "title": "Repos", "description": "Repositories covered by one scan; the first entry is the scan's primary repository. Provide exactly one of repo_name or repos." }, "profile_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Id", "description": "Scan profile to apply to the scan." }, "scan_type": { "anyOf": [ { "type": "string", "enum": [ "security", "performance", "db-queries", "test-coverage", "dead-code", "code-quality", "cleanup", "telemetry", "accessibility", "compliance", "general", "migration-docs", "red-team" ] }, { "type": "null" } ], "title": "Scan Type", "description": "Type of scan to run. Must match the profile's scan type when a profile is given; defaults to the profile's type, or 'security' for profile-less scans. Non-security types require a profile and are rejected without one." }, "commit_sha": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Commit Sha", "description": "Commit to check out before scanning." }, "effort": { "anyOf": [ { "type": "string", "enum": [ "normal", "deep" ] }, { "type": "null" } ], "title": "Effort", "description": "Scan effort: 'normal' (default) uses lower model reasoning effort with larger investigation batches; 'deep' runs the full pipeline." }, "interactive": { "type": "boolean", "title": "Interactive", "description": "When true, the scan pauses for user review between threat modeling and investigation.", "default": false }, "devin_mode": { "anyOf": [ { "type": "string", "enum": [ "fusion", "swe-2" ] }, { "type": "null" } ], "title": "Devin Mode", "description": "Agent the scan's sessions run on: 'fusion' or 'swe-2' (SWE-2 Max for 'deep' effort, SWE-2 High for 'normal'). Applies only when the mode is enabled for the organization; otherwise, and when omitted, the scan runs on the default agent." }, "platform": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "title": "Platform", "description": "Where the scan's sessions run: a platform label configured for the organization (e.g. 'linux', 'windows', 'macos') or the name of an outpost (BYOB) pool, case-insensitive; platforms take priority when a name matches both. Omitted means the organization default. Unrecognized values are rejected with a 400 whose error body lists the available platform labels and outpost pool names." }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Locale", "description": "BCP-47 language tag (e.g. 'ja') for the scan's user-facing output: finding titles, descriptions, and reports. Omitted means English." }, "new_budget": { "anyOf": [ { "$ref": "#/components/schemas/NewScanBudget" }, { "type": "null" } ], "description": "Give the scan its own ACU budget. Requires the ManageAccountServiceUsers and ManageAcuLimits permissions." }, "board_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Board Id", "description": "A finding board made ahead of the scan for it to adopt instead of getting a fresh one, so automations could be wired to it before the scan existed." } }, "type": "object", "title": "OrgCodeScanCreateRequest", "description": "Request body for starting a new code scan." }, "OrgDefaultPlatformResponse": { "properties": { "platform": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Platform", "description": "Hosted platform label (e.g. 'linux', 'windows') new sessions run on by default. Null when the default is an outpost pool or unset." }, "outpost_pool_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Outpost Pool Id", "description": "Outpost pool new sessions run on by default. Null when the default is a hosted platform or unset." }, "outpost_pool_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Outpost Pool Name", "description": "Name of the default outpost pool. Null when the default is not an outpost pool, or the pool is no longer available to the organization." } }, "type": "object", "required": [ "platform", "outpost_pool_id", "outpost_pool_name" ], "title": "OrgDefaultPlatformResponse", "description": "The organization's default placement for new sessions." }, "OrgDefaultPlatformUpdateRequest": { "properties": { "platform": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "title": "Platform", "description": "A hosted platform label configured for the organization (e.g. 'linux', 'windows', 'macos') or the name of a shared outpost pool, case-insensitive; platforms take priority when a name matches both. Unrecognized values are rejected with a 400 that lists the available platforms and outpost pools." }, "outpost_pool_id": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "title": "Outpost Pool Id", "description": "ID of a shared outpost pool available to the organization." } }, "type": "object", "title": "OrgDefaultPlatformUpdateRequest", "description": "Set the organization's default placement for new sessions.\n\nSend at most one of ``platform`` and ``outpost_pool_id``; send both as\nnull (for example ``{}``) to clear the default." }, "OrgGroupConfig": { "properties": { "org_ids": { "items": { "type": "string" }, "type": "array", "uniqueItems": true, "title": "Org Ids" }, "max_cycle_acus": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Cycle Acus" } }, "type": "object", "required": [ "org_ids" ], "title": "OrgGroupConfig" }, "OrgGroupsConfig": { "properties": { "groups": { "additionalProperties": { "$ref": "#/components/schemas/OrgGroupConfig" }, "type": "object", "title": "Groups" } }, "type": "object", "required": [ "groups" ], "title": "OrgGroupsConfig", "description": "Configuration mapping group names to their settings." }, "OrganizationCreateRequest": { "properties": { "name": { "type": "string", "title": "Name" }, "max_session_acu_limit": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Session Acu Limit" }, "max_cycle_acu_limit": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Cycle Acu Limit" } }, "type": "object", "required": [ "name" ], "title": "OrganizationCreateRequest" }, "OrganizationResponse": { "properties": { "org_id": { "type": "string", "title": "Org Id" }, "name": { "type": "string", "title": "Name" }, "created_at": { "type": "integer", "title": "Created At" }, "updated_at": { "type": "integer", "title": "Updated At" }, "max_session_acu_limit": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Session Acu Limit" }, "max_cycle_acu_limit": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Cycle Acu Limit" }, "budget_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Budget Id", "description": "Identifier of the active budget linked to the organization, or null if no active budget is linked." } }, "type": "object", "required": [ "org_id", "name", "created_at", "updated_at", "max_session_acu_limit", "max_cycle_acu_limit", "budget_id" ], "title": "OrganizationResponse" }, "OrganizationUpdateRequest": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "max_session_acu_limit": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Session Acu Limit" }, "max_cycle_acu_limit": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Cycle Acu Limit" } }, "type": "object", "title": "OrganizationUpdateRequest" }, "PaginatedResponse_ACULimitResponse_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/ACULimitResponse" }, "type": "array", "title": "Items" }, "end_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page." }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total", "description": "Optional total count (can be omitted for performance)." } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[ACULimitResponse]" }, "PaginatedResponse_ApiKeyResponse_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/ApiKeyResponse" }, "type": "array", "title": "Items" }, "end_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page." }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total", "description": "Optional total count (can be omitted for performance)." } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[ApiKeyResponse]" }, "PaginatedResponse_AuditLogResponse_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/AuditLogResponse" }, "type": "array", "title": "Items" }, "end_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page." }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total", "description": "Optional total count (can be omitted for performance)." } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[AuditLogResponse]" }, "PaginatedResponse_AutomationResponse_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/AutomationResponse" }, "type": "array", "title": "Items" }, "end_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page." }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total", "description": "Optional total count (can be omitted for performance)." } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[AutomationResponse]" }, "PaginatedResponse_Build_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/Build" }, "type": "array", "title": "Items" }, "end_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page." }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total", "description": "Optional total count (can be omitted for performance)." } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[Build]" }, "PaginatedResponse_CodeScanFindingResponse_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/CodeScanFindingResponse" }, "type": "array", "title": "Items" }, "end_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page." }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total", "description": "Optional total count (can be omitted for performance)." } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[CodeScanFindingResponse]" }, "PaginatedResponse_CodeScanProfileSummaryResponse_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/CodeScanProfileSummaryResponse" }, "type": "array", "title": "Items" }, "end_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page." }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total", "description": "Optional total count (can be omitted for performance)." } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[CodeScanProfileSummaryResponse]" }, "PaginatedResponse_CodeScanResponse_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/CodeScanResponse" }, "type": "array", "title": "Items" }, "end_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page." }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total", "description": "Optional total count (can be omitted for performance)." } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[CodeScanResponse]" }, "PaginatedResponse_ConsumptionCycle_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/ConsumptionCycle" }, "type": "array", "title": "Items" }, "end_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page." }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total", "description": "Optional total count (can be omitted for performance)." } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[ConsumptionCycle]" }, "PaginatedResponse_EnterpriseSecurityProfileResponse_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/EnterpriseSecurityProfileResponse" }, "type": "array", "title": "Items" }, "end_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page." }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total", "description": "Optional total count (can be omitted for performance)." } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[EnterpriseSecurityProfileResponse]" }, "PaginatedResponse_EnterpriseUser_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/EnterpriseUser" }, "type": "array", "title": "Items" }, "end_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page." }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total", "description": "Optional total count (can be omitted for performance)." } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[EnterpriseUser]" }, "PaginatedResponse_GitConnectionRepositoryResponse_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/GitConnectionRepositoryResponse" }, "type": "array", "title": "Items" }, "end_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page." }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total", "description": "Optional total count (can be omitted for performance)." } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[GitConnectionRepositoryResponse]" }, "PaginatedResponse_GitConnectionResponse_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/GitConnectionResponse" }, "type": "array", "title": "Items" }, "end_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page." }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total", "description": "Optional total count (can be omitted for performance)." } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[GitConnectionResponse]" }, "PaginatedResponse_GitPermissionResponse_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/GitPermissionResponse" }, "type": "array", "title": "Items" }, "end_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page." }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total", "description": "Optional total count (can be omitted for performance)." } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[GitPermissionResponse]" }, "PaginatedResponse_GuardrailViolationResponse_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/GuardrailViolationResponse" }, "type": "array", "title": "Items" }, "end_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page." }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total", "description": "Optional total count (can be omitted for performance)." } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[GuardrailViolationResponse]" }, "PaginatedResponse_HypervisorResponse_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/HypervisorResponse" }, "type": "array", "title": "Items" }, "end_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page." }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total", "description": "Optional total count (can be omitted for performance)." } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[HypervisorResponse]" }, "PaginatedResponse_IdpGroupResponse_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/IdpGroupResponse" }, "type": "array", "title": "Items" }, "end_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page." }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total", "description": "Optional total count (can be omitted for performance)." } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[IdpGroupResponse]" }, "PaginatedResponse_IdpGroupUser_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/IdpGroupUser" }, "type": "array", "title": "Items" }, "end_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page." }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total", "description": "Optional total count (can be omitted for performance)." } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[IdpGroupUser]" }, "PaginatedResponse_IdpGroup_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/IdpGroup" }, "type": "array", "title": "Items" }, "end_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page." }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total", "description": "Optional total count (can be omitted for performance)." } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[IdpGroup]" }, "PaginatedResponse_KnowledgeNoteResponse_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/KnowledgeNoteResponse" }, "type": "array", "title": "Items" }, "end_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page." }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total", "description": "Optional total count (can be omitted for performance)." } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[KnowledgeNoteResponse]" }, "PaginatedResponse_OncallResponderResponse_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/OncallResponderResponse" }, "type": "array", "title": "Items" }, "end_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page." }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total", "description": "Optional total count (can be omitted for performance)." } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[OncallResponderResponse]" }, "PaginatedResponse_OrganizationResponse_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/OrganizationResponse" }, "type": "array", "title": "Items" }, "end_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page." }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total", "description": "Optional total count (can be omitted for performance)." } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[OrganizationResponse]" }, "PaginatedResponse_PlaybookResponse_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/PlaybookResponse" }, "type": "array", "title": "Items" }, "end_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page." }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total", "description": "Optional total count (can be omitted for performance)." } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[PlaybookResponse]" }, "PaginatedResponse_RepositoryIndexingResponse_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/RepositoryIndexingResponse" }, "type": "array", "title": "Items" }, "end_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page." }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total", "description": "Optional total count (can be omitted for performance)." } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[RepositoryIndexingResponse]" }, "PaginatedResponse_RepositoryResponse_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/RepositoryResponse" }, "type": "array", "title": "Items" }, "end_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page." }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total", "description": "Optional total count (can be omitted for performance)." } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[RepositoryResponse]" }, "PaginatedResponse_Role_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/Role" }, "type": "array", "title": "Items" }, "end_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page." }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total", "description": "Optional total count (can be omitted for performance)." } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[Role]" }, "PaginatedResponse_ScheduleResponse_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/ScheduleResponse" }, "type": "array", "title": "Items" }, "end_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page." }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total", "description": "Optional total count (can be omitted for performance)." } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[ScheduleResponse]" }, "PaginatedResponse_SecretResponse_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/SecretResponse" }, "type": "array", "title": "Items" }, "end_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page." }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total", "description": "Optional total count (can be omitted for performance)." } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[SecretResponse]" }, "PaginatedResponse_SecurityProfileResponse_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/SecurityProfileResponse" }, "type": "array", "title": "Items" }, "end_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page." }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total", "description": "Optional total count (can be omitted for performance)." } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[SecurityProfileResponse]" }, "PaginatedResponse_ServiceUser_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/ServiceUser" }, "type": "array", "title": "Items" }, "end_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page." }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total", "description": "Optional total count (can be omitted for performance)." } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[ServiceUser]" }, "PaginatedResponse_SessionConsumptionResponse_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/SessionConsumptionResponse" }, "type": "array", "title": "Items" }, "end_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page." }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total", "description": "Optional total count (can be omitted for performance)." } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[SessionConsumptionResponse]" }, "PaginatedResponse_SessionInsightsResponse_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/SessionInsightsResponse" }, "type": "array", "title": "Items" }, "end_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page." }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total", "description": "Optional total count (can be omitted for performance)." } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[SessionInsightsResponse]" }, "PaginatedResponse_SessionMessage_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/SessionMessage" }, "type": "array", "title": "Items" }, "end_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page." }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total", "description": "Optional total count (can be omitted for performance)." } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[SessionMessage]" }, "PaginatedResponse_SessionResponse_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/SessionResponse" }, "type": "array", "title": "Items" }, "end_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page." }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total", "description": "Optional total count (can be omitted for performance)." } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[SessionResponse]" }, "PaginatedResponse_User_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/User" }, "type": "array", "title": "Items" }, "end_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page." }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total", "description": "Optional total count (can be omitted for performance)." } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[User]" }, "PatUserSelf": { "properties": { "principal_type": { "type": "string", "const": "pat_user", "title": "Principal Type" }, "user_id": { "type": "string", "title": "User Id" }, "user_name": { "type": "string", "title": "User Name" }, "api_key_id": { "type": "string", "title": "Api Key Id" }, "api_key_name": { "type": "string", "title": "Api Key Name" }, "org_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Org Id" }, "devin_sessions_org_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Devin Sessions Org Id", "description": "Organization the caller's Devin Cloud sessions run in: the one named with x-cog-org-id, or without it the first organization visible to the user. Either way only an organization in which the user may use Devin sessions, and never an enterprise's primary organization. Null when there is none." }, "primary_billing_org_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Primary Billing Org Id", "description": "Organization the user's CLI and Desktop usage is billed to: the account's organization, or in an enterprise the user's primary billing organization. Null when there is none or the user may not use Devin sessions in it." } }, "type": "object", "required": [ "principal_type", "user_id", "user_name", "api_key_id", "api_key_name" ], "title": "PatUserSelf", "description": "Identity information for an authenticated PAT user." }, "PinBuildBody": { "properties": {}, "type": "object", "title": "PinBuildBody", "description": "``POST /builds/{id}/pin`` body. Empty per spec." }, "PlaybookCreateRequest": { "properties": { "title": { "type": "string", "title": "Title" }, "body": { "type": "string", "title": "Body" }, "macro": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Macro", "description": "Playbook macro identifier. Must start with '!' followed by one or more letters, digits, underscores, or hyphens. Example: '!my_macro' or '!my-macro'" }, "structured_output_schema": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Structured Output Schema", "description": "JSON Schema (Draft 7) that sessions using this playbook will produce as structured output. Max 64KB. Must be self-contained (no external $ref)." } }, "type": "object", "required": [ "title", "body" ], "title": "PlaybookCreateRequest" }, "PlaybookInfo": { "properties": { "playbook_id": { "type": "string", "title": "Playbook Id" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" } }, "type": "object", "required": [ "playbook_id", "title" ], "title": "PlaybookInfo" }, "PlaybookResponse": { "properties": { "playbook_id": { "type": "string", "title": "Playbook Id" }, "title": { "type": "string", "title": "Title" }, "body": { "type": "string", "title": "Body" }, "macro": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Macro" }, "created_by": { "type": "string", "title": "Created By" }, "updated_by": { "type": "string", "title": "Updated By" }, "created_at": { "type": "integer", "title": "Created At" }, "updated_at": { "type": "integer", "title": "Updated At" }, "access_type": { "type": "string", "enum": [ "enterprise", "org" ], "title": "Access Type" }, "org_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Org Id" }, "structured_output_schema": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Structured Output Schema" } }, "type": "object", "required": [ "playbook_id", "title", "body", "macro", "created_by", "updated_by", "created_at", "updated_at", "access_type", "org_id" ], "title": "PlaybookResponse" }, "PrMetricsResponse": { "properties": { "prs_created_count": { "type": "integer", "title": "Prs Created Count", "description": "Total PRs Devin authored across all states (open + merged + closed)." }, "prs_opened_count": { "type": "integer", "title": "Prs Opened Count", "description": "PRs Devin authored that are currently open." }, "prs_merged_count": { "type": "integer", "title": "Prs Merged Count", "description": "PRs Devin authored that were merged." }, "prs_closed_count": { "type": "integer", "title": "Prs Closed Count", "description": "PRs Devin authored that were closed without merging." }, "prs_taken_over_count": { "type": "integer", "title": "Prs Taken Over Count", "description": "Total PRs Devin took over across all states (open + merged + closed). A take-over is when Devin pushed commits to a PR it did not originally create.", "default": 0 }, "prs_taken_over_opened_count": { "type": "integer", "title": "Prs Taken Over Opened Count", "description": "PRs Devin took over that are currently open.", "default": 0 }, "prs_taken_over_merged_count": { "type": "integer", "title": "Prs Taken Over Merged Count", "description": "PRs Devin took over that were merged.", "default": 0 }, "prs_taken_over_closed_count": { "type": "integer", "title": "Prs Taken Over Closed Count", "description": "PRs Devin took over that were closed without merging.", "default": 0 } }, "type": "object", "required": [ "prs_created_count", "prs_opened_count", "prs_merged_count", "prs_closed_count" ], "title": "PrMetricsResponse", "description": "Response model for PR metrics." }, "PrReviewCreateRequest": { "properties": { "pr_url": { "type": "string", "title": "Pr Url", "description": "Full URL of the pull/merge request to review (e.g. `https://github.com/owner/repo/pull/123`).", "examples": [ "https://github.com/owner/repo/pull/123" ] } }, "type": "object", "required": [ "pr_url" ], "title": "PrReviewCreateRequest" }, "PrReviewResponse": { "properties": { "status": { "type": "string", "enum": [ "pending", "running", "completed", "errored", "cancelled", "skipped" ], "title": "Status", "description": "Current review status. Newly accepted reviews start as `pending`." }, "repo_path": { "type": "string", "title": "Repo Path", "description": "Normalized host-prefixed repo path (e.g. `github.com/owner/repo`)." }, "pr_number": { "type": "integer", "title": "Pr Number", "description": "Pull/merge request number." }, "commit_sha": { "type": "string", "title": "Commit Sha", "description": "Commit SHA of the PR head that will be reviewed." }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "When the review was accepted." } }, "type": "object", "required": [ "status", "repo_path", "pr_number", "commit_sha", "created_at" ], "title": "PrReviewResponse" }, "PresignedDownload": { "properties": { "url": { "type": "string", "title": "Url", "description": "Presigned GET URL (HTTPS)." }, "expires_at": { "type": "integer", "title": "Expires At", "description": "Unix timestamp at which the URL expires." } }, "type": "object", "required": [ "url", "expires_at" ], "title": "PresignedDownload", "description": "Reusable presigned-URL response (10-minute TTL)." }, "ProblemDetail": { "properties": { "type": { "type": "string", "title": "Type", "description": "A URI reference identifying the problem type.", "default": "about:blank" }, "title": { "type": "string", "title": "Title", "description": "A short, human-readable summary of the problem type." }, "status": { "type": "integer", "title": "Status", "description": "The HTTP status code." }, "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Detail", "description": "A human-readable explanation specific to this occurrence." }, "instance": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Instance", "description": "A URI reference (the request path) for this occurrence." }, "errors": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Errors", "description": "Field-level validation errors (422 responses only)." }, "error_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Code", "description": "Machine-readable code for blocked-action refusals (e.g. \"user_frozen\", \"migrated_session\")." } }, "type": "object", "required": [ "title", "status" ], "title": "ProblemDetail", "description": "RFC 9457 application/problem+json error body for the v3 API.\n\ndetail is retained from the legacy {\"detail\": ...} body for back-compat; the\nother members are additive. errors carries field-level validation failures\n(422 only)." }, "QueueResponse": { "properties": { "queue_size": { "type": "integer", "title": "Queue Size" }, "status": { "type": "string", "enum": [ "normal", "elevated", "high" ], "title": "Status" } }, "type": "object", "required": [ "queue_size", "status" ], "title": "QueueResponse", "description": "Response model for queue endpoint." }, "RecoverCodeScanResponse": { "properties": { "scan_id": { "type": "string", "title": "Scan Id", "description": "The recovered scan." }, "status": { "type": "string", "title": "Status", "description": "Scan status after the request: ``running`` once recovered, or the status the scan's session reported in the meantime." }, "session_id": { "type": "string", "title": "Session Id", "description": "The scan's session, which was sent a message to continue." } }, "type": "object", "required": [ "scan_id", "status", "session_id" ], "title": "RecoverCodeScanResponse", "description": "A failed code scan whose session was told to continue." }, "RemediateFindingResponse": { "properties": { "finding_id": { "type": "string", "title": "Finding Id", "description": "The finding that is being remediated." }, "session_id": { "type": "string", "title": "Session Id", "description": "ID of the Devin session launched to remediate the finding." } }, "type": "object", "required": [ "finding_id", "session_id" ], "title": "RemediateFindingResponse", "description": "The remediation session launched for a code scan finding." }, "RemediateFindingsRequest": { "properties": { "branch": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Branch", "description": "Base branch for remediation pull requests; defaults to the repository default branch." }, "finding_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "maxItems": 1000, "minItems": 1 }, { "type": "null" } ], "title": "Finding Ids", "description": "Findings to remediate together; all must belong to the scan and be open, and may span repositories." }, "select_all": { "anyOf": [ { "$ref": "#/components/schemas/RemediateFindingsSelection" }, { "type": "null" } ], "description": "Remediate every open finding of the scan matching these filters that does not already have a remediation session, minus `exclude_finding_ids`. Findings the filters match but which are closed or already being remediated are skipped and counted in `skipped_count`. Fails with 400 when more than 1000 findings match." }, "exclude_finding_ids": { "items": { "type": "string" }, "type": "array", "maxItems": 1000, "title": "Exclude Finding Ids", "description": "With `select_all`: findings to leave out of the selection." } }, "type": "object", "title": "RemediateFindingsRequest", "description": "Findings of one scan to hand to a single Devin session.\n\nProvide exactly one of ``finding_ids`` or ``select_all``." }, "RemediateFindingsResponse": { "properties": { "finding_ids": { "items": { "type": "string" }, "type": "array", "title": "Finding Ids", "description": "The findings being remediated: in request order for `finding_ids`, by severity (critical first) for `select_all`." }, "skipped_count": { "type": "integer", "title": "Skipped Count", "description": "Findings matched by `select_all` but left out because they are closed or already have a remediation session. Always 0 for `finding_ids`.", "default": 0 }, "session_id": { "type": "string", "title": "Session Id", "description": "ID of the Devin session launched for the findings. A batch of two or more findings gets a planner session that groups them and launches a fix session (one branch, one pull request) per group; each finding's `session_id` and `pr_url` then point at its fix session. A single finding gets a fix session directly." } }, "type": "object", "required": [ "finding_ids", "session_id" ], "title": "RemediateFindingsResponse", "description": "The Devin session launched for a batch of code scan findings." }, "RemediateFindingsSelection": { "properties": { "repo_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Repo Name", "description": "Only findings reported in this repository." }, "severity": { "anyOf": [ { "items": { "type": "string", "enum": [ "critical", "high", "medium", "low" ] }, "type": "array", "maxItems": 4, "minItems": 1 }, { "type": "null" } ], "title": "Severity", "description": "Only findings with any of these severities (critical, high, medium, low)." } }, "additionalProperties": false, "type": "object", "title": "RemediateFindingsSelection", "description": "Filters selecting every remediable finding of a scan." }, "RemoveRepositoriesRequest": { "properties": { "repository_paths": { "items": { "type": "string" }, "type": "array", "maxItems": 100, "minItems": 1, "title": "Repository Paths" } }, "type": "object", "required": [ "repository_paths" ], "title": "RemoveRepositoriesRequest" }, "RepoIndexJobResponse": { "properties": { "job_id": { "type": "string", "title": "Job Id" }, "status": { "type": "string", "enum": [ "failed", "completed", "in_progress" ], "title": "Status" }, "commit": { "type": "string", "title": "Commit" }, "branch_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Branch Name" }, "created_at": { "type": "integer", "title": "Created At" } }, "type": "object", "required": [ "job_id", "status", "commit", "branch_name", "created_at" ], "title": "RepoIndexJobResponse" }, "RepoIndexingStatusResponse": { "properties": { "indexing_enabled": { "type": "boolean", "title": "Indexing Enabled" }, "latest_indexes": { "items": { "$ref": "#/components/schemas/RepoIndexJobResponse" }, "type": "array", "title": "Latest Indexes" }, "latest_completed_search_index_job": { "anyOf": [ { "$ref": "#/components/schemas/RepoIndexJobResponse" }, { "type": "null" } ] }, "latest_completed_wiki_index_job": { "anyOf": [ { "$ref": "#/components/schemas/RepoIndexJobResponse" }, { "type": "null" } ] } }, "type": "object", "required": [ "indexing_enabled", "latest_indexes", "latest_completed_search_index_job", "latest_completed_wiki_index_job" ], "title": "RepoIndexingStatusResponse" }, "RepositoryIndexingItem": { "properties": { "repository_path": { "type": "string", "title": "Repository Path", "description": "e.g., 'org/repo-name'" }, "branch_names": { "items": { "type": "string" }, "type": "array", "title": "Branch Names" } }, "type": "object", "required": [ "repository_path" ], "title": "RepositoryIndexingItem" }, "RepositoryIndexingResponse": { "properties": { "repository_path": { "type": "string", "title": "Repository Path" }, "indexing_enabled": { "type": "boolean", "title": "Indexing Enabled" }, "branches": { "items": { "type": "string" }, "type": "array", "title": "Branches" }, "indexing_status": { "anyOf": [ { "$ref": "#/components/schemas/RepoIndexingStatusResponse" }, { "type": "null" } ] } }, "type": "object", "required": [ "repository_path", "indexing_enabled", "branches" ], "title": "RepositoryIndexingResponse" }, "RepositoryResponse": { "properties": { "provider_repository_id": { "type": "string", "title": "Provider Repository Id" }, "git_connection_id": { "type": "string", "title": "Git Connection Id" }, "git_connection_host": { "type": "string", "title": "Git Connection Host" }, "repo_name": { "type": "string", "title": "Repo Name" }, "repo_path": { "type": "string", "title": "Repo Path" }, "repo_full_name": { "type": "string", "title": "Repo Full Name", "description": "Devin's identifier for the repository, used as repository_path by the indexing and blueprint endpoints: the path for github.com (e.g. 'org/repo'), host-prefixed for other git hosts (e.g. 'gitlab.example.com/group/repo'), or a perforce:// URI." }, "repo_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Repo Description" }, "last_updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Last Updated At" }, "repo_language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Repo Language" }, "indexing_status": { "anyOf": [ { "$ref": "#/components/schemas/RepoIndexingStatusResponse" }, { "type": "null" } ] } }, "type": "object", "required": [ "provider_repository_id", "git_connection_id", "git_connection_host", "repo_name", "repo_path", "repo_full_name", "repo_description", "last_updated_at", "repo_language", "indexing_status" ], "title": "RepositoryResponse" }, "Role": { "properties": { "role_name": { "type": "string", "title": "Role Name" }, "role_id": { "type": "string", "title": "Role Id" }, "role_type": { "type": "string", "enum": [ "enterprise", "org" ], "title": "Role Type" } }, "type": "object", "required": [ "role_name", "role_id", "role_type" ], "title": "Role" }, "RoleAssignment": { "properties": { "role": { "$ref": "#/components/schemas/Role" }, "org_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Org Id" } }, "type": "object", "required": [ "role" ], "title": "RoleAssignment" }, "RoleDetailResponse": { "properties": { "role_name": { "type": "string", "title": "Role Name" }, "role_id": { "type": "string", "title": "Role Id" }, "role_type": { "type": "string", "enum": [ "enterprise", "org" ], "title": "Role Type" }, "permissions": { "items": { "type": "string" }, "type": "array", "title": "Permissions", "description": "List of permission identifiers granted to this role." } }, "type": "object", "required": [ "role_name", "role_id", "role_type" ], "title": "RoleDetailResponse" }, "RotateApiKeyRequest": { "properties": { "new_key_expires_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "New Key Expires At", "description": "Optional expiration for the new key as a UNIX timestamp in seconds. Null for no expiration." }, "revoke_current": { "type": "boolean", "title": "Revoke Current", "description": "Whether to revoke the current key. Set to False for graceful rollover.", "default": true } }, "type": "object", "title": "RotateApiKeyRequest" }, "ScanNewCommitsResponse": { "properties": { "scan_id": { "type": "string", "title": "Scan Id", "description": "The scan the incremental run belongs to." }, "status": { "type": "string", "title": "Status", "description": "Scan status after the request: ``waiting`` once the run is enqueued, or ``completed`` when no new commits landed since the last scan and the run was recorded without starting a session." } }, "type": "object", "required": [ "scan_id", "status" ], "title": "ScanNewCommitsResponse", "description": "An incremental (diff) scan run recorded for a code scan." }, "ScanRepoRequest": { "properties": { "repo_name": { "type": "string", "title": "Repo Name", "description": "Full name of the repository to scan." }, "host": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Host", "description": "Git host of the repository, if known." } }, "type": "object", "required": [ "repo_name" ], "title": "ScanRepoRequest", "description": "A repository to include in a multi-repo scan." }, "ScheduleCreateRequest": { "properties": { "name": { "type": "string", "title": "Name" }, "prompt": { "type": "string", "title": "Prompt" }, "playbook_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Playbook Id" }, "skill_ref": { "anyOf": [ { "$ref": "#/components/schemas/SkillReference" }, { "type": "null" } ], "description": "Exact skill the sessions run with. Use instead of playbook_id for new configurations." }, "frequency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Frequency" }, "interval_count": { "type": "integer", "title": "Interval Count", "default": 1 }, "schedule_type": { "type": "string", "enum": [ "recurring", "one_time" ], "title": "Schedule Type", "default": "recurring" }, "scheduled_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Scheduled At" }, "notify_on": { "type": "string", "enum": [ "always", "failure", "never" ], "title": "Notify On", "default": "failure" }, "agent": { "type": "string", "enum": [ "devin", "data_analyst" ], "title": "Agent", "default": "devin" }, "bypass_approval": { "type": "boolean", "title": "Bypass Approval", "default": false }, "create_as_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Create As User Id" }, "slack_channel_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Slack Channel Id" }, "slack_team_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Slack Team Id" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags" }, "target_devin_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Devin Id" }, "platform": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Platform", "description": "VM platform for sessions spawned by this schedule (e.g. 'windows'). When omitted, sessions fall back to the org's default platform at trigger time. Value must match a platform configured for the organization (case-insensitive); unknown values are rejected with a 400 that lists the available platform labels." } }, "type": "object", "required": [ "name", "prompt" ], "title": "ScheduleCreateRequest" }, "ScheduleResponse": { "properties": { "scheduled_session_id": { "type": "string", "title": "Scheduled Session Id" }, "org_id": { "type": "string", "title": "Org Id" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By" }, "last_edited_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Edited By" }, "name": { "type": "string", "title": "Name" }, "prompt": { "type": "string", "title": "Prompt" }, "playbook": { "anyOf": [ { "$ref": "#/components/schemas/PlaybookInfo" }, { "type": "null" } ] }, "skill_ref": { "anyOf": [ { "$ref": "#/components/schemas/SkillReference" }, { "type": "null" } ], "description": "Exact skill the sessions run with. Use instead of playbook_id for new configurations." }, "frequency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Frequency" }, "interval_count": { "type": "integer", "title": "Interval Count", "default": 1 }, "schedule_type": { "type": "string", "enum": [ "recurring", "one_time" ], "title": "Schedule Type", "default": "recurring" }, "scheduled_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Scheduled At" }, "enabled": { "type": "boolean", "title": "Enabled" }, "last_executed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Executed At" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" }, "last_error_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Error At" }, "last_error_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Error Message" }, "consecutive_failures": { "type": "integer", "title": "Consecutive Failures" }, "notify_on": { "type": "string", "enum": [ "always", "failure", "never" ], "title": "Notify On" }, "agent": { "type": "string", "enum": [ "devin", "data_analyst" ], "title": "Agent" }, "bypass_approval": { "type": "boolean", "title": "Bypass Approval", "default": false }, "slack_channel_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Slack Channel Id" }, "slack_team_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Slack Team Id" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags" }, "target_devin_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Devin Id" }, "platform": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Platform" } }, "type": "object", "required": [ "scheduled_session_id", "org_id", "created_by", "name", "prompt", "playbook", "frequency", "enabled", "last_executed_at", "created_at", "updated_at", "last_error_at", "last_error_message", "consecutive_failures", "notify_on", "agent" ], "title": "ScheduleResponse" }, "ScheduleUpdateRequest": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "prompt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Prompt" }, "playbook_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Playbook Id" }, "skill_ref": { "anyOf": [ { "$ref": "#/components/schemas/SkillReference" }, { "type": "null" } ], "description": "Exact skill the sessions run with. Use instead of playbook_id for new configurations." }, "frequency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Frequency" }, "interval_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Interval Count" }, "schedule_type": { "anyOf": [ { "type": "string", "enum": [ "recurring", "one_time" ] }, { "type": "null" } ], "title": "Schedule Type" }, "scheduled_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Scheduled At" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enabled" }, "notify_on": { "anyOf": [ { "type": "string", "enum": [ "always", "failure", "never" ] }, { "type": "null" } ], "title": "Notify On" }, "agent": { "anyOf": [ { "type": "string", "enum": [ "devin", "data_analyst" ] }, { "type": "null" } ], "title": "Agent" }, "bypass_approval": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Bypass Approval" }, "run_as_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Run As User Id", "description": "Set the user ID that this schedule will run as. Requires ImpersonateOrgSessions permission. Setting to null reverts to the default bot user. Omitting the field leaves the current identity unchanged." }, "slack_channel_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Slack Channel Id" }, "slack_team_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Slack Team Id" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags" }, "target_devin_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Devin Id" }, "platform": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Platform", "description": "VM platform for sessions spawned by this schedule (e.g. 'windows'). When omitted, the platform is left unchanged. Value must match a platform configured for the organization (case-insensitive); unknown values are rejected with a 400 that lists the available platform labels." } }, "type": "object", "title": "ScheduleUpdateRequest" }, "SearchMetricsResponse": { "properties": { "searches_created_count": { "type": "integer", "title": "Searches Created Count" } }, "type": "object", "required": [ "searches_created_count" ], "title": "SearchMetricsResponse", "description": "Response model for search metrics." }, "SecretCreateRequest": { "properties": { "type": { "type": "string", "enum": [ "cookie", "key-value", "totp" ], "title": "Type" }, "key": { "type": "string", "title": "Key" }, "value": { "type": "string", "title": "Value" }, "is_sensitive": { "type": "boolean", "title": "Is Sensitive", "default": true }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note" } }, "type": "object", "required": [ "type", "key", "value" ], "title": "SecretCreateRequest" }, "SecretResponse": { "properties": { "secret_id": { "type": "string", "title": "Secret Id" }, "key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Key" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note" }, "is_sensitive": { "type": "boolean", "title": "Is Sensitive" }, "created_by": { "type": "string", "title": "Created By" }, "created_at": { "type": "integer", "title": "Created At" }, "secret_type": { "type": "string", "enum": [ "cookie", "key-value", "totp" ], "title": "Secret Type" }, "access_type": { "type": "string", "enum": [ "org", "personal" ], "title": "Access Type" }, "updated_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Updated At" }, "updated_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated By" } }, "type": "object", "required": [ "secret_id", "key", "note", "is_sensitive", "created_by", "created_at", "secret_type", "access_type" ], "title": "SecretResponse" }, "SecurityProfileCreateRequest": { "properties": { "name": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Name" }, "net_policy": { "anyOf": [ { "$ref": "#/components/schemas/SecurityProfileNetPolicy" }, { "type": "null" } ], "description": "Omitted = an allow list containing only the git integration host (the same default the Security Profiles UI starts from); explicit null = this profile has no network opinion (it does NOT mean deny-all). Because the default allow list does not include api.github.com, a request with remove_github_cli_token=false must supply net_policy explicitly (or null)." }, "mcp_config": { "anyOf": [ { "$ref": "#/components/schemas/SecurityProfileMcpConfig" }, { "type": "null" } ] }, "git_access_level": { "type": "string", "enum": [ "read_only", "read_write" ], "title": "Git Access Level", "default": "read_write" }, "enforcement_level": { "type": "string", "enum": [ "recommended", "mandatory" ], "title": "Enforcement Level", "default": "recommended" }, "devin_mcp_read_only": { "type": "boolean", "title": "Devin Mcp Read Only", "default": false }, "remove_github_cli_token": { "type": "boolean", "title": "Remove Github Cli Token", "default": true }, "slack_channel_access": { "anyOf": [ { "$ref": "#/components/schemas/SecurityProfileSlackChannelAccess" }, { "type": "null" } ], "description": "Omitted or null = this profile has no Slack channel opinion (the organization's Slack setting applies)." }, "slack_dm_scope": { "anyOf": [ { "type": "string", "enum": [ "disabled", "org_members", "workspace" ] }, { "type": "null" } ], "title": "Slack Dm Scope", "description": "Omitted or null = this profile has no Slack DM opinion (the organization's Slack setting applies)." }, "teams_channel_access": { "anyOf": [ { "$ref": "#/components/schemas/SecurityProfileTeamsChannelAccess" }, { "type": "null" } ], "description": "Omitted or null = this profile has no Teams channel opinion (the organization's Teams Default Access applies)." }, "teams_dm_scope": { "anyOf": [ { "type": "string", "enum": [ "disabled", "installed_users" ] }, { "type": "null" } ], "title": "Teams Dm Scope", "description": "Omitted or null = this profile has no Teams DM opinion (the organization's Teams Default Access applies)." }, "teams_group_chat_scope": { "anyOf": [ { "type": "string", "enum": [ "disabled", "origin_chat" ] }, { "type": "null" } ], "title": "Teams Group Chat Scope", "description": "Omitted or null = this profile has no Teams group-chat opinion (derived from the organization's Teams Default Access like DMs)." } }, "additionalProperties": false, "type": "object", "required": [ "name" ], "title": "SecurityProfileCreateRequest" }, "SecurityProfileDefaultSelection": { "properties": { "selection": { "type": "string", "enum": [ "inherit", "none", "profile" ], "title": "Selection" }, "profile_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Id", "description": "Required when selection is 'profile'; must be omitted otherwise." } }, "additionalProperties": false, "type": "object", "required": [ "selection" ], "title": "SecurityProfileDefaultSelection", "description": "A tri-state default: inherit (no binding of its own \u2014 fall through to\nthe ancestor's default), none (explicit opt-out: no profile, even when an\nancestor has a recommended default), or profile (pin profile_id).\n\nAn opt-out cannot escape a mandatory ancestor profile: it is stored\nfaithfully but has no effect while the mandatory profile exists." }, "SecurityProfileDefaultState": { "properties": { "selection": { "type": "string", "enum": [ "inherit", "none", "profile" ], "title": "Selection" }, "profile_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Id" }, "profile_scope": { "anyOf": [ { "type": "string", "enum": [ "org", "enterprise" ] }, { "type": "null" } ], "title": "Profile Scope", "description": "Owning scope of the pinned profile. Set only when selection is 'profile'; an org default may pin an enterprise-shared profile." } }, "additionalProperties": false, "type": "object", "required": [ "selection" ], "title": "SecurityProfileDefaultState", "description": "Read view of one stored default binding." }, "SecurityProfileHostnameDestination": { "properties": { "hostname": { "type": "string", "title": "Hostname" } }, "additionalProperties": false, "type": "object", "required": [ "hostname" ], "title": "SecurityProfileHostnameDestination" }, "SecurityProfileIpv4Destination": { "properties": { "ipv4": { "type": "string", "title": "Ipv4" } }, "additionalProperties": false, "type": "object", "required": [ "ipv4" ], "title": "SecurityProfileIpv4Destination" }, "SecurityProfileIpv6Destination": { "properties": { "ipv6": { "type": "string", "title": "Ipv6" } }, "additionalProperties": false, "type": "object", "required": [ "ipv6" ], "title": "SecurityProfileIpv6Destination" }, "SecurityProfileMcpConfig": { "properties": { "servers": { "items": { "type": "string" }, "type": "array", "title": "Servers", "description": "MCP servers sessions governed by this profile may use, keyed by slug: a marketplace slug (the slug field of the mcp-servers resource, e.g. 'github', 'notion') or an installation's slug. When a custom installation shares a slug with a marketplace server, the custom installation wins." } }, "additionalProperties": false, "type": "object", "required": [ "servers" ], "title": "SecurityProfileMcpConfig" }, "SecurityProfileNetPolicy": { "properties": { "allow": { "items": { "anyOf": [ { "$ref": "#/components/schemas/SecurityProfileHostnameDestination" }, { "$ref": "#/components/schemas/SecurityProfileIpv4Destination" }, { "$ref": "#/components/schemas/SecurityProfileIpv6Destination" } ] }, "type": "array", "title": "Allow", "description": "Allowed destinations; anything not listed is blocked. Hostname entries support wildcards (e.g. *.github.com). An empty list is a valid deny-all policy." } }, "additionalProperties": false, "type": "object", "required": [ "allow" ], "title": "SecurityProfileNetPolicy" }, "SecurityProfileResponse": { "properties": { "profile_id": { "type": "string", "title": "Profile Id", "description": "The security profile's ID." }, "name": { "type": "string", "title": "Name" }, "net_policy": { "anyOf": [ { "$ref": "#/components/schemas/SecurityProfileNetPolicy" }, { "type": "null" } ], "description": "null = this profile has no network opinion (it does NOT mean deny-all)." }, "mcp_config": { "anyOf": [ { "$ref": "#/components/schemas/SecurityProfileMcpConfig" }, { "type": "null" } ], "description": "null = this profile has no MCP opinion." }, "git_access_level": { "type": "string", "enum": [ "read_only", "read_write" ], "title": "Git Access Level" }, "enforcement_level": { "type": "string", "enum": [ "recommended", "mandatory" ], "title": "Enforcement Level", "description": "recommended profiles can be overridden by descendant bindings; mandatory profiles are a floor that descendant policies only narrow." }, "devin_mcp_read_only": { "type": "boolean", "title": "Devin Mcp Read Only", "description": "When true, sessions may only call read-only Devin MCP tools (no session creation, automation management, or other write operations)." }, "remove_github_cli_token": { "type": "boolean", "title": "Remove Github Cli Token", "description": "When true, the GitHub CLI token is removed from the session's machine, preventing direct GitHub API access." }, "slack_channel_access": { "anyOf": [ { "$ref": "#/components/schemas/SecurityProfileSlackChannelAccess" }, { "type": "null" } ], "description": "Ceiling on the Slack channels sessions governed by this profile may read and post in. null = this profile has no opinion and the organization's Slack setting applies." }, "slack_dm_scope": { "anyOf": [ { "type": "string", "enum": [ "disabled", "org_members", "workspace" ] }, { "type": "null" } ], "title": "Slack Dm Scope", "description": "Ceiling on who may DM Devin in Slack under this profile. null = this profile has no opinion and the organization's Slack setting applies. 'workspace' is narrowed to 'org_members' for enterprise accounts." }, "teams_channel_access": { "anyOf": [ { "$ref": "#/components/schemas/SecurityProfileTeamsChannelAccess" }, { "type": "null" } ], "description": "Ceiling on the Microsoft Teams channels sessions governed by this profile may read and post in. null = this profile has no opinion and the organization's Teams Default Access applies." }, "teams_dm_scope": { "anyOf": [ { "type": "string", "enum": [ "disabled", "installed_users" ] }, { "type": "null" } ], "title": "Teams Dm Scope", "description": "Ceiling on who Devin may DM in Microsoft Teams under this profile. null = this profile has no opinion and the organization's Teams Default Access applies." }, "teams_group_chat_scope": { "anyOf": [ { "type": "string", "enum": [ "disabled", "origin_chat" ] }, { "type": "null" } ], "title": "Teams Group Chat Scope", "description": "Ceiling on which Teams group chats Devin may read under this profile; `origin_chat` = only the group chat the session was started from; null = no opinion, derived from the org's Teams Default Access like DMs." }, "created_at": { "type": "integer", "title": "Created At" }, "updated_at": { "type": "integer", "title": "Updated At" }, "org_id": { "type": "string", "title": "Org Id" } }, "additionalProperties": false, "type": "object", "required": [ "profile_id", "name", "git_access_level", "enforcement_level", "devin_mcp_read_only", "remove_github_cli_token", "created_at", "updated_at", "org_id" ], "title": "SecurityProfileResponse", "description": "An organization-owned security profile." }, "SecurityProfileSettingsResponse": { "properties": { "default": { "$ref": "#/components/schemas/SecurityProfileDefaultState" }, "automations_default": { "$ref": "#/components/schemas/SecurityProfileDefaultState", "description": "Default for automation-triggered sessions. Sits between the org/enterprise defaults and each automation's own binding." } }, "additionalProperties": false, "type": "object", "required": [ "default", "automations_default" ], "title": "SecurityProfileSettingsResponse" }, "SecurityProfileSettingsUpdateRequest": { "properties": { "default": { "anyOf": [ { "$ref": "#/components/schemas/SecurityProfileDefaultSelection" }, { "type": "null" } ] }, "automations_default": { "anyOf": [ { "$ref": "#/components/schemas/SecurityProfileDefaultSelection" }, { "type": "null" } ] } }, "additionalProperties": false, "type": "object", "title": "SecurityProfileSettingsUpdateRequest", "description": "PATCH semantics: omitted fields are left unchanged." }, "SecurityProfileSlackChannel": { "properties": { "team_id": { "type": "string", "minLength": 1, "title": "Team Id", "description": "Slack workspace (team) ID." }, "channel_id": { "type": "string", "minLength": 1, "title": "Channel Id", "description": "Slack channel ID." } }, "additionalProperties": false, "type": "object", "required": [ "team_id", "channel_id" ], "title": "SecurityProfileSlackChannel" }, "SecurityProfileSlackChannelAccess": { "properties": { "mode": { "type": "string", "enum": [ "none", "specific", "all_public" ], "title": "Mode", "description": "none = sessions may not read or post in any channel; specific = only the listed channels; all_public = any public channel the Slack app is a member of." }, "channels": { "items": { "$ref": "#/components/schemas/SecurityProfileSlackChannel" }, "type": "array", "title": "Channels", "description": "Channels allowed when mode is 'specific'; ignored (and returned empty) for the other modes." } }, "additionalProperties": false, "type": "object", "required": [ "mode" ], "title": "SecurityProfileSlackChannelAccess" }, "SecurityProfileTeamsChannel": { "properties": { "team_id": { "type": "string", "minLength": 1, "title": "Team Id", "description": "Entra group ID of the Microsoft Teams team." }, "channel_id": { "type": "string", "minLength": 1, "title": "Channel Id", "description": "Teams channel ID ('19:...@thread.tacv2')." } }, "additionalProperties": false, "type": "object", "required": [ "team_id", "channel_id" ], "title": "SecurityProfileTeamsChannel" }, "SecurityProfileTeamsChannelAccess": { "properties": { "mode": { "type": "string", "enum": [ "none", "specific", "installed_teams" ], "title": "Mode", "description": "none = sessions may not read or post in any channel; specific = only the listed channels; installed_teams = any channel of a team the Devin app is installed in." }, "channels": { "items": { "$ref": "#/components/schemas/SecurityProfileTeamsChannel" }, "type": "array", "title": "Channels", "description": "Channels allowed when mode is 'specific'; ignored (and returned empty) for the other modes." } }, "additionalProperties": false, "type": "object", "required": [ "mode" ], "title": "SecurityProfileTeamsChannelAccess" }, "SecurityProfileUpdateRequest": { "properties": { "name": { "anyOf": [ { "type": "string", "maxLength": 128, "minLength": 1 }, { "type": "null" } ], "title": "Name" }, "net_policy": { "anyOf": [ { "$ref": "#/components/schemas/SecurityProfileNetPolicy" }, { "type": "null" } ] }, "mcp_config": { "anyOf": [ { "$ref": "#/components/schemas/SecurityProfileMcpConfig" }, { "type": "null" } ] }, "git_access_level": { "anyOf": [ { "type": "string", "enum": [ "read_only", "read_write" ] }, { "type": "null" } ], "title": "Git Access Level" }, "enforcement_level": { "anyOf": [ { "type": "string", "enum": [ "recommended", "mandatory" ] }, { "type": "null" } ], "title": "Enforcement Level" }, "devin_mcp_read_only": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Devin Mcp Read Only" }, "remove_github_cli_token": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Remove Github Cli Token" }, "slack_channel_access": { "anyOf": [ { "$ref": "#/components/schemas/SecurityProfileSlackChannelAccess" }, { "type": "null" } ] }, "slack_dm_scope": { "anyOf": [ { "type": "string", "enum": [ "disabled", "org_members", "workspace" ] }, { "type": "null" } ], "title": "Slack Dm Scope" }, "teams_channel_access": { "anyOf": [ { "$ref": "#/components/schemas/SecurityProfileTeamsChannelAccess" }, { "type": "null" } ] }, "teams_dm_scope": { "anyOf": [ { "type": "string", "enum": [ "disabled", "installed_users" ] }, { "type": "null" } ], "title": "Teams Dm Scope" }, "teams_group_chat_scope": { "anyOf": [ { "type": "string", "enum": [ "disabled", "origin_chat" ] }, { "type": "null" } ], "title": "Teams Group Chat Scope" } }, "additionalProperties": false, "type": "object", "title": "SecurityProfileUpdateRequest", "description": "PATCH semantics: omitted fields are left unchanged; explicit null\nclears the nullable fields (net_policy, mcp_config, slack_channel_access,\nslack_dm_scope, teams_channel_access, teams_dm_scope,\nteams_group_chat_scope) and is rejected for the others." }, "ServiceUser": { "properties": { "service_user_id": { "type": "string", "title": "Service User Id" }, "name": { "type": "string", "title": "Name" }, "expires_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Expires At" }, "deleted_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Deleted At" }, "role_assignments": { "items": { "$ref": "#/components/schemas/RoleAssignment" }, "type": "array", "title": "Role Assignments" }, "preferences": { "$ref": "#/components/schemas/ServiceUserPreferences" } }, "type": "object", "required": [ "service_user_id", "name", "expires_at", "deleted_at", "role_assignments", "preferences" ], "title": "ServiceUser" }, "ServiceUserPreferences": { "properties": { "memory_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Memory Enabled", "description": "Whether the service user's own sessions use its memory. New service users start with true; left unset on an older service user, it means off. The organization's memory policy applies on top." }, "memory_dreaming_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Memory Dreaming Enabled", "description": "Whether the service user's memory is refined nightly from its sessions. Defaults to on when its memory is on." } }, "type": "object", "title": "ServiceUserPreferences", "description": "Per-service-user switches; a field left null means its default." }, "ServiceUserSelf": { "properties": { "principal_type": { "type": "string", "const": "service_user", "title": "Principal Type" }, "service_user_id": { "type": "string", "title": "Service User Id" }, "service_user_name": { "type": "string", "title": "Service User Name" }, "org_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Org Id" } }, "type": "object", "required": [ "principal_type", "service_user_id", "service_user_name" ], "title": "ServiceUserSelf", "description": "Identity information for an authenticated service user." }, "ServiceUserUpdateRequest": { "properties": { "role_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Role Id", "description": "Role to assign the service user at this scope." }, "preferences": { "anyOf": [ { "$ref": "#/components/schemas/ServiceUserPreferences" }, { "type": "null" } ], "description": "Switches to change; fields left out keep their value. A service user's preferences apply across the whole enterprise." } }, "type": "object", "title": "ServiceUserUpdateRequest" }, "ServiceUserUpdateRoleRequest": { "properties": { "role_id": { "type": "string", "title": "Role Id" } }, "type": "object", "required": [ "role_id" ], "title": "ServiceUserUpdateRoleRequest" }, "SessionApp": { "properties": { "name": { "type": "string", "title": "Name" }, "display_name": { "type": "string", "title": "Display Name" }, "url": { "type": "string", "title": "Url" }, "status": { "type": "string", "enum": [ "serving", "building", "offline" ], "title": "Status", "description": "Whether the App is serving, has its first or latest version still deploying (building), or is not serving (offline)." } }, "type": "object", "required": [ "name", "display_name", "url", "status" ], "title": "SessionApp" }, "SessionAttachment": { "properties": { "attachment_id": { "type": "string", "title": "Attachment Id" }, "name": { "type": "string", "title": "Name" }, "url": { "type": "string", "title": "Url" }, "content_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Content Type" }, "source": { "type": "string", "enum": [ "devin", "user" ], "title": "Source" } }, "type": "object", "required": [ "attachment_id", "name", "url", "source" ], "title": "SessionAttachment", "description": "An attachment sent during a session." }, "SessionConsumptionResponse": { "properties": { "date": { "type": "integer", "title": "Date" }, "acus": { "type": "number", "title": "Acus" }, "acus_by_product": { "$ref": "#/components/schemas/AcusByProduct" }, "session_id": { "type": "string", "title": "Session Id", "description": "Session ID, without the devin- prefix." } }, "type": "object", "required": [ "date", "acus", "acus_by_product", "session_id" ], "title": "SessionConsumptionResponse" }, "SessionCountsByOrigin": { "properties": { "webapp": { "type": "integer", "title": "Webapp", "default": 0 }, "slack": { "type": "integer", "title": "Slack", "default": 0 }, "teams": { "type": "integer", "title": "Teams", "default": 0 }, "api": { "type": "integer", "title": "Api", "default": 0 }, "linear": { "type": "integer", "title": "Linear", "default": 0 }, "jira": { "type": "integer", "title": "Jira", "default": 0 }, "automation": { "type": "integer", "title": "Automation", "default": 0 }, "desktop": { "type": "integer", "title": "Desktop", "default": 0 }, "code_scan": { "type": "integer", "title": "Code Scan", "default": 0 } }, "type": "object", "title": "SessionCountsByOrigin", "description": "Session counts by origin type, exposed on the v3 metrics API.\n\nA curated subset of `SessionOrigin`: legacy origins (cli,\nvscode_extension, devin_spaces) are intentionally not surfaced.\nCounts for sessions with a `scheduled` DB origin roll into\n`automation` via the canonical `db_origin_to_api` mapping, since\nautomations are a superset that schedules will migrate into." }, "SessionCountsBySize": { "properties": { "xs": { "type": "integer", "title": "Xs", "default": 0 }, "s": { "type": "integer", "title": "S", "default": 0 }, "m": { "type": "integer", "title": "M", "default": 0 }, "l": { "type": "integer", "title": "L", "default": 0 }, "xl": { "type": "integer", "title": "Xl", "default": 0 } }, "type": "object", "title": "SessionCountsBySize", "description": "Session counts by size category." }, "SessionCreateRequest": { "properties": { "prompt": { "type": "string", "title": "Prompt" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags" }, "max_acu_limit": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Acu Limit" }, "playbook_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Playbook Id" }, "knowledge_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Knowledge Ids" }, "secret_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Secret Ids" }, "session_secrets": { "anyOf": [ { "items": { "$ref": "#/components/schemas/SessionSecretInput" }, "type": "array" }, { "type": "null" } ], "title": "Session Secrets" }, "repos": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Repos" }, "attachment_urls": { "anyOf": [ { "items": { "type": "string", "maxLength": 2083, "minLength": 1, "format": "uri" }, "type": "array" }, { "type": "null" } ], "title": "Attachment Urls" }, "create_as_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Create As User Id" }, "child_playbook_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Child Playbook Id" }, "session_links": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Session Links" }, "bypass_approval": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Bypass Approval" }, "security_profile": { "anyOf": [ { "$ref": "#/components/schemas/SessionSecurityProfileSelection" }, { "type": "null" } ], "description": "Attach a security profile to this session; omitted = default resolution applies (the playbook's security profile when one is bound, then the org/enterprise default). Requires the security-profile management permission." }, "structured_output_schema": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Structured Output Schema", "description": "JSON Schema (Draft 7) for validating structured output. Max 64KB. Must be self-contained (no external $ref)." }, "structured_output_required": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Structured Output Required", "description": "When true (default), the agent MUST call provide_structured_output with is_final=true before its turn ends. When false, the tool is available but not required \u2014 it is not guaranteed to be called in a given turn." }, "resumable": { "type": "boolean", "title": "Resumable", "description": "Whether to preserve the session's VM state after it stops so the session can be resumed. Set to false for disposable sessions.", "default": true }, "memory_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Memory Enabled", "description": "Set to false to keep memory off for this session and its child sessions: it does not read or write memory, and memory does not learn from its transcript. Omit it, or set it to true, to follow the owner's memory settings; true does not turn on memory that those settings keep off." }, "platform": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Platform", "description": "Override the VM platform for the session (e.g. 'windows'), or the name of an outpost (BYOB) pool to run the session on one of your own machines. When omitted (or set to 'inherit'), a session created by a parent Devin inherits the parent's placement \u2014 both its platform and its outpost pool, so an outpost-placed parent spawns children on the same pool; otherwise the organization default is used. Any value must match either a platform configured for your organization or an outpost pool name (case-insensitive) \u2014 built-in platforms take priority when a name matches both, and a personal outpost pool owned by the caller takes priority over an account-wide pool with the same name. Unrecognized values are rejected with a 400 whose error body lists the available platform labels and outpost pool names for the org." }, "devin_mode": { "anyOf": [ { "type": "string", "enum": [ "normal", "fast", "fusion", "lite", "ultra", "swe-2-medium", "swe-2-high", "swe-2-max" ] }, { "type": "null" } ], "title": "Devin Mode", "description": "Override the Devin agent mode for the session. 'normal' uses the default Agent mode, 'fast' uses Fast mode, 'lite' uses Devin Lite, 'ultra' uses Devin Ultra, and 'fusion' uses Fusion. The other values select the agent mode of the same name in the web app. Preview modes are subject to the same feature flag and enterprise agent preview restrictions as the web app." } }, "type": "object", "required": [ "prompt" ], "title": "SessionCreateRequest" }, "SessionInsightsActionItem": { "properties": { "type": { "type": "string", "enum": [ "machine_setup", "repo_config", "knowledge", "prompt_improvement", "external", "other" ], "title": "Type", "default": "other" }, "action_item": { "type": "string", "title": "Action Item" }, "issue_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Issue Id" } }, "type": "object", "required": [ "action_item" ], "title": "SessionInsightsActionItem" }, "SessionInsightsAnalysis": { "properties": { "issues": { "items": { "$ref": "#/components/schemas/SessionInsightsIssue" }, "type": "array", "title": "Issues", "default": [] }, "timeline": { "items": { "$ref": "#/components/schemas/SessionInsightsTimelineEvent" }, "type": "array", "title": "Timeline", "default": [] }, "action_items": { "items": { "$ref": "#/components/schemas/SessionInsightsActionItem" }, "type": "array", "title": "Action Items", "default": [] }, "suggested_prompt": { "anyOf": [ { "$ref": "#/components/schemas/SessionInsightsSuggestedPrompt" }, { "type": "null" } ] }, "note_usage": { "anyOf": [ { "$ref": "#/components/schemas/SessionInsightsNoteUsage" }, { "type": "null" } ] }, "skill_usage": { "anyOf": [ { "$ref": "#/components/schemas/SessionInsightsSkillUsage" }, { "type": "null" } ] }, "classification": { "anyOf": [ { "$ref": "#/components/schemas/SessionInsightsClassification" }, { "type": "null" } ] } }, "type": "object", "title": "SessionInsightsAnalysis", "description": "AI-generated analysis data from a completed session analysis." }, "SessionInsightsClassification": { "properties": { "category": { "type": "string", "title": "Category" }, "confidence": { "type": "number", "title": "Confidence" }, "tools_and_frameworks": { "items": { "type": "string" }, "type": "array", "title": "Tools And Frameworks", "default": [] }, "programming_languages": { "items": { "type": "string" }, "type": "array", "title": "Programming Languages", "default": [] } }, "type": "object", "required": [ "category", "confidence" ], "title": "SessionInsightsClassification" }, "SessionInsightsFeedbackItem": { "properties": { "summary": { "type": "string", "title": "Summary" }, "excerpt": { "type": "string", "title": "Excerpt" }, "details": { "type": "string", "title": "Details" }, "issue_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Issue Id" } }, "type": "object", "required": [ "summary", "excerpt", "details" ], "title": "SessionInsightsFeedbackItem" }, "SessionInsightsGenerateResponse": { "properties": { "session_id": { "type": "string", "title": "Session Id", "description": "The session ID for which insights generation was triggered." }, "status": { "type": "string", "title": "Status", "description": "The status of the generation request." } }, "type": "object", "required": [ "session_id", "status" ], "title": "SessionInsightsGenerateResponse", "description": "Response from triggering session insights generation." }, "SessionInsightsIssue": { "properties": { "id": { "type": "string", "title": "Id", "default": "" }, "title": { "type": "string", "title": "Title", "default": "" }, "issue": { "type": "string", "title": "Issue" }, "impact": { "type": "string", "title": "Impact" }, "label": { "type": "string", "title": "Label" } }, "type": "object", "required": [ "issue", "impact", "label" ], "title": "SessionInsightsIssue" }, "SessionInsightsNoteUsage": { "properties": { "good_usages": { "items": { "$ref": "#/components/schemas/SessionInsightsNoteUsageItem" }, "type": "array", "title": "Good Usages", "default": [] }, "bad_usages": { "items": { "$ref": "#/components/schemas/SessionInsightsNoteUsageItem" }, "type": "array", "title": "Bad Usages", "default": [] } }, "type": "object", "title": "SessionInsightsNoteUsage" }, "SessionInsightsNoteUsageItem": { "properties": { "reason": { "type": "string", "title": "Reason" }, "message": { "type": "string", "title": "Message" }, "note_id": { "type": "string", "title": "Note Id" } }, "type": "object", "required": [ "reason", "message", "note_id" ], "title": "SessionInsightsNoteUsageItem" }, "SessionInsightsResponse": { "properties": { "session_id": { "type": "string", "title": "Session Id" }, "url": { "type": "string", "title": "Url" }, "status": { "type": "string", "enum": [ "new", "claimed", "running", "exit", "error", "suspended", "resuming" ], "title": "Status" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "tags": { "items": { "type": "string" }, "type": "array", "title": "Tags" }, "playbook_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Playbook Id" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Id" }, "org_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Org Id", "description": "Owning organization. Null for detached sessions, which are owned by their creator's account rather than an organization." }, "created_at": { "type": "integer", "title": "Created At" }, "updated_at": { "type": "integer", "title": "Updated At" }, "is_archived": { "type": "boolean", "title": "Is Archived", "default": false }, "acus_consumed": { "type": "number", "title": "Acus Consumed" }, "pull_requests": { "items": { "$ref": "#/components/schemas/SessionPullRequest" }, "type": "array", "title": "Pull Requests" }, "parent_session_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Parent Session Id" }, "child_session_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Child Session Ids" }, "service_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Service User Id" }, "category": { "anyOf": [ { "type": "string", "enum": [ "bug_fixing", "ci_cd_and_devops", "code_quality_and_security", "code_review", "code_review_and_analysis", "data_and_automation", "documentation_and_content", "feature_development", "migrations_and_upgrades", "other", "production_investigation", "refactoring_and_optimization", "research_and_exploration", "security", "unit_test_generation" ] }, { "type": "null" } ], "title": "Category", "description": "The session's assigned use-case category, if categorisation has run. Only populated on get/list endpoints." }, "subcategory": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Subcategory", "description": "The session's assigned subcategory display name. 'Other' when a category is set but no subcategory was assigned or resolved. Only populated on get/list endpoints." }, "origin": { "anyOf": [ { "type": "string", "enum": [ "webapp", "slack", "teams", "api", "linear", "jira", "automation", "cli", "desktop", "code_scan", "other" ] }, { "type": "null" } ], "title": "Origin", "description": "The origin from which the session was created." }, "automation_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Automation Id", "description": "ID of the automation that created this session, if any." }, "structured_output": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Structured Output", "description": "Validated structured output from the session. Only populated on get/list endpoints." }, "devin_mode": { "anyOf": [ { "type": "string", "enum": [ "normal", "fast", "fusion", "lite", "ultra", "swe-2-medium", "swe-2-high", "swe-2-max" ] }, { "type": "null" } ], "title": "Devin Mode", "description": "The Devin agent mode the session was created with, after resolving org/user defaults and parent-session inheritance. None when the session runs an agent preview that has no mode equivalent." }, "status_detail": { "anyOf": [ { "type": "string", "enum": [ "working", "waiting_for_user", "waiting_for_approval", "finished", "inactivity", "user_request", "usage_limit_exceeded", "out_of_credits", "out_of_quota", "no_quota_allocation", "payment_declined", "org_usage_limit_exceeded", "user_usage_limit_exceeded", "total_session_limit_exceeded", "contract_expired", "error" ] }, { "type": "null" } ], "title": "Status Detail", "description": "Additional detail about the session's current status. When status is 'running': 'working' (actively working), 'waiting_for_user' (needs user input), 'waiting_for_approval' (awaiting action approval in safe mode), or 'finished' (task complete). When status is 'suspended': the reason for suspension such as 'inactivity', 'user_request', 'usage_limit_exceeded', 'out_of_credits', 'out_of_quota', 'no_quota_allocation', 'payment_declined', 'org_usage_limit_exceeded', 'user_usage_limit_exceeded', 'total_session_limit_exceeded', 'contract_expired', or 'error'. Only populated on get/list endpoints." }, "on_demand_usage": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "On Demand Usage", "description": "On-demand (overage) spend in USD for this session, excluding child sessions. Only populated for Teams plans; 0 when the session was fully covered by quota. Omitted for other plans. Only populated on get/list endpoints." }, "security_profile": { "anyOf": [ { "$ref": "#/components/schemas/SessionSecurityProfileResponse" }, { "type": "null" } ], "description": "The session's own security-profile binding. Only populated on get/list endpoints." }, "num_user_messages": { "type": "integer", "title": "Num User Messages", "description": "Number of user messages sent during the session." }, "num_devin_messages": { "type": "integer", "title": "Num Devin Messages", "description": "Number of Devin messages sent during the session." }, "session_size": { "type": "string", "enum": [ "xs", "s", "m", "l", "xl" ], "title": "Session Size", "description": "Session size classification based on ACU usage and message count." }, "analysis": { "anyOf": [ { "$ref": "#/components/schemas/SessionInsightsAnalysis" }, { "type": "null" } ], "description": "AI-generated session analysis. None if analysis has not completed." }, "analysis_status": { "anyOf": [ { "type": "string", "enum": [ "started", "completed", "failed" ] }, { "type": "null" } ], "title": "Analysis Status", "description": "State of the most recent session analysis run: 'completed', 'started' (in progress) or 'failed'. None if analysis was never run. 'failed' distinguishes a run that errored from one that never happened; `analysis` may still hold an older completed result." } }, "type": "object", "required": [ "session_id", "url", "status", "tags", "org_id", "created_at", "updated_at", "acus_consumed", "pull_requests", "num_user_messages", "num_devin_messages", "session_size" ], "title": "SessionInsightsResponse", "description": "Session details augmented with quantitative metrics and AI analysis.\n\nExtends SessionResponse with additional fields that require extra queries." }, "SessionInsightsSkillUsage": { "properties": { "good_usages": { "items": { "$ref": "#/components/schemas/SessionInsightsSkillUsageItem" }, "type": "array", "title": "Good Usages", "default": [] }, "bad_usages": { "items": { "$ref": "#/components/schemas/SessionInsightsSkillUsageItem" }, "type": "array", "title": "Bad Usages", "default": [] } }, "type": "object", "title": "SessionInsightsSkillUsage" }, "SessionInsightsSkillUsageItem": { "properties": { "reason": { "type": "string", "title": "Reason" }, "skill_name": { "type": "string", "title": "Skill Name" }, "repo_origin": { "type": "string", "title": "Repo Origin" }, "skill_rel_path": { "type": "string", "title": "Skill Rel Path" } }, "type": "object", "required": [ "reason", "skill_name", "repo_origin", "skill_rel_path" ], "title": "SessionInsightsSkillUsageItem" }, "SessionInsightsSuggestedPrompt": { "properties": { "original_prompt": { "type": "string", "title": "Original Prompt" }, "suggested_prompt": { "type": "string", "title": "Suggested Prompt" }, "feedback_items": { "items": { "$ref": "#/components/schemas/SessionInsightsFeedbackItem" }, "type": "array", "title": "Feedback Items", "default": [] } }, "type": "object", "required": [ "original_prompt", "suggested_prompt" ], "title": "SessionInsightsSuggestedPrompt" }, "SessionInsightsTimelineEvent": { "properties": { "title": { "type": "string", "title": "Title" }, "color": { "type": "string", "title": "Color", "default": "" }, "description": { "type": "string", "title": "Description" }, "issue_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Issue Id" } }, "type": "object", "required": [ "title", "description" ], "title": "SessionInsightsTimelineEvent" }, "SessionMessage": { "properties": { "event_id": { "type": "string", "title": "Event Id" }, "source": { "type": "string", "enum": [ "devin", "user" ], "title": "Source" }, "message": { "type": "string", "title": "Message" }, "created_at": { "type": "integer", "title": "Created At" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Username", "description": "The username of the user who sent the message, if available." }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Id", "description": "The ID of the user who sent the message, if available." }, "origin": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Origin", "description": "The origin of the message, if available." } }, "type": "object", "required": [ "event_id", "source", "message", "created_at" ], "title": "SessionMessage", "description": "A message in a Devin session." }, "SessionMessageCreateRequest": { "properties": { "message": { "type": "string", "title": "Message" }, "message_as_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message As User Id" }, "attachment_urls": { "anyOf": [ { "items": { "type": "string", "maxLength": 2083, "minLength": 1, "format": "uri" }, "type": "array" }, { "type": "null" } ], "title": "Attachment Urls" } }, "type": "object", "required": [ "message" ], "title": "SessionMessageCreateRequest" }, "SessionMetricsResponse": { "properties": { "sessions_created_count": { "type": "integer", "title": "Sessions Created Count" }, "sessions_created_by_size": { "$ref": "#/components/schemas/SessionCountsBySize" }, "sessions_created_by_origin": { "$ref": "#/components/schemas/SessionCountsByOrigin" }, "sessions_created_with_playbook_count": { "type": "integer", "title": "Sessions Created With Playbook Count" }, "sessions_created_with_search_count": { "type": "integer", "title": "Sessions Created With Search Count" }, "sessions_with_merged_prs_count": { "type": "integer", "title": "Sessions With Merged Prs Count" }, "sessions_with_merged_prs_by_size": { "$ref": "#/components/schemas/SessionCountsBySize" }, "avg_acus_per_session": { "type": "number", "title": "Avg Acus Per Session" } }, "type": "object", "required": [ "sessions_created_count", "sessions_created_by_size", "sessions_created_by_origin", "sessions_created_with_playbook_count", "sessions_created_with_search_count", "sessions_with_merged_prs_count", "sessions_with_merged_prs_by_size", "avg_acus_per_session" ], "title": "SessionMetricsResponse", "description": "Response model for session metrics." }, "SessionPullRequest": { "properties": { "pr_url": { "type": "string", "title": "Pr Url" }, "pr_state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pr State" } }, "type": "object", "required": [ "pr_url", "pr_state" ], "title": "SessionPullRequest" }, "SessionResponse": { "properties": { "session_id": { "type": "string", "title": "Session Id" }, "url": { "type": "string", "title": "Url" }, "status": { "type": "string", "enum": [ "new", "claimed", "running", "exit", "error", "suspended", "resuming" ], "title": "Status" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "tags": { "items": { "type": "string" }, "type": "array", "title": "Tags" }, "playbook_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Playbook Id" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Id" }, "org_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Org Id", "description": "Owning organization. Null for detached sessions, which are owned by their creator's account rather than an organization." }, "created_at": { "type": "integer", "title": "Created At" }, "updated_at": { "type": "integer", "title": "Updated At" }, "is_archived": { "type": "boolean", "title": "Is Archived", "default": false }, "acus_consumed": { "type": "number", "title": "Acus Consumed" }, "pull_requests": { "items": { "$ref": "#/components/schemas/SessionPullRequest" }, "type": "array", "title": "Pull Requests" }, "parent_session_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Parent Session Id" }, "child_session_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Child Session Ids" }, "service_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Service User Id" }, "category": { "anyOf": [ { "type": "string", "enum": [ "bug_fixing", "ci_cd_and_devops", "code_quality_and_security", "code_review", "code_review_and_analysis", "data_and_automation", "documentation_and_content", "feature_development", "migrations_and_upgrades", "other", "production_investigation", "refactoring_and_optimization", "research_and_exploration", "security", "unit_test_generation" ] }, { "type": "null" } ], "title": "Category", "description": "The session's assigned use-case category, if categorisation has run. Only populated on get/list endpoints." }, "subcategory": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Subcategory", "description": "The session's assigned subcategory display name. 'Other' when a category is set but no subcategory was assigned or resolved. Only populated on get/list endpoints." }, "origin": { "anyOf": [ { "type": "string", "enum": [ "webapp", "slack", "teams", "api", "linear", "jira", "automation", "cli", "desktop", "code_scan", "other" ] }, { "type": "null" } ], "title": "Origin", "description": "The origin from which the session was created." }, "automation_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Automation Id", "description": "ID of the automation that created this session, if any." }, "structured_output": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Structured Output", "description": "Validated structured output from the session. Only populated on get/list endpoints." }, "devin_mode": { "anyOf": [ { "type": "string", "enum": [ "normal", "fast", "fusion", "lite", "ultra", "swe-2-medium", "swe-2-high", "swe-2-max" ] }, { "type": "null" } ], "title": "Devin Mode", "description": "The Devin agent mode the session was created with, after resolving org/user defaults and parent-session inheritance. None when the session runs an agent preview that has no mode equivalent." }, "status_detail": { "anyOf": [ { "type": "string", "enum": [ "working", "waiting_for_user", "waiting_for_approval", "finished", "inactivity", "user_request", "usage_limit_exceeded", "out_of_credits", "out_of_quota", "no_quota_allocation", "payment_declined", "org_usage_limit_exceeded", "user_usage_limit_exceeded", "total_session_limit_exceeded", "contract_expired", "error" ] }, { "type": "null" } ], "title": "Status Detail", "description": "Additional detail about the session's current status. When status is 'running': 'working' (actively working), 'waiting_for_user' (needs user input), 'waiting_for_approval' (awaiting action approval in safe mode), or 'finished' (task complete). When status is 'suspended': the reason for suspension such as 'inactivity', 'user_request', 'usage_limit_exceeded', 'out_of_credits', 'out_of_quota', 'no_quota_allocation', 'payment_declined', 'org_usage_limit_exceeded', 'user_usage_limit_exceeded', 'total_session_limit_exceeded', 'contract_expired', or 'error'. Only populated on get/list endpoints." }, "on_demand_usage": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "On Demand Usage", "description": "On-demand (overage) spend in USD for this session, excluding child sessions. Only populated for Teams plans; 0 when the session was fully covered by quota. Omitted for other plans. Only populated on get/list endpoints." }, "security_profile": { "anyOf": [ { "$ref": "#/components/schemas/SessionSecurityProfileResponse" }, { "type": "null" } ], "description": "The session's own security-profile binding. Only populated on get/list endpoints." } }, "type": "object", "required": [ "session_id", "url", "status", "tags", "org_id", "created_at", "updated_at", "acus_consumed", "pull_requests" ], "title": "SessionResponse" }, "SessionSecretInput": { "properties": { "key": { "type": "string", "maxLength": 256, "minLength": 1, "title": "Key" }, "value": { "type": "string", "maxLength": 65536, "title": "Value" }, "sensitive": { "type": "boolean", "title": "Sensitive", "default": true } }, "type": "object", "required": [ "key", "value" ], "title": "SessionSecretInput", "description": "Input model for a session secret provided via API." }, "SessionSecurityProfileResponse": { "properties": { "selection": { "type": "string", "enum": [ "inherit", "none", "profile" ], "title": "Selection", "description": "The session's own binding: inherit (no binding of its own), none (explicit opt-out), or profile (pins profile_id). The effective configuration resolves the full governing chain (enterprise -> org -> automation/playbook -> session); an opt-out cannot escape a mandatory org/enterprise profile." }, "profile_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Id" } }, "type": "object", "required": [ "selection" ], "title": "SessionSecurityProfileResponse" }, "SessionSecurityProfileSelection": { "properties": { "profile_id": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ], "title": "Profile Id", "description": "Security profile to attach to the session; must belong to your organization or, for enterprise organizations, its enterprise. null records an explicit opt-out (no profile, even when the org or enterprise has a default)." } }, "type": "object", "title": "SessionSecurityProfileSelection", "description": "An explicit security-profile selection for a new session." }, "SessionTagsResponse": { "properties": { "tags": { "items": { "type": "string" }, "type": "array", "title": "Tags" } }, "type": "object", "required": [ "tags" ], "title": "SessionTagsResponse" }, "SessionTagsUpdateRequest": { "properties": { "tags": { "items": { "type": "string" }, "type": "array", "maxItems": 50, "title": "Tags" } }, "type": "object", "required": [ "tags" ], "title": "SessionTagsUpdateRequest" }, "SessionsByCategoryResponse": { "properties": { "categories": { "items": { "$ref": "#/components/schemas/CategoryMetrics" }, "type": "array", "title": "Categories" } }, "type": "object", "required": [ "categories" ], "title": "SessionsByCategoryResponse" }, "SessionsQueryParams": { "properties": { "after": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "After" }, "first": { "type": "integer", "maximum": 200.0, "minimum": 1.0, "title": "First", "default": 100 }, "session_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Session Ids" }, "created_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Created After" }, "created_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Created Before" }, "updated_after": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Updated After" }, "updated_before": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Updated Before" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags" }, "playbook_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Playbook Id" }, "origins": { "anyOf": [ { "items": { "type": "string", "enum": [ "webapp", "slack", "teams", "api", "linear", "jira", "automation", "cli", "desktop", "code_scan", "other" ] }, "type": "array" }, { "type": "null" } ], "title": "Origins" }, "schedule_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Schedule Id" }, "user_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "User Ids" }, "service_user_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Service User Ids" }, "repo_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Repo Names", "description": "Filter by repository names (e.g., 'owner/repo')" }, "category": { "anyOf": [ { "type": "string", "enum": [ "bug_fixing", "ci_cd_and_devops", "code_quality_and_security", "code_review", "code_review_and_analysis", "data_and_automation", "documentation_and_content", "feature_development", "migrations_and_upgrades", "other", "production_investigation", "refactoring_and_optimization", "research_and_exploration", "security", "unit_test_generation" ] }, { "type": "null" } ], "title": "Category" }, "is_archived": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Archived" }, "automation_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Automation Ids", "description": "Filter to sessions created by any of these automations" }, "parent_session_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Parent Session Id", "description": "Filter to child sessions spawned by this parent session" } }, "type": "object", "title": "SessionsQueryParams" }, "SkillReference": { "properties": { "plugin_identity": { "type": "string", "maxLength": 256, "minLength": 1, "title": "Plugin Identity", "description": "The plugin that ships the skill: the id of a bundle uploaded by the organization, e.g. 'org-playbooks', or the URL of a git plugin, e.g. 'https://github.com/acme/tools'." }, "skill_name": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Skill Name", "description": "Name of the skill inside that plugin." } }, "type": "object", "required": [ "plugin_identity", "skill_name" ], "title": "SkillReference", "description": "One exact skill: the plugin that ships it plus the skill's name." }, "StartIngestionScanRequest": { "properties": { "repo_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Repo Name", "description": "Full name of the repository to scan. Provide exactly one of repo_name or repos." }, "host": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Host", "description": "Git host of the repository, if known." }, "repos": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ScanRepoRequest" }, "type": "array", "maxItems": 500 }, { "type": "null" } ], "title": "Repos", "description": "Repositories covered by one scan; the first entry is the scan's primary repository. Provide exactly one of repo_name or repos." }, "profile_id": { "type": "string", "title": "Profile Id", "description": "Ingestion-mode scan profile to run. Must be an ingest profile; non-ingest profiles are rejected with 400." }, "effort": { "anyOf": [ { "type": "string", "enum": [ "normal", "deep" ] }, { "type": "null" } ], "title": "Effort", "description": "Scan effort: 'normal' (default) uses lower model reasoning effort with larger triage and validation batches; 'deep' runs the full pipeline." }, "attachment_urls": { "anyOf": [ { "items": { "type": "string", "maxLength": 2083, "minLength": 1, "format": "uri" }, "type": "array", "maxItems": 10 }, { "type": "null" } ], "title": "Attachment Urls", "description": "Devin attachment URLs to provide to the scan, e.g. files uploaded via the attachments API. The attachments must belong to the organization being scanned." }, "platform": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "title": "Platform", "description": "Where the scan's sessions run: a platform label configured for the organization (e.g. 'linux', 'windows', 'macos') or the name of an outpost (BYOB) pool, case-insensitive; platforms take priority when a name matches both. Omitted means the organization default. Unrecognized values are rejected with a 400 whose error body lists the available platform labels and outpost pool names." } }, "type": "object", "required": [ "profile_id" ], "title": "StartIngestionScanRequest", "description": "Request body for starting an ingestion-mode code scan.\n\nOnly accepts an ingestion (ingest-mode) scan profile: the profile is run\nagainst the given repository (or repositories)." }, "SubcategoryMetrics": { "properties": { "subcategory_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Subcategory Id" }, "display_name": { "type": "string", "title": "Display Name" }, "sessions_count": { "type": "integer", "title": "Sessions Count" }, "acus": { "type": "number", "title": "Acus" } }, "type": "object", "required": [ "subcategory_id", "display_name", "sessions_count", "acus" ], "title": "SubcategoryMetrics" }, "TagsCreateRequest": { "properties": { "tags": { "items": { "type": "string" }, "type": "array", "title": "Tags" } }, "type": "object", "required": [ "tags" ], "title": "TagsCreateRequest" }, "TagsResponse": { "properties": { "tags": { "items": { "type": "string" }, "type": "array", "title": "Tags" } }, "type": "object", "required": [ "tags" ], "title": "TagsResponse" }, "TriggerBuildBody": { "properties": {}, "type": "object", "title": "TriggerBuildBody", "description": "``POST /builds`` body. Empty per spec; reserved for future fields." }, "UnlinkFindingsSessionRequest": { "properties": { "finding_ids": { "items": { "type": "string" }, "type": "array", "maxItems": 1000, "minItems": 1, "title": "Finding Ids", "description": "Findings to unlink; all must belong to the scan." } }, "type": "object", "required": [ "finding_ids" ], "title": "UnlinkFindingsSessionRequest" }, "UpdateACULimitRequest": { "properties": { "cycle_acu_limit": { "type": "integer", "minimum": 0.0, "title": "Cycle Acu Limit" } }, "type": "object", "required": [ "cycle_acu_limit" ], "title": "UpdateACULimitRequest" }, "UpdateBlueprintContentsBody": { "properties": { "contents": { "type": "string", "title": "Contents", "description": "New YAML body for the blueprint." } }, "type": "object", "required": [ "contents" ], "title": "UpdateBlueprintContentsBody" }, "UpdateOrgBlueprintBody": { "properties": { "contents": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Contents", "description": "If set, replaces the blueprint's YAML body with a new version." }, "position": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Position", "description": "If set, updates the execution position of this repo-tier blueprint. Positions are not required to be unique; ties are broken arbitrarily by the server when sorting for execution." }, "source": { "anyOf": [ { "type": "string", "enum": [ "git", "database" ] }, { "type": "null" } ], "title": "Source", "description": "If set, switches the repo's blueprint source. Only accepted on the repo's root blueprint (scoped blueprints inherit it). 'git' pulls .devin/blueprint.yaml from the default branch (404 if absent) and cannot be combined with 'contents'; 'database' keeps the current YAML (or 'contents', if given) and stops syncing from the repo. No-op when the blueprint is already in that mode." }, "build_on_default_branch_commit": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Build On Default Branch Commit", "description": "If set, turns building the environment on each push to the default branch on or off. Only accepted on the root blueprint of a github.com repo. Every such push queues a build." }, "report_check_runs": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Report Check Runs", "description": "If set, turns reporting each commit build as a GitHub check run on or off. Enabling it requires 'build_on_default_branch_commit' to be on." } }, "type": "object", "title": "UpdateOrgBlueprintBody", "description": "Partial update for an org- or repo-tier blueprint.\n\nAny subset of fields may be provided. Fields not set are left alone.\nProviding ``position``, ``source`` or a commit-build setting on an\norg-tier blueprint returns ``400`` \u2014 only repo-tier blueprints have them.\nDoes NOT trigger a build." }, "UsageMetrics": { "properties": { "sessions_count": { "type": "integer", "title": "Sessions Count" }, "searches_count": { "type": "integer", "title": "Searches Count" }, "prs_created_count": { "type": "integer", "title": "Prs Created Count" }, "prs_merged_count": { "type": "integer", "title": "Prs Merged Count" } }, "type": "object", "required": [ "sessions_count", "searches_count", "prs_created_count", "prs_merged_count" ], "title": "UsageMetrics" }, "User": { "properties": { "user_id": { "type": "string", "title": "User Id" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "role_assignments": { "items": { "$ref": "#/components/schemas/RoleAssignment" }, "type": "array", "title": "Role Assignments" } }, "type": "object", "required": [ "user_id", "email", "name", "role_assignments" ], "title": "User" }, "UserBulkCreateRequest": { "properties": { "emails": { "items": { "type": "string" }, "type": "array", "maxItems": 100, "title": "Emails" }, "enterprise_role_id": { "type": "string", "title": "Enterprise Role Id" } }, "type": "object", "required": [ "emails", "enterprise_role_id" ], "title": "UserBulkCreateRequest" }, "UserUpdateRoleRequest": { "properties": { "role_id": { "type": "string", "title": "Role Id" } }, "type": "object", "required": [ "role_id" ], "title": "UserUpdateRoleRequest" }, "UserWithIdpRoles": { "properties": { "user_id": { "type": "string", "title": "User Id" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "role_assignments": { "items": { "$ref": "#/components/schemas/RoleAssignment" }, "type": "array", "title": "Role Assignments" }, "idp_role_assignments": { "items": { "$ref": "#/components/schemas/IdpRoleAssignment" }, "type": "array", "title": "Idp Role Assignments" } }, "type": "object", "required": [ "user_id", "email", "name", "role_assignments" ], "title": "UserWithIdpRoles", "description": "User with both direct and IDP-group-derived role assignments." }, "V3RemediateFindingRequest": { "properties": { "branch": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Branch", "description": "Base branch for remediation pull requests; defaults to the repository default branch." } }, "type": "object", "title": "V3RemediateFindingRequest" }, "WindsurfSessionUserSelf": { "properties": { "principal_type": { "type": "string", "const": "windsurf_session", "title": "Principal Type" }, "user_id": { "type": "string", "title": "User Id" }, "user_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Name" }, "org_id": { "type": "string", "title": "Org Id" }, "devin_sessions_org_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Devin Sessions Org Id", "description": "Organization the caller's Devin Cloud sessions run in: the one named with x-cog-org-id, or without it the first organization visible to the user. Either way only an organization in which the user may use Devin sessions, and never an enterprise's primary organization. Null when there is none." }, "primary_billing_org_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Primary Billing Org Id", "description": "Organization the user's CLI and Desktop usage is billed to: the account's organization, or in an enterprise the user's primary billing organization. Null when there is none or the user may not use Devin sessions in it." } }, "type": "object", "required": [ "principal_type", "user_id", "org_id" ], "title": "WindsurfSessionUserSelf", "description": "Identity information for an authenticated Windsurf session user." } }, "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "description": "Service User credential (prefix: cog_)" } } }, "security": [ { "bearerAuth": [] } ] }