{ "openapi": "3.0.3", "info": { "title": "Tolmo API", "version": "1.0.0", "description": "The Tolmo REST API. Use an organization API key for automation or a CLI user token for user-authenticated operations. Most endpoints are scoped to one organization." }, "servers": [ { "url": "https://api.tolmo.com", "description": "Production" } ], "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "description": "A Tolmo API token, sent as `Authorization: Bearer `. Either a user token (`usr_tok.*`, minted by `tolmo auth login`, scoped to your own permissions) or an org API token created in the Tolmo app, for CI and automation." }, "clerkSession": { "type": "apiKey", "in": "cookie", "name": "__session", "description": "A Clerk session, sent as the `__session` cookie by the web app. The `/internal/*` plane accepts ONLY this — it refuses Tolmo API tokens — and is not part of the public surface." }, "svcToken": { "type": "http", "scheme": "bearer", "description": "The trusted-sibling-service secret (`SVC_EVENTS_TOKEN`), shared by every `/svc/*` route. Not a customer credential: it identifies our own services, not an org." } }, "schemas": { "HttpError": { "type": "object", "properties": { "statusCode": { "type": "number" }, "code": { "type": "string" }, "error": { "type": "string" }, "message": { "type": "string" } }, "title": "HttpError" } } }, "paths": { "/api/v1/orgs/{orgSlug}/sql": { "post": { "summary": "Run a SQL query", "tags": [ "sql" ], "description": "Execute a read-only SQL query with RLS org isolation", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "type": "string", "minLength": 1 }, "asOf": { "type": "string", "minLength": 1 } }, "required": [ "query" ] } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "orgSlug", "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "dataTypeID": { "type": "number" } }, "required": [ "name", "dataTypeID" ], "additionalProperties": false } }, "metadata": { "type": "object", "properties": { "executionTimeMs": { "type": "number" }, "rowCount": { "type": "number" }, "truncated": { "type": "boolean" } }, "required": [ "executionTimeMs", "rowCount", "truncated" ], "additionalProperties": false } }, "required": [ "rows", "fields", "metadata" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "number" }, "error": { "type": "string" }, "message": { "type": "string" } }, "required": [ "statusCode", "error", "message" ], "additionalProperties": false } } } } } } }, "/api/v1/orgs/{orgSlug}/cypher": { "post": { "summary": "Run a Cypher query", "tags": [ "cypher" ], "description": "Execute an openCypher query (org-scoped, read-only, temporary). Automated and agent callers must send `intent`: one short sentence naming the specific question this query should answer and how the result will guide the next step. It never changes the query or its results; when set, it is attached to the request trace in APM and to the security audit log of rejected queries, so automated traffic has an attributable purpose.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "type": "string", "minLength": 1, "maxLength": 10000 }, "parameters": { "type": "object", "additionalProperties": {} }, "intent": { "description": "Automated and agent callers MUST set this on every query: in one short sentence, name the specific question this query should answer and how the result will guide your next step. For initial discovery, say what you need to learn, e.g. \"Identify which resource types are present so I can choose the right checks for this environment\". For a follow-up, e.g. \"Find roles attached to exposed EC2 instances so I can inspect their permissions\". Avoid generic phrases like \"explore the graph\", repeating the overall task, or assuming a finding before seeing results. Recorded for observability; does not affect query results. Omit only for a one-off interactive query typed by a human.", "type": "string", "maxLength": 1000 } }, "required": [ "query" ] } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "orgSlug", "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "metadata": { "type": "object", "properties": { "executionTimeMs": { "type": "number" }, "rowCount": { "type": "number" } }, "required": [ "executionTimeMs", "rowCount" ], "additionalProperties": false } }, "required": [ "rows", "metadata" ], "additionalProperties": false } } } }, "412": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpError" } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpError" } } } } } } }, "/api/v1/orgs/{orgSlug}/code/clone": { "get": { "operationId": "cloneCodeRepository", "summary": "Clone a repository", "tags": [ "code" ], "description": "Download a bare git repo archive from storage or a live GitHub PR ref", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "query", "name": "repo", "required": true }, { "schema": { "type": "string", "enum": [ "github", "gitlab" ] }, "in": "query", "name": "provider", "required": false }, { "schema": { "type": "string", "minLength": 1 }, "in": "query", "name": "ref", "required": false }, { "schema": { "type": "integer", "minimum": 0, "exclusiveMinimum": true, "maximum": 9007199254740991 }, "in": "query", "name": "githubPullRequestNumber", "required": false }, { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "query", "name": "cloudAccountId", "required": false }, { "schema": { "type": "string" }, "in": "path", "name": "orgSlug", "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "400": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpError" } } } } } } }, "/api/v1/orgs/{orgSlug}/code/clone/{owner}/{repo}": { "get": { "summary": "Download a repository archive", "tags": [ "code" ], "description": "Download a bare git repo as a tar archive from S3", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "orgSlug", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "owner", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "repo", "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "400": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpError" } } } } } } }, "/api/v1/orgs/{orgSlug}/code/repositories": { "get": { "operationId": "listCodeRepositories", "summary": "List code repositories", "tags": [ "code" ], "description": "List code repositories with clone availability", "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string" }, "in": "path", "name": "orgSlug", "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "repositories": { "type": "array", "items": { "type": "object", "properties": { "provider": { "type": "string", "enum": [ "github", "gitlab" ] }, "fullName": { "type": "string" }, "name": { "type": "string" }, "ownerLogin": { "type": "string" }, "language": { "nullable": true, "type": "string" }, "visibility": { "nullable": true, "type": "string" }, "isCloneable": { "type": "boolean" }, "notCloneableReason": { "nullable": true, "type": "string" }, "defaultBranch": { "nullable": true, "type": "string" } }, "required": [ "provider", "fullName", "name", "ownerLogin", "language", "visibility", "isCloneable", "notCloneableReason", "defaultBranch" ], "additionalProperties": false } } }, "required": [ "repositories" ], "additionalProperties": false } } } } } } }, "/api/v1/orgs/{orgSlug}/screenshots": { "get": { "operationId": "listUrlScreenshots", "summary": "List screenshots", "tags": [ "screenshots" ], "description": "List URL screenshots captured for the org by the daily Cloudflare browser-rendering pipeline.", "parameters": [ { "schema": { "type": "string", "format": "uri" }, "in": "query", "name": "url", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "resourceKey", "required": false }, { "schema": { "type": "string", "enum": [ "website", "saas_deploy", "cloud_endpoint" ] }, "in": "query", "name": "source", "required": false }, { "schema": { "type": "string", "format": "date-time" }, "in": "query", "name": "from", "required": false }, { "schema": { "type": "string", "format": "date-time" }, "in": "query", "name": "to", "required": false }, { "schema": { "default": 100, "type": "integer", "minimum": 0, "exclusiveMinimum": true, "maximum": 500 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "boolean" }, "in": "query", "name": "successful", "required": false }, { "schema": { "type": "string" }, "in": "path", "name": "orgSlug", "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "screenshots": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "source": { "type": "string", "enum": [ "website", "saas_deploy", "cloud_endpoint" ] }, "capturedAt": { "type": "string" }, "cloudflareStatus": { "nullable": true, "type": "number" }, "bytes": { "nullable": true, "type": "number" }, "error": { "nullable": true, "type": "string" } }, "required": [ "id", "url", "source", "capturedAt", "cloudflareStatus", "bytes", "error" ], "additionalProperties": false } } }, "required": [ "screenshots" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpError" } } } } } } }, "/api/v1/orgs/{orgSlug}/screenshots/{id}": { "get": { "operationId": "getUrlScreenshot", "summary": "Get a screenshot", "tags": [ "screenshots" ], "description": "Stream a single screenshot PNG. Bucket is private; this endpoint proxies the GetObject through the backend so org isolation can be enforced.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "orgSlug", "required": true }, { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "id", "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "400": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpError" } } } } } } }, "/api/v1/orgs/{orgSlug}/connected-services": { "get": { "operationId": "listConnectedServices", "summary": "List connected services", "tags": [ "connected-services" ], "description": "List connected integrations available for querying via the proxy", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "orgSlug", "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "services": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "provider": { "type": "string" }, "alias": { "type": "string" }, "apiStyle": { "type": "string", "enum": [ "rest", "graphql", "sdk" ] }, "config": { "type": "object", "additionalProperties": {} } }, "required": [ "id", "provider", "alias", "apiStyle" ], "additionalProperties": false } } }, "required": [ "services" ], "additionalProperties": false } } } } } } }, "/api/v1/orgs/{orgSlug}/connected-services/provider/{provider}/proxy": { "post": { "operationId": "proxyConnectedService", "summary": "Proxy a request to a provider", "tags": [ "connected-services" ], "description": "Proxy a read-only request to an external API through a connected integration", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "method": { "type": "string", "enum": [ "GET" ] }, "path": { "type": "string" }, "query": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } }, "graphql": { "type": "object", "properties": { "query": { "type": "string" }, "variables": { "type": "object", "additionalProperties": {} } }, "required": [ "query" ] } } } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "integrationId", "required": false }, { "schema": { "type": "string" }, "in": "path", "name": "orgSlug", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "provider", "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "number" }, "body": {}, "metadata": { "type": "object", "properties": { "provider": { "type": "string" }, "integrationId": { "type": "string" }, "executionTimeMs": { "type": "number" }, "truncated": { "type": "boolean" } }, "required": [ "provider", "integrationId", "executionTimeMs" ], "additionalProperties": false } }, "required": [ "status", "body", "metadata" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpError" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpError" } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpError" } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpError" } } } } } } }, "/api/v1/orgs/{orgSlug}/connected-services/provider/aws/execute": { "post": { "operationId": "awsExecute", "summary": "Run an AWS CLI command", "tags": [ "connected-services" ], "description": "Execute an AWS CLI command server-side using the org's connected AWS integration", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "args": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "integrationId": { "type": "string" } }, "required": [ "args", "integrationId" ] } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "orgSlug", "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": {}, "rendered": { "type": "string" }, "metadata": { "type": "object", "properties": { "integrationId": { "type": "string" }, "executionTimeMs": { "type": "number" }, "truncated": { "type": "boolean" } }, "required": [ "integrationId", "executionTimeMs" ], "additionalProperties": false } }, "required": [ "result", "rendered", "metadata" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpError" } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpError" } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpError" } } } } } } }, "/api/v1/orgs/{orgSlug}/connected-services/provider/aws/raw-proxy/{*}": { "get": { "operationId": "awsRawProxy", "summary": "Proxy a raw AWS request", "tags": [ "connected-services" ], "description": "Re-sign and forward raw AWS HTTP requests from the CLI local proxy", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "orgSlug", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "*", "required": true }, { "schema": { "type": "string" }, "in": "header", "name": "x-aws-host", "required": false }, { "schema": { "type": "string" }, "in": "header", "name": "x-aws-service", "required": false }, { "schema": { "type": "string" }, "in": "header", "name": "x-aws-region", "required": false }, { "schema": { "type": "string" }, "in": "header", "name": "x-repo1-integration-id", "required": false } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response" } }, "x-mint": { "href": "/api-reference/connected-services/proxy-a-raw-aws-request-get", "metadata": { "sidebarTitle": "GET raw AWS" } } }, "post": { "operationId": "awsRawProxy", "summary": "Proxy a raw AWS request", "tags": [ "connected-services" ], "description": "Re-sign and forward raw AWS HTTP requests from the CLI local proxy", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "orgSlug", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "*", "required": true }, { "schema": { "type": "string" }, "in": "header", "name": "x-aws-host", "required": false }, { "schema": { "type": "string" }, "in": "header", "name": "x-aws-service", "required": false }, { "schema": { "type": "string" }, "in": "header", "name": "x-aws-region", "required": false }, { "schema": { "type": "string" }, "in": "header", "name": "x-repo1-integration-id", "required": false } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response" } }, "x-mint": { "href": "/api-reference/connected-services/proxy-a-raw-aws-request-post", "metadata": { "sidebarTitle": "POST raw AWS" } } }, "put": { "operationId": "awsRawProxy", "summary": "Proxy a raw AWS request", "tags": [ "connected-services" ], "description": "Re-sign and forward raw AWS HTTP requests from the CLI local proxy", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "orgSlug", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "*", "required": true }, { "schema": { "type": "string" }, "in": "header", "name": "x-aws-host", "required": false }, { "schema": { "type": "string" }, "in": "header", "name": "x-aws-service", "required": false }, { "schema": { "type": "string" }, "in": "header", "name": "x-aws-region", "required": false }, { "schema": { "type": "string" }, "in": "header", "name": "x-repo1-integration-id", "required": false } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response" } }, "x-mint": { "href": "/api-reference/connected-services/proxy-a-raw-aws-request-put", "metadata": { "sidebarTitle": "PUT raw AWS" } } }, "delete": { "operationId": "awsRawProxy", "summary": "Proxy a raw AWS request", "tags": [ "connected-services" ], "description": "Re-sign and forward raw AWS HTTP requests from the CLI local proxy", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "orgSlug", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "*", "required": true }, { "schema": { "type": "string" }, "in": "header", "name": "x-aws-host", "required": false }, { "schema": { "type": "string" }, "in": "header", "name": "x-aws-service", "required": false }, { "schema": { "type": "string" }, "in": "header", "name": "x-aws-region", "required": false }, { "schema": { "type": "string" }, "in": "header", "name": "x-repo1-integration-id", "required": false } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response" } }, "x-mint": { "href": "/api-reference/connected-services/proxy-a-raw-aws-request-delete", "metadata": { "sidebarTitle": "DELETE raw AWS" } } }, "patch": { "operationId": "awsRawProxy", "summary": "Proxy a raw AWS request", "tags": [ "connected-services" ], "description": "Re-sign and forward raw AWS HTTP requests from the CLI local proxy", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "orgSlug", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "*", "required": true }, { "schema": { "type": "string" }, "in": "header", "name": "x-aws-host", "required": false }, { "schema": { "type": "string" }, "in": "header", "name": "x-aws-service", "required": false }, { "schema": { "type": "string" }, "in": "header", "name": "x-aws-region", "required": false }, { "schema": { "type": "string" }, "in": "header", "name": "x-repo1-integration-id", "required": false } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response" } }, "x-mint": { "href": "/api-reference/connected-services/proxy-a-raw-aws-request-patch", "metadata": { "sidebarTitle": "PATCH raw AWS" } } } }, "/api/v1/orgs/{orgSlug}/datadog/monitors": { "get": { "operationId": "listDatadogMonitors", "summary": "List Datadog monitors", "tags": [ "datadog-monitors" ], "description": "List the Datadog monitors Tolmo manages for this organization. Requests are proxied to Datadog with platform-held credentials, so no Datadog API key is needed.", "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "integrationId", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "name", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "monitorTags", "required": false }, { "schema": { "type": "integer", "minimum": 0, "exclusiveMinimum": true, "maximum": 1000 }, "in": "query", "name": "pageSize", "required": false }, { "schema": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "in": "query", "name": "page", "required": false }, { "schema": { "type": "string" }, "in": "path", "name": "orgSlug", "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "number" }, "body": {}, "truncated": { "type": "boolean" }, "metadata": { "type": "object", "properties": { "integrationId": { "type": "string" }, "durationMs": { "type": "number" } }, "required": [ "integrationId", "durationMs" ], "additionalProperties": false } }, "required": [ "status", "body", "metadata" ], "additionalProperties": false } } } } } }, "post": { "operationId": "createDatadogMonitor", "summary": "Create a Datadog monitor", "tags": [ "datadog-monitors" ], "description": "Create a Datadog monitor through Tolmo's managed Datadog integration.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "query": { "type": "string" }, "message": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "priority": { "nullable": true, "type": "integer", "minimum": 1, "maximum": 5 }, "options": { "type": "object", "additionalProperties": {} } }, "required": [ "name", "type", "query" ], "additionalProperties": {} } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "integrationId", "required": false }, { "schema": { "type": "string" }, "in": "path", "name": "orgSlug", "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "number" }, "body": {}, "truncated": { "type": "boolean" }, "metadata": { "type": "object", "properties": { "integrationId": { "type": "string" }, "durationMs": { "type": "number" } }, "required": [ "integrationId", "durationMs" ], "additionalProperties": false } }, "required": [ "status", "body", "metadata" ], "additionalProperties": false } } } } } } }, "/api/v1/orgs/{orgSlug}/datadog/monitors/{monitorId}": { "get": { "operationId": "getDatadogMonitor", "summary": "Get a Datadog monitor", "tags": [ "datadog-monitors" ], "description": "Fetch one Tolmo-managed Datadog monitor by its Datadog monitor id.", "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "integrationId", "required": false }, { "schema": { "type": "string" }, "in": "path", "name": "orgSlug", "required": true }, { "schema": { "type": "integer", "minimum": 0, "exclusiveMinimum": true, "maximum": 9007199254740991 }, "in": "path", "name": "monitorId", "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "number" }, "body": {}, "truncated": { "type": "boolean" }, "metadata": { "type": "object", "properties": { "integrationId": { "type": "string" }, "durationMs": { "type": "number" } }, "required": [ "integrationId", "durationMs" ], "additionalProperties": false } }, "required": [ "status", "body", "metadata" ], "additionalProperties": false } } } } } }, "patch": { "operationId": "updateDatadogMonitor", "summary": "Update a Datadog monitor", "tags": [ "datadog-monitors" ], "description": "Update the definition of an existing Tolmo-managed Datadog monitor.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "query": { "type": "string" }, "message": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "priority": { "nullable": true, "type": "integer", "minimum": 1, "maximum": 5 }, "options": { "type": "object", "additionalProperties": {} } }, "additionalProperties": {} } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "integrationId", "required": false }, { "schema": { "type": "string" }, "in": "path", "name": "orgSlug", "required": true }, { "schema": { "type": "integer", "minimum": 0, "exclusiveMinimum": true, "maximum": 9007199254740991 }, "in": "path", "name": "monitorId", "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "number" }, "body": {}, "truncated": { "type": "boolean" }, "metadata": { "type": "object", "properties": { "integrationId": { "type": "string" }, "durationMs": { "type": "number" } }, "required": [ "integrationId", "durationMs" ], "additionalProperties": false } }, "required": [ "status", "body", "metadata" ], "additionalProperties": false } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "number", "enum": [ 403 ] }, "error": { "type": "string" }, "code": { "type": "string", "enum": [ "NOT_MANAGED_BY_TOLMO" ] }, "monitorId": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "message": { "type": "string" } }, "required": [ "statusCode", "error", "code", "monitorId", "message" ], "additionalProperties": false } } } } } }, "delete": { "operationId": "deleteDatadogMonitor", "summary": "Delete a Datadog monitor", "tags": [ "datadog-monitors" ], "description": "Delete a Tolmo-managed Datadog monitor. This removes the monitor in Datadog itself.", "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "integrationId", "required": false }, { "schema": { "type": "string" }, "in": "path", "name": "orgSlug", "required": true }, { "schema": { "type": "integer", "minimum": 0, "exclusiveMinimum": true, "maximum": 9007199254740991 }, "in": "path", "name": "monitorId", "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "number" }, "body": {}, "truncated": { "type": "boolean" }, "metadata": { "type": "object", "properties": { "integrationId": { "type": "string" }, "durationMs": { "type": "number" } }, "required": [ "integrationId", "durationMs" ], "additionalProperties": false } }, "required": [ "status", "body", "metadata" ], "additionalProperties": false } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "number", "enum": [ 403 ] }, "error": { "type": "string" }, "code": { "type": "string", "enum": [ "NOT_MANAGED_BY_TOLMO" ] }, "monitorId": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "message": { "type": "string" } }, "required": [ "statusCode", "error", "code", "monitorId", "message" ], "additionalProperties": false } } } } } } }, "/api/v1/orgs/{orgSlug}/threat-models": { "get": { "operationId": "listThreatModels", "summary": "List threat model versions", "tags": [ "threat-models" ], "description": "List the organization's generated threat models, newest first. Each entry is a summary; fetch a version to get the full document.", "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "in": "query", "name": "offset", "required": false }, { "schema": { "type": "string" }, "in": "path", "name": "orgSlug", "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "orgId": { "type": "string" }, "version": { "type": "number" }, "workflowRunId": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" } }, "required": [ "id", "orgId", "version", "workflowRunId", "createdAt" ], "additionalProperties": false } } } } } } } }, "/api/v1/orgs/{orgSlug}/threat-models/latest": { "get": { "operationId": "getLatestThreatModel", "summary": "Get the latest threat model", "tags": [ "threat-models" ], "description": "Fetch the most recent threat model generated for the organization, in full.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "orgSlug", "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "orgId": { "type": "string" }, "version": { "type": "number" }, "content": { "type": "string" }, "workflowRunId": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" } }, "required": [ "id", "orgId", "version", "content", "workflowRunId", "createdAt" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpError" } } } } } } }, "/api/v1/orgs/{orgSlug}/threat-models/{version}": { "get": { "operationId": "getThreatModelByVersion", "summary": "Get a threat model version", "tags": [ "threat-models" ], "description": "Fetch one specific version of the organization's threat model, in full — the stable way to pin a report to a known revision.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "orgSlug", "required": true }, { "schema": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "in": "path", "name": "version", "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "orgId": { "type": "string" }, "version": { "type": "number" }, "content": { "type": "string" }, "workflowRunId": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" } }, "required": [ "id", "orgId", "version", "content", "workflowRunId", "createdAt" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpError" } } } } } } }, "/api/v1/orgs/{orgSlug}/findings": { "post": { "operationId": "createFinding", "summary": "Create a finding", "tags": [ "findings" ], "description": "Create a finding. Regular human tokens and purposeless customer automation tokens may create drafts but cannot publish; platform-minted agent-run tokens, verified super-admins, and scoped pentesters may publish. Accepts optional `sourceAgentName` provenance for agent-authored drafts.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 120, "description": "A single-line finding title of at most 120 characters, trimmed before storage and rejected rather than truncated when too long." }, "severity": { "type": "string", "enum": [ "critical", "high", "medium", "low", "info" ] }, "description": { "type": "string" }, "resourceName": { "nullable": true, "type": "string", "maxLength": 512 }, "resourceKey": { "nullable": true, "type": "string", "maxLength": 2048 }, "resourceType": { "nullable": true, "type": "string", "maxLength": 128 }, "resourceArn": { "nullable": true, "type": "string", "maxLength": 2048 }, "targetUrl": { "nullable": true, "type": "string", "maxLength": 2048 }, "category": { "nullable": true, "type": "string", "maxLength": 48 }, "tags": { "default": [], "maxItems": 24, "type": "array", "items": { "type": "string", "maxLength": 48 } }, "cwe": { "nullable": true, "type": "string", "maxLength": 16 }, "sourceAgentName": { "nullable": true, "type": "string", "maxLength": 128 }, "sourceName": { "default": "Tolmo", "type": "string", "maxLength": 256 }, "workflowRunId": { "nullable": true, "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "modusOperandi": { "nullable": true, "type": "string" }, "visibility": { "default": "published", "type": "string", "enum": [ "draft", "published" ] }, "status": { "default": "open", "type": "string", "enum": [ "open", "in_review", "closed", "acknowledged", "false_positive", "canceled" ] } }, "required": [ "title", "severity", "description" ] } } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "orgSlug", "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "orgId": { "type": "string" }, "agentId": { "nullable": true, "type": "string" }, "sourceAgentName": { "nullable": true, "type": "string" }, "isManual": { "type": "boolean" }, "shownVerbatim": { "type": "boolean" }, "severity": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "resourceType": { "nullable": true, "type": "string" }, "resourceName": { "nullable": true, "type": "string" }, "resourceArn": { "nullable": true, "type": "string" }, "resourceKey": { "nullable": true, "type": "string" }, "targetUrl": { "nullable": true, "type": "string" }, "category": { "nullable": true, "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "cwe": { "nullable": true, "type": "string" }, "owasp": { "nullable": true, "type": "string" }, "status": { "type": "string" }, "visibility": { "type": "string" }, "taskIds": {}, "tickets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "provider": { "type": "string" }, "integrationId": { "nullable": true, "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "accountAlias": { "nullable": true, "type": "string" }, "externalId": { "type": "string" }, "identifier": { "type": "string" }, "url": { "type": "string" }, "createdAt": { "type": "string" }, "syncStatus": { "nullable": true, "type": "string", "enum": [ "syncing", "synced", "needs_attention" ] }, "syncError": { "nullable": true, "type": "string" }, "syncedAt": { "nullable": true, "type": "string" } }, "required": [ "id", "provider", "integrationId", "accountAlias", "externalId", "identifier", "url", "createdAt", "syncStatus", "syncError", "syncedAt" ], "additionalProperties": false } }, "acknowledgedAt": { "nullable": true, "type": "string" }, "acknowledgedBy": { "nullable": true, "type": "string" }, "falsePositiveReason": { "nullable": true, "type": "string" }, "closedReason": { "nullable": true, "type": "string" }, "inReviewReason": { "nullable": true, "type": "string" }, "inReviewUrl": { "nullable": true, "type": "string" }, "sourceName": { "type": "string" }, "origin": { "type": "string" }, "ingestionStatus": { "nullable": true, "type": "string" }, "ingestedAt": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "attachmentCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "sourceSecret": { "nullable": true, "type": "object", "properties": { "secretFindingId": { "type": "string" }, "ruleId": { "type": "string" }, "verificationState": { "type": "string" }, "isActive": { "nullable": true, "type": "boolean" }, "activeLastSeenAt": { "nullable": true, "type": "string" }, "lastValidatedAt": { "nullable": true, "type": "string" }, "validationMethod": { "nullable": true, "type": "string" } }, "required": [ "secretFindingId", "ruleId", "verificationState", "isActive", "activeLastSeenAt", "lastValidatedAt", "validationMethod" ], "additionalProperties": false }, "exploits": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "steps": { "type": "array", "items": { "type": "string" } }, "resultsAtExploitTime": { "type": "string" }, "retestProbe": { "type": "string" }, "oracle": { "type": "string" }, "drivenBy": { "type": "string" }, "createdAt": { "type": "string" }, "exploitedAt": { "type": "string" }, "lineageId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "id", "steps", "resultsAtExploitTime", "retestProbe", "oracle", "drivenBy", "createdAt", "exploitedAt", "lineageId" ], "additionalProperties": false } } }, "required": [ "id", "orgId", "agentId", "sourceAgentName", "isManual", "shownVerbatim", "severity", "title", "description", "resourceType", "resourceName", "resourceArn", "resourceKey", "targetUrl", "category", "tags", "cwe", "owasp", "status", "visibility", "taskIds", "tickets", "acknowledgedAt", "acknowledgedBy", "falsePositiveReason", "closedReason", "inReviewReason", "inReviewUrl", "sourceName", "origin", "ingestionStatus", "ingestedAt", "createdAt", "updatedAt" ], "additionalProperties": false } } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpError" } } } } } }, "get": { "operationId": "apiListFindings", "summary": "List findings", "tags": [ "findings" ], "description": "List every finding in the organization — Tolmo-authored and third-party scanner rows — from the unified findings read. Filter with origin=tolmo for Tolmo-authored rows only. The lean catalog (source/agent facets, idsOnly) lives at GET /findings/catalog.", "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 512 }, "in": "query", "name": "q", "required": false }, { "schema": { "type": "string", "minLength": 1, "maxLength": 255 }, "in": "query", "name": "origin", "required": false }, { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "query", "name": "severity", "required": false }, { "schema": { "type": "string", "minLength": 1, "maxLength": 512 }, "in": "query", "name": "state", "required": false }, { "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "in": "query", "name": "retest", "required": false }, { "schema": { "type": "string", "minLength": 1, "maxLength": 512 }, "in": "query", "name": "rule", "required": false }, { "schema": { "type": "string", "minLength": 1, "maxLength": 256 }, "in": "query", "name": "status", "required": false }, { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "query", "name": "providerStatus", "required": false }, { "schema": { "type": "string", "enum": [ "tolmo", "none" ] }, "in": "query", "name": "verdict", "required": false }, { "schema": { "default": "all", "type": "string", "enum": [ "open", "all" ] }, "in": "query", "name": "scope", "required": false }, { "schema": { "type": "boolean" }, "in": "query", "name": "includeInfo", "required": false }, { "schema": { "type": "boolean" }, "in": "query", "name": "draftsOnly", "required": false }, { "schema": { "type": "string", "minLength": 1, "maxLength": 4096 }, "in": "query", "name": "query", "required": false }, { "schema": { "type": "integer", "minimum": 1, "maximum": 500 }, "in": "query", "name": "page", "required": false }, { "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "in": "query", "name": "pageSize", "required": false }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "in": "query", "name": "cursor", "required": false }, { "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string" }, "in": "path", "name": "orgSlug", "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "externalId": { "type": "string" }, "title": { "type": "string" }, "severity": { "type": "string" }, "origin": { "type": "string" }, "recordOrigin": { "type": "string", "enum": [ "external", "agent", "manual" ] }, "originalPlatformUrl": { "nullable": true, "type": "string" }, "originalPlatformStatus": { "nullable": true, "type": "string" }, "status": { "type": "string", "enum": [ "open", "in_review", "closed", "acknowledged", "false_positive", "canceled" ] }, "statusEditable": { "type": "boolean" }, "platformResolution": { "nullable": true, "type": "string" }, "inReviewReason": { "nullable": true, "type": "string" }, "inReviewUrl": { "nullable": true, "type": "string" }, "state": { "type": "string", "enum": [ "unprocessed", "duplicate", "ingested", "awaiting_exploit", "exploit_blocked", "defense_in_depth", "exploited", "exploit_not_produced", "false_positive", "resolved" ] }, "agenticStatus": { "nullable": true, "type": "string" }, "lastRetestVerdict": { "nullable": true, "type": "string" }, "lastRetestedAt": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "retest": { "type": "string", "enum": [ "none", "pending", "confirmed", "failed" ] }, "cveDispatchable": { "type": "boolean" }, "resourceKey": { "nullable": true, "type": "string" }, "resourceName": { "nullable": true, "type": "string" }, "kind": { "nullable": true, "type": "string" }, "ruleName": { "nullable": true, "type": "string" }, "targetUrls": { "type": "array", "items": { "type": "string" } }, "firstSeenAt": { "nullable": true, "type": "string" }, "lastSeenAt": { "nullable": true, "type": "string" }, "updatedAt": { "type": "string" }, "lastActivity": { "nullable": true, "type": "object", "properties": { "kind": { "type": "string", "enum": [ "state", "status" ] }, "from": { "nullable": true, "type": "string" }, "to": { "type": "string" }, "at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "by": { "nullable": true, "type": "string" } }, "required": [ "kind", "from", "to", "at", "by" ], "additionalProperties": false }, "tolmoFinding": { "nullable": true, "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "title": { "type": "string" }, "severity": { "type": "string" }, "status": { "type": "string" }, "relationship": { "type": "string", "enum": [ "created", "linked", "duplicate", "merged" ] }, "url": { "type": "string" } }, "required": [ "id", "title", "severity", "status", "relationship", "url" ], "additionalProperties": false } }, "required": [ "id", "externalId", "title", "severity", "origin", "recordOrigin", "originalPlatformUrl", "originalPlatformStatus", "status", "statusEditable", "platformResolution", "inReviewReason", "inReviewUrl", "state", "agenticStatus", "lastRetestVerdict", "lastRetestedAt", "retest", "cveDispatchable", "resourceKey", "resourceName", "kind", "ruleName", "targetUrls", "firstSeenAt", "lastSeenAt", "updatedAt", "lastActivity", "tolmoFinding" ], "additionalProperties": false } }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "page": { "type": "integer", "minimum": 0, "exclusiveMinimum": true, "maximum": 9007199254740991 }, "pageSize": { "type": "integer", "minimum": 0, "exclusiveMinimum": true, "maximum": 9007199254740991 }, "facets": { "type": "object", "properties": { "origins": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "value", "label", "count" ], "additionalProperties": false } }, "severities": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "value", "label", "count" ], "additionalProperties": false } }, "states": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "value", "label", "count" ], "additionalProperties": false } }, "retests": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "value", "label", "count" ], "additionalProperties": false } }, "rules": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "value", "label", "count" ], "additionalProperties": false } }, "statuses": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "value", "label", "count" ], "additionalProperties": false } }, "providerStatuses": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "value", "label", "count" ], "additionalProperties": false } }, "verdicts": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "value", "label", "count" ], "additionalProperties": false } } }, "required": [ "origins", "severities", "states", "retests", "rules", "statuses", "providerStatuses", "verdicts" ], "additionalProperties": false, "description": "Cross-filtered facets for page mode; all arrays are empty in cursor mode. The state/retest/status/providerStatus/verdict facets ignore `scope`, so the pickers still show what the default view is hiding." }, "scope": { "type": "string", "enum": [ "open", "all" ] }, "includeInfo": { "type": "boolean" }, "hiddenInformational": { "nullable": true, "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "nextCursor": { "nullable": true, "type": "string" } }, "required": [ "items", "total", "page", "pageSize", "facets", "scope", "includeInfo", "hiddenInformational", "nextCursor" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpError" } } } } } } }, "/api/v1/orgs/{orgSlug}/findings/{findingId}": { "get": { "operationId": "apiGetFinding", "summary": "Get a finding", "tags": [ "findings" ], "description": "Fetch a single finding by id. Internal triage columns are never serialized on this org-facing surface. Returns 404 rather than 403 for a finding in another organization, and for a draft the caller may not see.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "orgSlug", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "findingId", "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "orgId": { "type": "string" }, "agentId": { "nullable": true, "type": "string" }, "sourceAgentName": { "nullable": true, "type": "string" }, "isManual": { "type": "boolean" }, "shownVerbatim": { "type": "boolean" }, "severity": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "resourceType": { "nullable": true, "type": "string" }, "resourceName": { "nullable": true, "type": "string" }, "resourceArn": { "nullable": true, "type": "string" }, "resourceKey": { "nullable": true, "type": "string" }, "targetUrl": { "nullable": true, "type": "string" }, "category": { "nullable": true, "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "cwe": { "nullable": true, "type": "string" }, "owasp": { "nullable": true, "type": "string" }, "status": { "type": "string" }, "visibility": { "type": "string" }, "taskIds": {}, "tickets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "provider": { "type": "string" }, "integrationId": { "nullable": true, "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "accountAlias": { "nullable": true, "type": "string" }, "externalId": { "type": "string" }, "identifier": { "type": "string" }, "url": { "type": "string" }, "createdAt": { "type": "string" }, "syncStatus": { "nullable": true, "type": "string", "enum": [ "syncing", "synced", "needs_attention" ] }, "syncError": { "nullable": true, "type": "string" }, "syncedAt": { "nullable": true, "type": "string" } }, "required": [ "id", "provider", "integrationId", "accountAlias", "externalId", "identifier", "url", "createdAt", "syncStatus", "syncError", "syncedAt" ], "additionalProperties": false } }, "acknowledgedAt": { "nullable": true, "type": "string" }, "acknowledgedBy": { "nullable": true, "type": "string" }, "falsePositiveReason": { "nullable": true, "type": "string" }, "closedReason": { "nullable": true, "type": "string" }, "inReviewReason": { "nullable": true, "type": "string" }, "inReviewUrl": { "nullable": true, "type": "string" }, "sourceName": { "type": "string" }, "origin": { "type": "string" }, "ingestionStatus": { "nullable": true, "type": "string" }, "ingestedAt": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "attachmentCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "sourceSecret": { "nullable": true, "type": "object", "properties": { "secretFindingId": { "type": "string" }, "ruleId": { "type": "string" }, "verificationState": { "type": "string" }, "isActive": { "nullable": true, "type": "boolean" }, "activeLastSeenAt": { "nullable": true, "type": "string" }, "lastValidatedAt": { "nullable": true, "type": "string" }, "validationMethod": { "nullable": true, "type": "string" } }, "required": [ "secretFindingId", "ruleId", "verificationState", "isActive", "activeLastSeenAt", "lastValidatedAt", "validationMethod" ], "additionalProperties": false }, "exploits": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "steps": { "type": "array", "items": { "type": "string" } }, "resultsAtExploitTime": { "type": "string" }, "retestProbe": { "type": "string" }, "oracle": { "type": "string" }, "drivenBy": { "type": "string" }, "createdAt": { "type": "string" }, "exploitedAt": { "type": "string" }, "lineageId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "id", "steps", "resultsAtExploitTime", "retestProbe", "oracle", "drivenBy", "createdAt", "exploitedAt", "lineageId" ], "additionalProperties": false } } }, "required": [ "id", "orgId", "agentId", "sourceAgentName", "isManual", "shownVerbatim", "severity", "title", "description", "resourceType", "resourceName", "resourceArn", "resourceKey", "targetUrl", "category", "tags", "cwe", "owasp", "status", "visibility", "taskIds", "tickets", "acknowledgedAt", "acknowledgedBy", "falsePositiveReason", "closedReason", "inReviewReason", "inReviewUrl", "sourceName", "origin", "ingestionStatus", "ingestedAt", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpError" } } } } } } }, "/api/v1/orgs/{orgSlug}/findings/{findingId}/attachments": { "get": { "operationId": "listFindingAttachments", "summary": "List a finding's attachments", "tags": [ "findings" ], "description": "List the evidence files attached to a finding. Human tokens only; machine org tokens are rejected.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "orgSlug", "required": true }, { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "findingId", "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "findingId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "fileName": { "type": "string" }, "title": { "nullable": true, "type": "string" }, "contentType": { "type": "string" }, "sizeBytes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "sha256": { "type": "string" }, "uploadedBy": { "type": "string" }, "createdAt": { "type": "string" }, "kind": { "type": "string", "enum": [ "evidence", "report_exhibit", "report_terminal" ] }, "exploitLineageId": { "nullable": true, "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "providerAttachmentId": { "nullable": true, "type": "string" } }, "required": [ "id", "findingId", "fileName", "title", "contentType", "sizeBytes", "sha256", "uploadedBy", "createdAt", "kind", "exploitLineageId", "providerAttachmentId" ], "additionalProperties": false } } } } } } }, "post": { "operationId": "uploadFindingAttachment", "summary": "Upload a finding attachment", "tags": [ "findings" ], "description": "Upload one evidence file for a finding as `application/octet-stream`, capped at 250 MiB. File name and content type travel in the `X-Attachment-File-Name` and `X-Attachment-Content-Type` headers, with an optional URI-encoded `X-Attachment-Title`. A `report_exhibit` video must send `X-Attachment-Exploit-Id`, the exploit it records. A film with no exploit is rejected. Human tokens only.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "orgSlug", "required": true }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "findingId", "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "findingId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "fileName": { "type": "string" }, "title": { "nullable": true, "type": "string" }, "contentType": { "type": "string" }, "sizeBytes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "sha256": { "type": "string" }, "uploadedBy": { "type": "string" }, "createdAt": { "type": "string" }, "kind": { "type": "string", "enum": [ "evidence", "report_exhibit", "report_terminal" ] }, "exploitLineageId": { "nullable": true, "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "providerAttachmentId": { "nullable": true, "type": "string" } }, "required": [ "id", "findingId", "fileName", "title", "contentType", "sizeBytes", "sha256", "uploadedBy", "createdAt", "kind", "exploitLineageId", "providerAttachmentId" ], "additionalProperties": false } } } } } } }, "/api/v1/orgs/{orgSlug}/findings/{findingId}/attachments/{attachmentId}/content": { "get": { "operationId": "downloadFindingAttachment", "summary": "Download a finding attachment", "tags": [ "findings" ], "description": "Stream one attachment's bytes back through the authenticated route — attachments are served from a private bucket and never exposed as object URLs. Responses are forced to attachment disposition with `no-store` and `nosniff`.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "orgSlug", "required": true }, { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "findingId", "required": true }, { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "attachmentId", "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response" } } } }, "/api/v1/orgs/{orgSlug}/findings/{findingId}/attachments/{attachmentId}": { "delete": { "operationId": "deleteFindingAttachment", "summary": "Delete a finding attachment", "tags": [ "findings" ], "description": "Permanently delete one attachment. Because it is irreversible, the caller must be the attachment's uploader or an effective super-admin.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "orgSlug", "required": true }, { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "findingId", "required": true }, { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "attachmentId", "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "enum": [ true ] } }, "required": [ "ok" ], "additionalProperties": false } } } } } } }, "/api/v1/integration-providers": { "get": { "operationId": "apiListIntegrationProviders", "summary": "List integration providers", "tags": [ "integrations" ], "description": "List publicly available integration providers and their field specs. A client-supplied `orgId` is accepted for compatibility and ignored: org-restricted specs are never unlocked by a query parameter.", "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "orgId", "required": false } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response" } } } }, "/api/v1/orgs/{orgSlug}/integrations": { "get": { "operationId": "apiListIntegrations", "summary": "List integrations", "tags": [ "integrations" ], "description": "List integrations", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "orgSlug", "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "provider": { "type": "string" }, "providerLabel": { "type": "string" }, "alias": { "type": "string" }, "config": { "type": "object", "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "docsUrl": { "type": "string" }, "secrets": { "type": "array", "items": {} }, "isNew": { "type": "boolean" } }, "required": [ "id", "provider", "providerLabel", "alias", "config", "docsUrl", "secrets" ], "additionalProperties": false } } } } }, "412": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpError" } } } } } } }, "/api/v1/orgs/{orgSlug}/integrations/{provider}": { "post": { "operationId": "apiConnectIntegration", "summary": "Connect an integration", "tags": [ "integrations" ], "description": "Create/update an integration", "requestBody": { "required": true, "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": {}, "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": { "roleArn": {}, "externalId": {} }, "required": [ "roleArn" ], "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": { "scopeType": {}, "projectId": {}, "folderId": {}, "organizationId": {} }, "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": { "serviceAccountKey": {} }, "required": [ "serviceAccountKey" ], "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": { "accountId": {}, "zoneId": {} }, "required": [ "accountId" ], "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": { "apiToken": {} }, "required": [ "apiToken" ], "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": { "scopeType": {}, "tenantId": {}, "clientId": {}, "subscriptionId": {}, "managementGroupId": {} }, "required": [ "scopeType", "tenantId", "clientId" ], "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": { "clientSecret": {} }, "required": [ "clientSecret" ], "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": { "region": {} }, "required": [ "region" ], "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": { "applicationKey": {}, "applicationSecret": {}, "consumerKey": {} }, "required": [ "applicationKey", "applicationSecret", "consumerKey" ], "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": {}, "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": {}, "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": {}, "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": {}, "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": { "apiToken": {} }, "required": [ "apiToken" ], "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": {}, "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": { "apiToken": {} }, "required": [ "apiToken" ], "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": {}, "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": { "serverUrl": { "type": "string", "format": "uri" } }, "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": { "token": {} }, "required": [ "token" ], "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": { "region": {} }, "required": [ "region" ], "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": { "apiKey": {} }, "required": [ "apiKey" ], "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": { "organizationId": {} }, "required": [ "organizationId" ], "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": { "keyId": {}, "keySecret": {} }, "required": [ "keyId", "keySecret" ], "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": { "organizationSlug": {} }, "required": [ "organizationSlug" ], "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": { "accessToken": {} }, "required": [ "accessToken" ], "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": { "deployment": {}, "app": {} }, "required": [ "deployment" ], "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": { "credentials": { "type": "object", "properties": { "token": {}, "url": {} }, "required": [ "token", "url" ], "additionalProperties": {} } }, "required": [ "credentials" ], "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": { "site": {}, "organizationName": {}, "apiKeyId": {} }, "required": [ "site" ], "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": { "apiKey": {}, "appKey": {} }, "required": [ "apiKey", "appKey" ], "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": { "region": {}, "accountId": {} }, "required": [ "region", "accountId" ], "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": { "apiKey": {} }, "required": [ "apiKey" ], "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": { "projectName": {}, "organization": {} }, "required": [ "projectName" ], "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": { "apiKey": {} }, "required": [ "apiKey" ], "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": { "oktaDomain": {}, "authMethod": {}, "clientId": {}, "syncUsersWithTolmo": {} }, "required": [ "oktaDomain" ], "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": { "apiToken": {}, "privateKey": {} }, "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": {}, "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": { "organization": {}, "hostname": {} }, "required": [ "organization" ], "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": { "apiToken": {}, "auditToken": {} }, "required": [ "apiToken" ], "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": { "organization": {}, "apiUrl": { "type": "string", "format": "uri" } }, "required": [ "organization" ], "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": { "accessToken": {} }, "required": [ "accessToken" ], "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": {}, "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": { "workspace": {} }, "required": [ "workspace" ], "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": { "apiKey": {} }, "required": [ "apiKey" ], "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": { "teamId": {} }, "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": { "apiToken": {} }, "required": [ "apiToken" ], "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": { "cluster": {}, "namespace": {} }, "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": { "kubeconfig": { "type": "object", "properties": { "kubeconfig": {} }, "required": [ "kubeconfig" ], "additionalProperties": {} } }, "required": [ "kubeconfig" ], "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": { "orgSlug": {} }, "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": { "apiToken": {} }, "required": [ "apiToken" ], "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": {}, "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": { "apiToken": {} }, "required": [ "apiToken" ], "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": {}, "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": { "apiKey": {} }, "required": [ "apiKey" ], "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": { "orgId": {} }, "required": [ "orgId" ], "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": { "apiKey": {} }, "required": [ "apiKey" ], "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": { "orgId": {} }, "required": [ "orgId" ], "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": { "publicKey": {}, "privateKey": {} }, "required": [ "publicKey", "privateKey" ], "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": {}, "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": { "apiKey": {} }, "required": [ "apiKey" ], "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": { "tailnet": {} }, "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": { "clientId": {}, "clientSecret": {} }, "required": [ "clientId", "clientSecret" ], "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": {}, "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": { "cloud": {} }, "required": [ "cloud" ], "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": { "clientId": {}, "clientSecret": {} }, "required": [ "clientId", "clientSecret" ], "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": { "tenantId": {}, "clientId": {} }, "required": [ "tenantId", "clientId" ], "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": { "clientSecret": {} }, "required": [ "clientSecret" ], "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": { "consoleUrl": {}, "siteIds": {} }, "required": [ "consoleUrl" ], "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": { "apiToken": {} }, "required": [ "apiToken" ], "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": { "kibanaUrl": {}, "elasticsearchUrl": {} }, "required": [ "kibanaUrl" ], "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": { "apiKey": {}, "basicAuth": { "type": "object", "properties": { "username": {}, "password": {} }, "required": [ "username", "password" ], "additionalProperties": {} } }, "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": { "fqdn": {}, "apiKeyId": {} }, "required": [ "fqdn", "apiKeyId" ], "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": { "apiKey": {} }, "required": [ "apiKey" ], "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": { "hostname": {}, "orgKey": {} }, "required": [ "hostname", "orgKey" ], "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": { "credentials": { "type": "object", "properties": { "apiId": {}, "apiSecretKey": {} }, "required": [ "apiId", "apiSecretKey" ], "additionalProperties": {} } }, "required": [ "credentials" ], "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": { "managerUrl": {}, "indexerUrl": {} }, "required": [ "managerUrl" ], "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": { "managerCredentials": { "type": "object", "properties": { "username": {}, "password": {} }, "required": [ "username", "password" ], "additionalProperties": {} }, "indexerCredentials": { "type": "object", "properties": { "username": {}, "password": {} }, "required": [ "username", "password" ], "additionalProperties": {} } }, "required": [ "managerCredentials" ], "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": {}, "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": { "credentials": { "type": "object", "properties": { "clientId": {}, "clientSecret": {} }, "required": [ "clientId", "clientSecret" ], "additionalProperties": {} } }, "required": [ "credentials" ], "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": { "tenantId": {}, "clientId": {} }, "required": [ "tenantId", "clientId" ], "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": { "clientSecret": {} }, "required": [ "clientSecret" ], "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": { "serverUrl": {} }, "required": [ "serverUrl" ], "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": { "credentials": { "type": "object", "properties": { "clientId": {}, "clientSecret": {} }, "required": [ "clientId", "clientSecret" ], "additionalProperties": {} } }, "required": [ "credentials" ], "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": { "serverUrl": {}, "groupId": {} }, "required": [ "serverUrl" ], "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": { "apiKey": {}, "credentials": { "type": "object", "properties": { "username": {}, "password": {} }, "required": [ "username", "password" ], "additionalProperties": {} } }, "required": [ "apiKey", "credentials" ], "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": { "subdomain": {} }, "required": [ "subdomain" ], "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": { "apiToken": {} }, "required": [ "apiToken" ], "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": { "customerId": {}, "adminEmail": {} }, "required": [ "customerId", "adminEmail" ], "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": { "serviceAccountKey": {} }, "required": [ "serviceAccountKey" ], "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": { "serverUrl": {} }, "required": [ "serverUrl" ], "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": { "apiToken": {} }, "required": [ "apiToken" ], "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": { "oid": {} }, "required": [ "oid" ], "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": { "apiKey": {} }, "required": [ "apiKey" ], "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": {}, "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": { "workspaceSlug": {}, "databaseType": {} }, "required": [ "workspaceSlug", "databaseType" ], "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": { "apiToken": {} }, "required": [ "apiToken" ], "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": {}, "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": {}, "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": { "apiIdentifier": {}, "apiToken": {} }, "required": [ "apiIdentifier", "apiToken" ], "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": {}, "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": { "webhookSecret": {} }, "required": [ "webhookSecret" ], "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": {}, "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": { "clientId": {}, "clientSecret": {} }, "required": [ "clientId", "clientSecret" ], "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": { "region": {} }, "required": [ "region" ], "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": { "apiKey": {} }, "required": [ "apiKey" ], "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": { "organizationSlug": {} }, "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": { "apiToken": {} }, "required": [ "apiToken" ], "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": { "region": {}, "organizationId": {} }, "required": [ "region" ], "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": { "apiToken": {} }, "required": [ "apiToken" ], "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": { "clientId": {} }, "required": [ "clientId" ], "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": { "clientSecret": {} }, "required": [ "clientSecret" ], "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": { "tenantRegion": {}, "clientId": {}, "projectId": {} }, "required": [ "tenantRegion", "clientId" ], "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": { "clientSecret": {} }, "required": [ "clientSecret" ], "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "description": {} }, "required": [ "url" ], "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 }, "config": { "type": "object", "properties": {}, "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "secrets": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "alias", "config", "secrets" ] } ] } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "orgSlug", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "provider", "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "provider": { "type": "string" }, "providerLabel": { "type": "string" }, "alias": { "type": "string" }, "config": { "type": "object", "additionalProperties": {} }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "docsUrl": { "type": "string" }, "secrets": { "type": "array", "items": {} }, "isNew": { "type": "boolean" } }, "required": [ "id", "provider", "providerLabel", "alias", "config", "docsUrl", "secrets" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpError" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpError" } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpError" } } } }, "412": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpError" } } } } } } }, "/api/v1/orgs/{orgSlug}/findings/catalog": { "get": { "operationId": "apiListFindingsCatalog", "summary": "List Tolmo-authored findings (catalog)", "tags": [ "findings" ], "description": "List the organization's Tolmo-authored findings, newest first, with the shared lean paginated contract. Regular callers see published findings only; effective super-admins may additionally read all drafts, and a scoped pentester may list drafts they authored. Scanner-origin rows are excluded. Prefer GET /findings for the unified org list.", "parameters": [ { "schema": { "type": "string", "enum": [ "open", "in_review", "closed", "acknowledged", "false_positive", "canceled" ] }, "in": "query", "name": "status", "required": false }, { "schema": { "type": "string", "enum": [ "critical", "high", "medium", "low", "info" ] }, "in": "query", "name": "severity", "required": false }, { "schema": { "anyOf": [ { "type": "string", "enum": [ "open", "in_review", "closed", "acknowledged", "false_positive", "canceled" ] }, { "type": "array", "items": { "type": "string", "enum": [ "open", "in_review", "closed", "acknowledged", "false_positive", "canceled" ] } } ] }, "in": "query", "name": "statuses", "required": false }, { "schema": { "anyOf": [ { "type": "string", "enum": [ "open", "in_review", "closed", "acknowledged", "false_positive", "canceled" ] }, { "type": "array", "items": { "type": "string", "enum": [ "open", "in_review", "closed", "acknowledged", "false_positive", "canceled" ] } } ] }, "in": "query", "name": "statusExcluded", "required": false }, { "schema": { "anyOf": [ { "type": "string", "enum": [ "critical", "high", "medium", "low", "info" ] }, { "type": "array", "items": { "type": "string", "enum": [ "critical", "high", "medium", "low", "info" ] } } ] }, "in": "query", "name": "severities", "required": false }, { "schema": { "anyOf": [ { "type": "string", "enum": [ "critical", "high", "medium", "low", "info" ] }, { "type": "array", "items": { "type": "string", "enum": [ "critical", "high", "medium", "low", "info" ] } } ] }, "in": "query", "name": "severityExcluded", "required": false }, { "schema": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "in": "query", "name": "source", "required": false }, { "schema": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "in": "query", "name": "sourceExcluded", "required": false }, { "schema": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "in": "query", "name": "agent", "required": false }, { "schema": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "in": "query", "name": "agentExcluded", "required": false }, { "schema": { "type": "string", "maxLength": 512 }, "in": "query", "name": "q", "required": false }, { "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "in": "query", "name": "createdAfter", "required": false }, { "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "in": "query", "name": "createdBefore", "required": false }, { "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "in": "query", "name": "updatedAfter", "required": false }, { "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "in": "query", "name": "updatedBefore", "required": false }, { "schema": { "type": "string", "enum": [ "severity", "status", "created", "updated", "createdAt", "updatedAt" ] }, "in": "query", "name": "sortBy", "required": false }, { "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "in": "query", "name": "sortDir", "required": false }, { "schema": { "type": "integer", "minimum": 1, "maximum": 10000 }, "in": "query", "name": "page", "required": false }, { "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "in": "query", "name": "pageSize", "required": false }, { "schema": { "type": "boolean" }, "in": "query", "name": "includeDrafts", "required": false }, { "schema": { "type": "boolean" }, "in": "query", "name": "draftsOnly", "required": false }, { "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "boolean" }, "in": "query", "name": "idsOnly", "required": false }, { "schema": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "maxItems": 1000, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } ] }, "in": "query", "name": "excludeIds", "required": false }, { "schema": { "type": "string" }, "in": "path", "name": "orgSlug", "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "orgId": { "type": "string" }, "orgSlug": { "nullable": true, "type": "string" }, "orgName": { "nullable": true, "type": "string" }, "agentId": { "nullable": true, "type": "string" }, "sourceAgentName": { "nullable": true, "type": "string" }, "workflowRunId": { "nullable": true, "type": "string" }, "severity": { "type": "string" }, "title": { "type": "string" }, "resourceType": { "nullable": true, "type": "string" }, "resourceName": { "nullable": true, "type": "string" }, "resourceArn": { "nullable": true, "type": "string" }, "resourceKey": { "nullable": true, "type": "string" }, "targetUrl": { "nullable": true, "type": "string" }, "category": { "nullable": true, "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "cwe": { "nullable": true, "type": "string" }, "owasp": { "nullable": true, "type": "string" }, "status": { "type": "string" }, "visibility": { "type": "string" }, "taskIds": {}, "tickets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "provider": { "type": "string" }, "externalId": { "type": "string" }, "identifier": { "nullable": true, "type": "string" }, "url": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "stateName": { "nullable": true, "type": "string" }, "stateType": { "nullable": true, "type": "string" } }, "required": [ "id", "provider", "externalId", "identifier", "url", "createdAt" ], "additionalProperties": false } }, "acknowledgedAt": { "nullable": true, "type": "string" }, "acknowledgedBy": { "nullable": true, "type": "string" }, "hasCloseJustification": { "type": "boolean" }, "sourceName": { "type": "string" }, "isManual": { "type": "boolean" }, "shownVerbatim": { "type": "boolean" }, "ingestionStatus": { "nullable": true, "type": "string" }, "ingestedAt": { "nullable": true, "type": "string" }, "agenticStatus": { "nullable": true, "type": "string" }, "lastRetestedAt": { "nullable": true, "type": "string" }, "lastRetestVerdict": { "nullable": true, "type": "string" }, "lastRetestConfidence": { "nullable": true, "type": "string" }, "lastRetestScanId": { "nullable": true, "type": "string" }, "attachmentCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdBy": { "nullable": true, "type": "string" }, "createdByUser": { "nullable": true, "type": "object", "properties": { "userId": { "type": "string" }, "email": { "nullable": true, "type": "string" }, "name": { "nullable": true, "type": "string" }, "imageUrl": { "nullable": true, "type": "string" } }, "required": [ "userId", "email", "name", "imageUrl" ], "additionalProperties": false }, "origins": { "type": "array", "items": { "type": "string" } }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "orgId", "orgSlug", "orgName", "agentId", "sourceAgentName", "workflowRunId", "severity", "title", "resourceType", "resourceName", "resourceArn", "resourceKey", "targetUrl", "category", "tags", "cwe", "owasp", "status", "visibility", "taskIds", "tickets", "acknowledgedAt", "acknowledgedBy", "hasCloseJustification", "sourceName", "isManual", "shownVerbatim", "ingestionStatus", "ingestedAt", "agenticStatus", "lastRetestedAt", "lastRetestVerdict", "lastRetestConfidence", "lastRetestScanId", "attachmentCount", "createdBy", "createdByUser", "origins", "createdAt", "updatedAt" ], "additionalProperties": false } }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "page": { "type": "integer", "minimum": 0, "exclusiveMinimum": true, "maximum": 9007199254740991 }, "pageSize": { "type": "integer", "minimum": 0, "exclusiveMinimum": true, "maximum": 9007199254740991 }, "publishedTotal": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "items", "total", "page", "pageSize" ], "additionalProperties": false }, { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "ids", "total" ], "additionalProperties": false } ] } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpError" } } } } } } }, "/api/v1/orgs/{orgSlug}/findings/catalog/facets": { "get": { "operationId": "apiListFindingsCatalogFacets", "summary": "List Tolmo catalog filter facets", "tags": [ "findings" ], "description": "Return the available filter values (status, severity, and related dimensions) with their counts for the current query, for building filter UIs without a second full scan. Applies the same visibility rules as GET /findings/catalog.", "parameters": [ { "schema": { "type": "string", "enum": [ "open", "in_review", "closed", "acknowledged", "false_positive", "canceled" ] }, "in": "query", "name": "status", "required": false }, { "schema": { "type": "string", "enum": [ "critical", "high", "medium", "low", "info" ] }, "in": "query", "name": "severity", "required": false }, { "schema": { "anyOf": [ { "type": "string", "enum": [ "open", "in_review", "closed", "acknowledged", "false_positive", "canceled" ] }, { "type": "array", "items": { "type": "string", "enum": [ "open", "in_review", "closed", "acknowledged", "false_positive", "canceled" ] } } ] }, "in": "query", "name": "statuses", "required": false }, { "schema": { "anyOf": [ { "type": "string", "enum": [ "open", "in_review", "closed", "acknowledged", "false_positive", "canceled" ] }, { "type": "array", "items": { "type": "string", "enum": [ "open", "in_review", "closed", "acknowledged", "false_positive", "canceled" ] } } ] }, "in": "query", "name": "statusExcluded", "required": false }, { "schema": { "anyOf": [ { "type": "string", "enum": [ "critical", "high", "medium", "low", "info" ] }, { "type": "array", "items": { "type": "string", "enum": [ "critical", "high", "medium", "low", "info" ] } } ] }, "in": "query", "name": "severities", "required": false }, { "schema": { "anyOf": [ { "type": "string", "enum": [ "critical", "high", "medium", "low", "info" ] }, { "type": "array", "items": { "type": "string", "enum": [ "critical", "high", "medium", "low", "info" ] } } ] }, "in": "query", "name": "severityExcluded", "required": false }, { "schema": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "in": "query", "name": "source", "required": false }, { "schema": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "in": "query", "name": "sourceExcluded", "required": false }, { "schema": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "in": "query", "name": "agent", "required": false }, { "schema": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "in": "query", "name": "agentExcluded", "required": false }, { "schema": { "type": "string", "maxLength": 512 }, "in": "query", "name": "q", "required": false }, { "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "in": "query", "name": "createdAfter", "required": false }, { "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "in": "query", "name": "createdBefore", "required": false }, { "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "in": "query", "name": "updatedAfter", "required": false }, { "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "in": "query", "name": "updatedBefore", "required": false }, { "schema": { "type": "boolean" }, "in": "query", "name": "includeDrafts", "required": false }, { "schema": { "type": "boolean" }, "in": "query", "name": "draftsOnly", "required": false }, { "schema": { "type": "string" }, "in": "path", "name": "orgSlug", "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "severities": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "value", "label", "count" ], "additionalProperties": false } }, "statuses": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "value", "label", "count" ], "additionalProperties": false } }, "sources": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "value", "label", "count" ], "additionalProperties": false } }, "agents": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "value", "label", "count" ], "additionalProperties": false } }, "createdBy": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "value", "label", "count" ], "additionalProperties": false } }, "visibilities": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "value", "label", "count" ], "additionalProperties": false } }, "categories": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "value", "label", "count" ], "additionalProperties": false } }, "owasps": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "value", "label", "count" ], "additionalProperties": false } }, "impactCategories": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "value", "label", "count" ], "additionalProperties": false } }, "fixPriorities": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "value", "label", "count" ], "additionalProperties": false } } }, "required": [ "severities", "statuses", "sources", "agents", "createdBy", "visibilities", "categories", "owasps", "impactCategories", "fixPriorities" ], "additionalProperties": false } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpError" } } } } } } }, "/api/v1/orgs/{orgSlug}/findings/facets": { "get": { "operationId": "apiListFindingsFacets", "summary": "List finding filter facets", "tags": [ "findings" ], "description": "Return the available filter values (status, severity, and related dimensions) with their counts for the current query, for building filter UIs without a second full scan. Applies the same visibility rules as GET /findings/catalog.", "parameters": [ { "schema": { "type": "string", "enum": [ "open", "in_review", "closed", "acknowledged", "false_positive", "canceled" ] }, "in": "query", "name": "status", "required": false }, { "schema": { "type": "string", "enum": [ "critical", "high", "medium", "low", "info" ] }, "in": "query", "name": "severity", "required": false }, { "schema": { "anyOf": [ { "type": "string", "enum": [ "open", "in_review", "closed", "acknowledged", "false_positive", "canceled" ] }, { "type": "array", "items": { "type": "string", "enum": [ "open", "in_review", "closed", "acknowledged", "false_positive", "canceled" ] } } ] }, "in": "query", "name": "statuses", "required": false }, { "schema": { "anyOf": [ { "type": "string", "enum": [ "open", "in_review", "closed", "acknowledged", "false_positive", "canceled" ] }, { "type": "array", "items": { "type": "string", "enum": [ "open", "in_review", "closed", "acknowledged", "false_positive", "canceled" ] } } ] }, "in": "query", "name": "statusExcluded", "required": false }, { "schema": { "anyOf": [ { "type": "string", "enum": [ "critical", "high", "medium", "low", "info" ] }, { "type": "array", "items": { "type": "string", "enum": [ "critical", "high", "medium", "low", "info" ] } } ] }, "in": "query", "name": "severities", "required": false }, { "schema": { "anyOf": [ { "type": "string", "enum": [ "critical", "high", "medium", "low", "info" ] }, { "type": "array", "items": { "type": "string", "enum": [ "critical", "high", "medium", "low", "info" ] } } ] }, "in": "query", "name": "severityExcluded", "required": false }, { "schema": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "in": "query", "name": "source", "required": false }, { "schema": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "in": "query", "name": "sourceExcluded", "required": false }, { "schema": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "in": "query", "name": "agent", "required": false }, { "schema": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "in": "query", "name": "agentExcluded", "required": false }, { "schema": { "type": "string", "maxLength": 512 }, "in": "query", "name": "q", "required": false }, { "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "in": "query", "name": "createdAfter", "required": false }, { "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "in": "query", "name": "createdBefore", "required": false }, { "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "in": "query", "name": "updatedAfter", "required": false }, { "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "in": "query", "name": "updatedBefore", "required": false }, { "schema": { "type": "boolean" }, "in": "query", "name": "includeDrafts", "required": false }, { "schema": { "type": "boolean" }, "in": "query", "name": "draftsOnly", "required": false }, { "schema": { "type": "string" }, "in": "path", "name": "orgSlug", "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "severities": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "value", "label", "count" ], "additionalProperties": false } }, "statuses": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "value", "label", "count" ], "additionalProperties": false } }, "sources": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "value", "label", "count" ], "additionalProperties": false } }, "agents": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "value", "label", "count" ], "additionalProperties": false } }, "createdBy": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "value", "label", "count" ], "additionalProperties": false } }, "visibilities": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "value", "label", "count" ], "additionalProperties": false } }, "categories": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "value", "label", "count" ], "additionalProperties": false } }, "owasps": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "value", "label", "count" ], "additionalProperties": false } }, "impactCategories": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "value", "label", "count" ], "additionalProperties": false } }, "fixPriorities": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "value", "label", "count" ], "additionalProperties": false } } }, "required": [ "severities", "statuses", "sources", "agents", "createdBy", "visibilities", "categories", "owasps", "impactCategories", "fixPriorities" ], "additionalProperties": false } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpError" } } } } } } }, "/api/v1/orgs/{orgSlug}/findings/{findingId}/status-history": { "get": { "operationId": "apiListFindingStatusHistory", "summary": "List a finding's status history", "tags": [ "findings" ], "description": "Return the ordered audit trail of status transitions for one finding, including who made each change and when.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "orgSlug", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "findingId", "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "findingId": { "type": "string" }, "fromStatus": { "nullable": true, "type": "string" }, "toStatus": { "type": "string" }, "changedBy": { "type": "string" }, "actorDisplayName": { "type": "string" }, "changedAt": { "type": "string" } }, "required": [ "id", "findingId", "fromStatus", "toStatus", "changedBy", "actorDisplayName", "changedAt" ], "additionalProperties": false } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpError" } } } } } } }, "/api/v1/orgs/{orgSlug}/findings/{findingId}/sources": { "get": { "operationId": "apiListFindingSources", "summary": "List a finding's sources", "tags": [ "findings" ], "description": "Return the evidence sources attached to a finding — the scans, resources, and detections that produced or corroborated it.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "orgSlug", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "findingId", "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "origin": { "type": "string" }, "sourceName": { "nullable": true, "type": "string" }, "externalId": { "nullable": true, "type": "string" }, "integrationId": { "nullable": true, "type": "string" }, "content": {}, "reportedAt": { "type": "string" }, "createdAt": { "type": "string" } }, "required": [ "id", "origin", "sourceName", "externalId", "integrationId", "content", "reportedAt", "createdAt" ], "additionalProperties": false } } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpError" } } } } } } }, "/api/v1/orgs/{orgSlug}/findings/{findingId}/status": { "patch": { "operationId": "apiUpdateFindingStatus", "summary": "Update a finding's status", "tags": [ "findings" ], "description": "Transition a finding between `open`, `in_review`, `acknowledged`, `closed`, `false_positive`, and `canceled`. The transition is recorded in the finding's status history with its actor, so the change is auditable. On a scanner row (GitHub, Wiz, and the rest) this writes `provider_status` and does not call the provider; `canceled` is refused. A later scan that still reports the alert overwrites that provider status.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "open", "in_review", "closed", "acknowledged", "false_positive", "canceled" ] }, "falsePositiveReason": { "nullable": true, "type": "string", "maxLength": 4096 }, "closedReason": { "nullable": true, "type": "string", "maxLength": 4096 }, "inReviewReason": { "nullable": true, "type": "string", "maxLength": 4096 }, "inReviewUrl": { "nullable": true, "type": "string", "maxLength": 2048 } }, "required": [ "status" ], "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "orgSlug", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "findingId", "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "orgId": { "type": "string" }, "agentId": { "nullable": true, "type": "string" }, "sourceAgentName": { "nullable": true, "type": "string" }, "isManual": { "type": "boolean" }, "shownVerbatim": { "type": "boolean" }, "severity": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "resourceType": { "nullable": true, "type": "string" }, "resourceName": { "nullable": true, "type": "string" }, "resourceArn": { "nullable": true, "type": "string" }, "resourceKey": { "nullable": true, "type": "string" }, "targetUrl": { "nullable": true, "type": "string" }, "category": { "nullable": true, "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "cwe": { "nullable": true, "type": "string" }, "owasp": { "nullable": true, "type": "string" }, "status": { "type": "string" }, "visibility": { "type": "string" }, "taskIds": {}, "tickets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "provider": { "type": "string" }, "integrationId": { "nullable": true, "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "accountAlias": { "nullable": true, "type": "string" }, "externalId": { "type": "string" }, "identifier": { "type": "string" }, "url": { "type": "string" }, "createdAt": { "type": "string" }, "syncStatus": { "nullable": true, "type": "string", "enum": [ "syncing", "synced", "needs_attention" ] }, "syncError": { "nullable": true, "type": "string" }, "syncedAt": { "nullable": true, "type": "string" } }, "required": [ "id", "provider", "integrationId", "accountAlias", "externalId", "identifier", "url", "createdAt", "syncStatus", "syncError", "syncedAt" ], "additionalProperties": false } }, "acknowledgedAt": { "nullable": true, "type": "string" }, "acknowledgedBy": { "nullable": true, "type": "string" }, "falsePositiveReason": { "nullable": true, "type": "string" }, "closedReason": { "nullable": true, "type": "string" }, "inReviewReason": { "nullable": true, "type": "string" }, "inReviewUrl": { "nullable": true, "type": "string" }, "sourceName": { "type": "string" }, "origin": { "type": "string" }, "ingestionStatus": { "nullable": true, "type": "string" }, "ingestedAt": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "attachmentCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "sourceSecret": { "nullable": true, "type": "object", "properties": { "secretFindingId": { "type": "string" }, "ruleId": { "type": "string" }, "verificationState": { "type": "string" }, "isActive": { "nullable": true, "type": "boolean" }, "activeLastSeenAt": { "nullable": true, "type": "string" }, "lastValidatedAt": { "nullable": true, "type": "string" }, "validationMethod": { "nullable": true, "type": "string" } }, "required": [ "secretFindingId", "ruleId", "verificationState", "isActive", "activeLastSeenAt", "lastValidatedAt", "validationMethod" ], "additionalProperties": false }, "exploits": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "steps": { "type": "array", "items": { "type": "string" } }, "resultsAtExploitTime": { "type": "string" }, "retestProbe": { "type": "string" }, "oracle": { "type": "string" }, "drivenBy": { "type": "string" }, "createdAt": { "type": "string" }, "exploitedAt": { "type": "string" }, "lineageId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "id", "steps", "resultsAtExploitTime", "retestProbe", "oracle", "drivenBy", "createdAt", "exploitedAt", "lineageId" ], "additionalProperties": false } } }, "required": [ "id", "orgId", "agentId", "sourceAgentName", "isManual", "shownVerbatim", "severity", "title", "description", "resourceType", "resourceName", "resourceArn", "resourceKey", "targetUrl", "category", "tags", "cwe", "owasp", "status", "visibility", "taskIds", "tickets", "acknowledgedAt", "acknowledgedBy", "falsePositiveReason", "closedReason", "inReviewReason", "inReviewUrl", "sourceName", "origin", "ingestionStatus", "ingestedAt", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpError" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpError" } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpError" } } } } } } }, "/api/v1/orgs/{orgSlug}/external-findings/views": { "get": { "operationId": "apiGetExternalFindingViewCounts", "summary": "Count findings by saved view", "tags": [ "external-findings" ], "description": "Return counts for the saved finding views visible to the caller, with the time the counts were computed.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "orgSlug", "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "savedViews": { "type": "object", "properties": { "validated_exploits": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "open": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "closed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "triage_backlog": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "validated_exploits", "open", "closed", "triage_backlog" ], "additionalProperties": false }, "computedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } }, "required": [ "savedViews", "computedAt" ], "additionalProperties": false } } } } } } }, "/api/v1/orgs/{orgSlug}/external-findings/{externalFindingId}": { "get": { "operationId": "apiGetExternalFinding", "summary": "Get a unified finding", "tags": [ "external-findings" ], "description": "Fetch a Tolmo-authored or third-party finding by its unified finding ID, including its description and assessment history. Returns 404 when the finding is not visible to the caller.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "orgSlug", "required": true }, { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "externalFindingId", "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "externalId": { "type": "string" }, "title": { "type": "string" }, "severity": { "type": "string" }, "origin": { "type": "string" }, "recordOrigin": { "type": "string", "enum": [ "external", "agent", "manual" ] }, "originalPlatformUrl": { "nullable": true, "type": "string" }, "originalPlatformStatus": { "nullable": true, "type": "string" }, "status": { "type": "string", "enum": [ "open", "in_review", "closed", "acknowledged", "false_positive", "canceled" ] }, "statusEditable": { "type": "boolean" }, "platformResolution": { "nullable": true, "type": "string" }, "inReviewReason": { "nullable": true, "type": "string" }, "inReviewUrl": { "nullable": true, "type": "string" }, "state": { "type": "string", "enum": [ "unprocessed", "duplicate", "ingested", "awaiting_exploit", "exploit_blocked", "defense_in_depth", "exploited", "exploit_not_produced", "false_positive", "resolved" ] }, "agenticStatus": { "nullable": true, "type": "string" }, "lastRetestVerdict": { "nullable": true, "type": "string" }, "lastRetestedAt": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "retest": { "type": "string", "enum": [ "none", "pending", "confirmed", "failed" ] }, "cveDispatchable": { "type": "boolean" }, "resourceKey": { "nullable": true, "type": "string" }, "resourceName": { "nullable": true, "type": "string" }, "kind": { "nullable": true, "type": "string" }, "ruleName": { "nullable": true, "type": "string" }, "targetUrls": { "type": "array", "items": { "type": "string" } }, "firstSeenAt": { "nullable": true, "type": "string" }, "lastSeenAt": { "nullable": true, "type": "string" }, "updatedAt": { "type": "string" }, "lastActivity": { "nullable": true, "type": "object", "properties": { "kind": { "type": "string", "enum": [ "state", "status" ] }, "from": { "nullable": true, "type": "string" }, "to": { "type": "string" }, "at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "by": { "nullable": true, "type": "string" } }, "required": [ "kind", "from", "to", "at", "by" ], "additionalProperties": false }, "tolmoFinding": { "nullable": true, "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "title": { "type": "string" }, "severity": { "type": "string" }, "status": { "type": "string" }, "relationship": { "type": "string", "enum": [ "created", "linked", "duplicate", "merged" ] }, "url": { "type": "string" } }, "required": [ "id", "title", "severity", "status", "relationship", "url" ], "additionalProperties": false }, "body": { "nullable": true, "type": "string" }, "ruleId": { "nullable": true, "type": "string" }, "raw": {}, "reports": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "state": { "type": "string", "enum": [ "unprocessed", "duplicate", "ingested", "awaiting_exploit", "exploit_blocked", "defense_in_depth", "exploited", "exploit_not_produced", "false_positive", "resolved" ] }, "title": { "type": "string" }, "agentName": { "nullable": true, "type": "string" }, "verdict": { "nullable": true, "type": "string" }, "summary": { "nullable": true, "type": "string" }, "markdown": { "nullable": true, "type": "string" }, "createdAt": { "type": "string" }, "durationMs": { "nullable": true, "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "reportUrl": { "nullable": true, "type": "string" }, "confidence": { "nullable": true, "type": "string", "enum": [ "high", "medium", "low" ] }, "stage": { "type": "string", "enum": [ "false_positive_triage", "exploitation" ] }, "outcome": { "type": "string", "enum": [ "false_positive", "resolved", "needs_exploitation", "exploited", "exploitation_unsuccessful", "inconclusive" ] }, "reportMarkdown": { "nullable": true, "type": "string" }, "agentOutputId": { "nullable": true, "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "workflowRunId": { "nullable": true, "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "id", "state", "title", "agentName", "verdict", "summary", "markdown", "createdAt", "durationMs", "reportUrl", "confidence", "stage", "outcome", "reportMarkdown", "agentOutputId", "workflowRunId" ], "additionalProperties": false } }, "transitions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "fromState": { "nullable": true, "type": "string" }, "toState": { "type": "string" }, "fromDuplicateOf": { "nullable": true, "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "toDuplicateOf": { "nullable": true, "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "changedBy": { "type": "string" }, "reason": { "nullable": true, "type": "string" }, "changedAt": { "type": "string" }, "report": { "nullable": true, "type": "object", "properties": { "markdown": { "type": "string" }, "agentName": { "nullable": true, "type": "string" }, "stage": { "type": "string" } }, "required": [ "markdown", "agentName", "stage" ], "additionalProperties": false } }, "required": [ "id", "fromState", "toState", "fromDuplicateOf", "toDuplicateOf", "changedBy", "reason", "changedAt", "report" ], "additionalProperties": false } }, "duplicateOf": { "nullable": true, "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "title": { "type": "string" }, "severity": { "type": "string" }, "state": { "type": "string" }, "origin": { "type": "string" } }, "required": [ "id", "title", "severity", "state", "origin" ], "additionalProperties": false }, "duplicates": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "title": { "type": "string" }, "severity": { "type": "string" }, "state": { "type": "string" }, "origin": { "type": "string" } }, "required": [ "id", "title", "severity", "state", "origin" ], "additionalProperties": false } }, "duplicateCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "verificationRun": { "nullable": true, "type": "object", "properties": { "status": { "type": "string", "enum": [ "running" ] }, "startedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "workflowId": { "type": "string" } }, "required": [ "status", "startedAt", "workflowId" ], "additionalProperties": false } }, "required": [ "id", "externalId", "title", "severity", "origin", "recordOrigin", "originalPlatformUrl", "originalPlatformStatus", "status", "statusEditable", "platformResolution", "inReviewReason", "inReviewUrl", "state", "agenticStatus", "lastRetestVerdict", "lastRetestedAt", "retest", "cveDispatchable", "resourceKey", "resourceName", "kind", "ruleName", "targetUrls", "firstSeenAt", "lastSeenAt", "updatedAt", "lastActivity", "tolmoFinding", "body", "ruleId", "raw", "reports", "transitions", "duplicateOf", "duplicates", "duplicateCount", "verificationRun" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpError" } } } } } } }, "/api/v1/orgs/{orgSlug}/external-findings": { "post": { "operationId": "uploadExternalFindings", "summary": "Import third-party findings", "tags": [ "external-findings" ], "description": "Import findings under a provider and stable source name. Reusing the same provider, source, and external ID updates the existing record. Returns the imported finding IDs.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "provider": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[a-z0-9][a-z0-9._-]*$" }, "source": { "type": "string", "minLength": 1, "maxLength": 128 }, "findings": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "externalId": { "type": "string", "minLength": 1, "maxLength": 512 }, "title": { "type": "string", "minLength": 1, "maxLength": 10000 }, "severity": { "type": "string", "minLength": 1, "maxLength": 64 }, "status": { "default": "open", "type": "string", "minLength": 1, "maxLength": 64 }, "kind": { "default": "security_finding", "type": "string", "minLength": 1, "maxLength": 128 }, "body": { "nullable": true, "type": "string", "maxLength": 1000000 }, "resourceKey": { "nullable": true, "type": "string", "maxLength": 10000 }, "ruleId": { "nullable": true, "type": "string", "maxLength": 2000 }, "ruleName": { "nullable": true, "type": "string", "maxLength": 2000 }, "originalUrl": { "nullable": true, "type": "string", "format": "uri" }, "firstSeenAt": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "lastSeenAt": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "raw": { "default": {}, "type": "object", "additionalProperties": {} } }, "required": [ "externalId", "title", "severity" ], "additionalProperties": false } } }, "required": [ "provider", "source", "findings" ], "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "orgSlug", "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "sourceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "upserted": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "externalId": { "type": "string" } }, "required": [ "id", "externalId" ], "additionalProperties": false } } }, "required": [ "sourceId", "upserted", "items" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpError" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpError" } } } } } } }, "/api/v1/orgs/{orgSlug}/secret-findings": { "get": { "operationId": "apiListSecretFindings", "summary": "List secret findings", "tags": [ "secrets" ], "description": "List leaked-credential findings detected across the organization's connected source repositories, with their current triage state.", "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "resourceKey", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "severity", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "ruleId", "required": false }, { "schema": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "in": "query", "name": "since", "required": false, "description": "ISO-8601 timestamp; only secrets last seen on or after this point are returned" }, { "schema": { "type": "integer", "minimum": 1, "maximum": 500 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "in": "query", "name": "offset", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "unprocessedForScan", "required": false, "description": "When set, returns only rows whose triage is missing or evaluated against a different scan than `latest_scan_id`. Drives the secret-finding-triage agent sweep." }, { "schema": { "type": "string" }, "in": "path", "name": "orgSlug", "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "orgId": { "type": "string" }, "resourceKey": { "type": "string" }, "fingerprint": { "type": "string" }, "source": { "type": "string" }, "engine": { "type": "string" }, "engineVersion": { "type": "string" }, "ruleId": { "type": "string" }, "propertyPath": { "type": "string" }, "severity": { "type": "string" }, "entropy": { "type": "number" }, "verificationState": { "type": "string" }, "origin": { "type": "string" }, "matchContext": { "type": "string" }, "startLine": { "type": "number" }, "endLine": { "type": "number" }, "startColumn": { "type": "number" }, "endColumn": { "type": "number" }, "firstSeenAt": { "type": "string" }, "lastSeenAt": { "type": "string" }, "latestScanId": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "triageVerdict": { "nullable": true, "type": "string", "enum": [ "real_secret", "likely_real", "likely_false_positive", "clear_false_positive" ] }, "triageConfidence": { "nullable": true, "type": "string", "enum": [ "high", "medium", "low" ] }, "triageSeverity": { "nullable": true, "type": "string", "enum": [ "critical", "high", "medium", "low" ] }, "triageReasoning": { "nullable": true, "type": "string" }, "triageModel": { "nullable": true, "type": "string" }, "triageVerified": { "nullable": true, "type": "boolean" }, "triageVerificationMethod": { "nullable": true, "type": "string" }, "triageEvaluatedScanId": { "nullable": true, "type": "string" }, "triageEvaluatedAt": { "nullable": true, "type": "string" }, "triagePostedFindingId": { "nullable": true, "type": "string" }, "integrationId": { "nullable": true, "type": "string" }, "isActive": { "nullable": true, "type": "boolean" }, "activeLastSeenAt": { "nullable": true, "type": "string" }, "lastValidatedAt": { "nullable": true, "type": "string" }, "validationError": { "nullable": true, "type": "string" }, "validationMethod": { "nullable": true, "type": "string" }, "tokenOwner": { "nullable": true, "type": "string" }, "tokenOwnerType": { "nullable": true, "type": "string" }, "tokenScopes": { "nullable": true, "type": "array", "items": { "type": "string" } }, "tokenPrivilege": { "nullable": true, "type": "string" }, "tokenIdentity": { "nullable": true, "type": "object", "additionalProperties": { "type": "string" } } }, "required": [ "id", "orgId", "resourceKey", "fingerprint", "source", "engine", "engineVersion", "ruleId", "propertyPath", "severity", "entropy", "verificationState", "origin", "matchContext", "startLine", "endLine", "startColumn", "endColumn", "firstSeenAt", "lastSeenAt", "latestScanId", "createdAt", "updatedAt", "triageVerdict", "triageConfidence", "triageSeverity", "triageReasoning", "triageModel", "triageVerified", "triageVerificationMethod", "triageEvaluatedScanId", "triageEvaluatedAt", "triagePostedFindingId", "integrationId", "isActive", "activeLastSeenAt", "lastValidatedAt", "validationError", "validationMethod", "tokenOwner", "tokenOwnerType", "tokenScopes", "tokenPrivilege", "tokenIdentity" ], "additionalProperties": false } } } } } } } }, "/api/v1/orgs/{orgSlug}/domains/apexes": { "get": { "operationId": "apiListDomainApexes", "summary": "List apex domains", "tags": [ "domains" ], "description": "List apex domains with an exact organization-wide subdomain total, host counts, and collapsed-row summaries (apex host, probe snapshots, first/last seen) for canonical domain inventory. Ordered by apex ASC. Offset pagination via page + limit.", "parameters": [ { "schema": { "type": "string", "enum": [ "production", "staging", "unlabeled" ] }, "in": "query", "name": "environment", "required": false }, { "schema": { "type": "string", "minLength": 1, "maxLength": 512 }, "in": "query", "name": "q", "required": false }, { "schema": { "type": "string", "enum": [ "current", "stale", "historical" ] }, "in": "query", "name": "lifecycleStatus", "required": false }, { "schema": { "type": "string", "enum": [ "resolved", "unresolved", "error", "not_checked" ] }, "in": "query", "name": "dnsStatus", "required": false }, { "schema": { "type": "string", "enum": [ "reachable", "unreachable", "blocked", "not_checked" ] }, "in": "query", "name": "webStatus", "required": false }, { "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "in": "query", "name": "source", "required": false }, { "schema": { "type": "string", "minLength": 1, "maxLength": 1024 }, "in": "query", "name": "labels", "required": false }, { "schema": { "type": "string", "enum": [ "true", "false" ] }, "in": "query", "name": "offensiveAuthorized", "required": false }, { "schema": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "in": "query", "name": "page", "required": false }, { "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string" }, "in": "path", "name": "orgSlug", "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "integer", "minimum": 0, "exclusiveMinimum": true, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 0, "exclusiveMinimum": true, "maximum": 9007199254740991 }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalPages": { "type": "integer", "minimum": 0, "exclusiveMinimum": true, "maximum": 9007199254740991 }, "items": { "type": "array", "items": { "type": "object", "properties": { "apexDomain": { "type": "string" }, "hostCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "attackSurfaceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "firstDiscoveredAt": { "type": "string" }, "lastDiscoveredAt": { "type": "string" }, "apexHost": { "nullable": true, "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "fqdn": { "type": "string" }, "apexDomain": { "type": "string" }, "lifecycleStatus": { "type": "string", "enum": [ "current", "stale", "historical" ] }, "dnsStatus": { "type": "string", "enum": [ "resolved", "unresolved", "error", "not_checked" ] }, "webStatus": { "type": "string", "enum": [ "reachable", "unreachable", "blocked", "not_checked" ] }, "addresses": { "type": "array", "items": { "type": "string" } }, "cname": { "nullable": true, "type": "string" }, "preferredUrl": { "nullable": true, "type": "string" }, "httpStatus": { "nullable": true, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "redirectUrl": { "nullable": true, "type": "string" }, "title": { "nullable": true, "type": "string" }, "tlsNotAfter": { "nullable": true, "type": "string" }, "firstDiscoveredAt": { "type": "string" }, "lastDiscoveredAt": { "type": "string" }, "lastCheckedAt": { "type": "string" }, "lastResolvedAt": { "nullable": true, "type": "string" }, "lastHttpSeenAt": { "nullable": true, "type": "string" }, "staleSince": { "nullable": true, "type": "string" }, "sources": { "type": "array", "items": { "type": "string" } }, "environment": { "nullable": true, "type": "string", "enum": [ "production", "staging" ] }, "environmentSource": { "nullable": true, "type": "string", "enum": [ "override", "hostname", "aws_account", "sibling", "target_tag", "heroku_pipeline" ] }, "environmentAuto": { "nullable": true, "type": "string", "enum": [ "production", "staging" ] }, "environmentOverride": { "nullable": true, "type": "string", "enum": [ "production", "staging", "unlabeled" ] }, "labels": { "type": "array", "items": { "type": "string" } }, "offensiveAuthorizedAt": { "nullable": true, "type": "string" }, "offensiveAuthorizedBy": { "nullable": true, "type": "string" }, "offensiveCoversDescendants": { "type": "boolean" }, "offensiveAuthorizationInheritedFrom": { "nullable": true, "type": "string" } }, "required": [ "id", "fqdn", "apexDomain", "lifecycleStatus", "dnsStatus", "webStatus", "addresses", "cname", "preferredUrl", "httpStatus", "redirectUrl", "title", "tlsNotAfter", "firstDiscoveredAt", "lastDiscoveredAt", "lastCheckedAt", "lastResolvedAt", "lastHttpSeenAt", "staleSince", "sources", "environment", "environmentSource", "environmentAuto", "environmentOverride", "labels", "offensiveAuthorizedAt", "offensiveAuthorizedBy", "offensiveCoversDescendants", "offensiveAuthorizationInheritedFrom" ], "additionalProperties": false }, "scopedHosts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "fqdn": { "type": "string" }, "offensiveAuthorizedAt": { "nullable": true, "type": "string" } }, "required": [ "id", "fqdn", "offensiveAuthorizedAt" ], "additionalProperties": false } }, "subdomainProbes": { "type": "array", "items": { "type": "object", "properties": { "dnsStatus": { "type": "string", "enum": [ "resolved", "unresolved", "error", "not_checked" ] }, "webStatus": { "type": "string", "enum": [ "reachable", "unreachable", "blocked", "not_checked" ] }, "httpStatus": { "nullable": true, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "count": { "type": "integer", "minimum": 0, "exclusiveMinimum": true, "maximum": 9007199254740991 }, "fqdns": { "type": "array", "items": { "type": "string" } } }, "required": [ "dnsStatus", "webStatus", "httpStatus", "count", "fqdns" ], "additionalProperties": false } }, "subdomainProbesOmittedCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "apexDomain", "hostCount", "attackSurfaceCount", "firstDiscoveredAt", "lastDiscoveredAt", "apexHost", "scopedHosts", "subdomainProbes", "subdomainProbesOmittedCount" ], "additionalProperties": false } }, "subdomainTotal": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "authorizedTotal": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "page", "limit", "total", "totalPages", "items", "subdomainTotal", "authorizedTotal" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpError" } } } } } } }, "/api/v1/orgs/{orgSlug}/domains/descendant-probes": { "get": { "operationId": "apiListDomainDescendantProbes", "summary": "List descendant probe aggregates", "tags": [ "domains" ], "description": "Complete probe aggregates for every intermediate parent under one apex (Postgres; not Attack Surface). Same filters as the host list. Not paginated — one row per parent with grouped subdomainProbes (capped) and subdomainCount.", "parameters": [ { "schema": { "type": "string", "enum": [ "production", "staging", "unlabeled" ] }, "in": "query", "name": "environment", "required": false }, { "schema": { "type": "string", "minLength": 1, "maxLength": 512 }, "in": "query", "name": "q", "required": false }, { "schema": { "type": "string", "enum": [ "current", "stale", "historical" ] }, "in": "query", "name": "lifecycleStatus", "required": false }, { "schema": { "type": "string", "enum": [ "resolved", "unresolved", "error", "not_checked" ] }, "in": "query", "name": "dnsStatus", "required": false }, { "schema": { "type": "string", "enum": [ "reachable", "unreachable", "blocked", "not_checked" ] }, "in": "query", "name": "webStatus", "required": false }, { "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "in": "query", "name": "source", "required": false }, { "schema": { "type": "string", "minLength": 1, "maxLength": 1024 }, "in": "query", "name": "labels", "required": false }, { "schema": { "type": "string", "enum": [ "true", "false" ] }, "in": "query", "name": "offensiveAuthorized", "required": false }, { "schema": { "type": "string", "minLength": 1, "maxLength": 253 }, "in": "query", "name": "apexDomain", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "orgSlug", "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "parentFqdn": { "type": "string" }, "subdomainCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "subdomainProbes": { "type": "array", "items": { "type": "object", "properties": { "dnsStatus": { "type": "string", "enum": [ "resolved", "unresolved", "error", "not_checked" ] }, "webStatus": { "type": "string", "enum": [ "reachable", "unreachable", "blocked", "not_checked" ] }, "httpStatus": { "nullable": true, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "count": { "type": "integer", "minimum": 0, "exclusiveMinimum": true, "maximum": 9007199254740991 }, "fqdns": { "type": "array", "items": { "type": "string" } } }, "required": [ "dnsStatus", "webStatus", "httpStatus", "count", "fqdns" ], "additionalProperties": false } }, "subdomainProbesOmittedCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "parentFqdn", "subdomainCount", "subdomainProbes", "subdomainProbesOmittedCount" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpError" } } } } } } }, "/api/v1/orgs/{orgSlug}/domains/export": { "get": { "operationId": "apiExportDomains", "summary": "Export the domain inventory", "tags": [ "domains" ], "description": "Download canonical (primary) domain inventory as CSV or JSON. One row per hostname, same filters as the list (`q`, lifecycle, dns, web, source). Omits Attack Surface / candidates and bookkeeping evidence sources. Ordered by apex then FQDN.", "parameters": [ { "schema": { "type": "string", "enum": [ "production", "staging", "unlabeled" ] }, "in": "query", "name": "environment", "required": false }, { "schema": { "type": "string", "minLength": 1, "maxLength": 512 }, "in": "query", "name": "q", "required": false }, { "schema": { "type": "string", "enum": [ "current", "stale", "historical" ] }, "in": "query", "name": "lifecycleStatus", "required": false }, { "schema": { "type": "string", "enum": [ "resolved", "unresolved", "error", "not_checked" ] }, "in": "query", "name": "dnsStatus", "required": false }, { "schema": { "type": "string", "enum": [ "reachable", "unreachable", "blocked", "not_checked" ] }, "in": "query", "name": "webStatus", "required": false }, { "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "in": "query", "name": "source", "required": false }, { "schema": { "type": "string", "minLength": 1, "maxLength": 1024 }, "in": "query", "name": "labels", "required": false }, { "schema": { "type": "string", "enum": [ "true", "false" ] }, "in": "query", "name": "offensiveAuthorized", "required": false }, { "schema": { "type": "string", "enum": [ "csv", "json" ] }, "in": "query", "name": "format", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "orgSlug", "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "400": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpError" } } } } } } }, "/api/v1/orgs/{orgSlug}/domains": { "get": { "operationId": "apiListDomains", "summary": "List domains", "tags": [ "domains" ], "description": "List hostnames (Postgres; not Attack Surface). Ordered by apex then FQDN. Optional apexDomain scopes to one apex. Offset pagination via page + limit.", "parameters": [ { "schema": { "type": "string", "enum": [ "production", "staging", "unlabeled" ] }, "in": "query", "name": "environment", "required": false }, { "schema": { "type": "string", "minLength": 1, "maxLength": 512 }, "in": "query", "name": "q", "required": false }, { "schema": { "type": "string", "enum": [ "current", "stale", "historical" ] }, "in": "query", "name": "lifecycleStatus", "required": false }, { "schema": { "type": "string", "enum": [ "resolved", "unresolved", "error", "not_checked" ] }, "in": "query", "name": "dnsStatus", "required": false }, { "schema": { "type": "string", "enum": [ "reachable", "unreachable", "blocked", "not_checked" ] }, "in": "query", "name": "webStatus", "required": false }, { "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "in": "query", "name": "source", "required": false }, { "schema": { "type": "string", "minLength": 1, "maxLength": 1024 }, "in": "query", "name": "labels", "required": false }, { "schema": { "type": "string", "enum": [ "true", "false" ] }, "in": "query", "name": "offensiveAuthorized", "required": false }, { "schema": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "in": "query", "name": "page", "required": false }, { "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string", "minLength": 1, "maxLength": 253 }, "in": "query", "name": "apexDomain", "required": false }, { "schema": { "type": "string" }, "in": "path", "name": "orgSlug", "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "integer", "minimum": 0, "exclusiveMinimum": true, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 0, "exclusiveMinimum": true, "maximum": 9007199254740991 }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalPages": { "type": "integer", "minimum": 0, "exclusiveMinimum": true, "maximum": 9007199254740991 }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "fqdn": { "type": "string" }, "apexDomain": { "type": "string" }, "lifecycleStatus": { "type": "string", "enum": [ "current", "stale", "historical" ] }, "dnsStatus": { "type": "string", "enum": [ "resolved", "unresolved", "error", "not_checked" ] }, "webStatus": { "type": "string", "enum": [ "reachable", "unreachable", "blocked", "not_checked" ] }, "addresses": { "type": "array", "items": { "type": "string" } }, "cname": { "nullable": true, "type": "string" }, "preferredUrl": { "nullable": true, "type": "string" }, "httpStatus": { "nullable": true, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "redirectUrl": { "nullable": true, "type": "string" }, "title": { "nullable": true, "type": "string" }, "tlsNotAfter": { "nullable": true, "type": "string" }, "firstDiscoveredAt": { "type": "string" }, "lastDiscoveredAt": { "type": "string" }, "lastCheckedAt": { "type": "string" }, "lastResolvedAt": { "nullable": true, "type": "string" }, "lastHttpSeenAt": { "nullable": true, "type": "string" }, "staleSince": { "nullable": true, "type": "string" }, "sources": { "type": "array", "items": { "type": "string" } }, "environment": { "nullable": true, "type": "string", "enum": [ "production", "staging" ] }, "environmentSource": { "nullable": true, "type": "string", "enum": [ "override", "hostname", "aws_account", "sibling", "target_tag", "heroku_pipeline" ] }, "environmentAuto": { "nullable": true, "type": "string", "enum": [ "production", "staging" ] }, "environmentOverride": { "nullable": true, "type": "string", "enum": [ "production", "staging", "unlabeled" ] }, "labels": { "type": "array", "items": { "type": "string" } }, "offensiveAuthorizedAt": { "nullable": true, "type": "string" }, "offensiveAuthorizedBy": { "nullable": true, "type": "string" }, "offensiveCoversDescendants": { "type": "boolean" }, "offensiveAuthorizationInheritedFrom": { "nullable": true, "type": "string" } }, "required": [ "id", "fqdn", "apexDomain", "lifecycleStatus", "dnsStatus", "webStatus", "addresses", "cname", "preferredUrl", "httpStatus", "redirectUrl", "title", "tlsNotAfter", "firstDiscoveredAt", "lastDiscoveredAt", "lastCheckedAt", "lastResolvedAt", "lastHttpSeenAt", "staleSince", "sources", "environment", "environmentSource", "environmentAuto", "environmentOverride", "labels", "offensiveAuthorizedAt", "offensiveAuthorizedBy", "offensiveCoversDescendants", "offensiveAuthorizationInheritedFrom" ], "additionalProperties": false } } }, "required": [ "page", "limit", "total", "totalPages", "items" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpError" } } } } } } }, "/api/v1/orgs/{orgSlug}/scans": { "get": { "operationId": "apiListOrgScans", "summary": "List scan runs", "tags": [ "scans" ], "description": "List scan runs for the org", "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "status", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "provider", "required": false }, { "schema": { "default": 50, "type": "integer", "minimum": 0, "exclusiveMinimum": true, "maximum": 50 }, "in": "query", "name": "limit", "required": false }, { "schema": { "default": 0, "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "in": "query", "name": "offset", "required": false }, { "schema": { "type": "string" }, "in": "path", "name": "orgSlug", "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "scans": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "cloudAccountId": { "nullable": true, "type": "string" }, "accountAlias": { "nullable": true, "type": "string" }, "provider": { "nullable": true, "type": "string" }, "status": { "type": "string" }, "startedAt": { "type": "string" }, "completedAt": { "nullable": true, "type": "string" }, "nodeCount": { "nullable": true, "type": "number" }, "edgeCount": { "nullable": true, "type": "number" }, "nodeCountDelta": { "nullable": true, "type": "number" }, "edgeCountDelta": { "nullable": true, "type": "number" }, "errorMessage": { "nullable": true, "type": "string" }, "errorKind": { "nullable": true, "type": "string" }, "workflowId": { "nullable": true, "type": "string" }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "scanner": { "type": "string" }, "message": { "type": "string" }, "code": { "type": "string" }, "resourceFamily": { "type": "string" }, "workItemId": { "type": "string" }, "requiredScope": { "type": "string" } }, "required": [ "scanner", "message" ], "additionalProperties": false } } }, "required": [ "id", "cloudAccountId", "accountAlias", "provider", "status", "startedAt", "completedAt", "nodeCount", "edgeCount", "nodeCountDelta", "edgeCountDelta", "errorMessage", "errorKind", "workflowId", "warnings" ], "additionalProperties": false } }, "total": { "type": "number" } }, "required": [ "scans", "total" ], "additionalProperties": false } } } }, "412": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpError" } } } } } } }, "/api/v1/orgs/{orgSlug}/activity-feed/events": { "get": { "operationId": "apiListOrgActivityFeedEvents", "summary": "List activity events", "tags": [ "activity-feed" ], "description": "Cursor-paginated Mission Control activity events. Filters are applied before the page limit; follow nextCursor until null.", "parameters": [ { "schema": { "type": "integer", "minimum": 0, "exclusiveMinimum": true, "maximum": 90 }, "in": "query", "name": "sinceDays", "required": false }, { "schema": { "type": "string", "format": "date-time" }, "in": "query", "name": "from", "required": false }, { "schema": { "type": "string", "format": "date-time" }, "in": "query", "name": "to", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "types", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "statuses", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "agents", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "providers", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "names", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "attachments", "required": false }, { "schema": { "type": "string", "enum": [ "important", "assessment", "notable", "all" ] }, "in": "query", "name": "view", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "showNoAgents", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "hideNoFindings", "required": false }, { "schema": { "type": "string", "maxLength": 512 }, "in": "query", "name": "cursor", "required": false }, { "schema": { "default": 50, "type": "integer", "minimum": 0, "exclusiveMinimum": true, "maximum": 100 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string" }, "in": "path", "name": "orgSlug", "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "events": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "timestamp": { "type": "string" }, "eventName": { "type": "string" }, "category": { "type": "string", "enum": [ "alert", "new_finding", "pull_request", "ci_pipeline", "code_change", "integration", "agent_run", "graph_ingest", "monitoring", "supply_chain", "compute", "datastore", "network", "identity", "secret", "resource", "finding", "pipeline", "unknown" ] }, "type": { "type": "string", "enum": [ "Alert", "New Finding", "Vulnerability", "Code Change", "CI", "Compute", "Datastore", "Network", "Identity", "Secret", "Resource", "Integration Account", "Unknown" ] }, "description": { "type": "string" }, "provider": { "nullable": true, "type": "string" }, "agents": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "slug": { "type": "string" }, "label": { "type": "string" }, "variant": { "nullable": true, "type": "string" }, "variantLabel": { "nullable": true, "type": "string" } }, "required": [ "key", "slug", "label", "variant", "variantLabel" ], "additionalProperties": false } }, "findings": { "type": "object", "properties": { "total": { "type": "number" }, "statuses": { "type": "object", "properties": { "open": { "type": "number" }, "in-progress": { "type": "number" }, "resolved": { "type": "number" }, "dismissed": { "type": "number" } }, "additionalProperties": false } }, "required": [ "total", "statuses" ], "additionalProperties": false }, "findingItems": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "severity": { "type": "string" }, "status": { "type": "string" }, "verificationRun": { "nullable": true, "type": "object", "properties": { "runId": { "type": "string" }, "status": { "type": "string" } }, "required": [ "runId", "status" ], "additionalProperties": false } }, "required": [ "id", "title", "severity", "status", "verificationRun" ], "additionalProperties": false } }, "agentOutputIds": { "type": "array", "items": { "type": "string" } }, "groupCount": { "type": "number" }, "relevance": { "nullable": true, "type": "string", "enum": [ "needs_assessment", "notable", "audit" ] }, "relevanceReason": { "nullable": true, "type": "string" }, "assessmentState": { "nullable": true, "type": "string", "enum": [ "uncovered", "queued", "running", "clean", "finding", "failed", "debounced" ] } }, "required": [ "id", "timestamp", "eventName", "category", "type", "description", "provider", "agents", "findings", "findingItems", "agentOutputIds", "groupCount", "relevance", "relevanceReason", "assessmentState" ], "additionalProperties": false } }, "nextCursor": { "nullable": true, "type": "string" } }, "required": [ "events", "nextCursor" ], "additionalProperties": false } } } }, "412": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpError" } } } } } } }, "/api/v1/orgs/{orgSlug}/resource-graph/subgraph": { "get": { "operationId": "apiGetResourceGraphSubgraph", "summary": "Get a resource subgraph", "tags": [ "resource-graph" ], "description": "Get a subgraph filtered by provider/service/resourceType", "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "provider", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "service", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "resourceType", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "labels", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "excludeLabels", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "search", "required": false }, { "schema": { "type": "integer", "minimum": 1, "maximum": 50000 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "in": "query", "name": "offset", "required": false }, { "schema": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "in": "query", "name": "timeFrom", "required": false }, { "schema": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "in": "query", "name": "timeTo", "required": false }, { "schema": { "type": "boolean" }, "in": "query", "name": "fullProjection", "required": false }, { "schema": { "type": "string" }, "in": "path", "name": "orgSlug", "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "nodes": { "type": "array", "items": { "type": "object", "properties": { "resourceKey": { "type": "string" }, "provider": { "type": "string" }, "service": { "type": "string" }, "resourceType": { "type": "string" }, "region": { "type": "string" }, "accountId": { "type": "string" }, "labels": { "type": "array", "items": { "type": "string" } }, "props": { "type": "object", "additionalProperties": {} }, "firstSeenAt": { "type": "number" }, "lastSeenAt": { "type": "number" } }, "required": [ "resourceKey", "provider", "service", "resourceType", "labels", "props" ], "additionalProperties": false } }, "edges": { "type": "array", "items": { "type": "object", "properties": { "sourceKey": { "type": "string" }, "targetKey": { "type": "string" }, "type": { "type": "string" }, "props": { "type": "object", "additionalProperties": {} }, "firstSeenAt": { "type": "number" }, "lastSeenAt": { "type": "number" } }, "required": [ "sourceKey", "targetKey", "type", "props" ], "additionalProperties": false } }, "metadata": { "type": "object", "properties": { "executionTime": { "type": "number" }, "nodeCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "edgeCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "executionTime", "nodeCount", "edgeCount" ], "additionalProperties": false } }, "required": [ "nodes", "edges", "metadata" ], "additionalProperties": false } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpError" } } } } } } } } }