{ "openapi": "3.1.0", "info": { "title": "Sentrint Developer API", "description": "Account-owned security scans. Create a scoped API key on the dashboard API page and send it as a Bearer credential. HTTPS is required in production. All IDs and queries are restricted to the key owner's account.", "version": "1.0.0" }, "paths": { "/api/v1/scans/{scan_id}/deletion-requests": { "post": { "tags": [ "developer-api" ], "summary": "Request Deletion", "operationId": "request_deletion_api_v1_scans__scan_id__deletion_requests_post", "parameters": [ { "name": "scan_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Scan Id" } } ], "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApprovalOut" } } } }, "422": { "description": "Invalid request, filter, date range or pagination cursor.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "400": { "description": "Repository exceeds the configured size or scannable file limit.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Missing, malformed, expired or revoked API key.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing scope, current terms, workspace permission or owner deletion approval.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource missing or unavailable to this account.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Scan or approval state conflicts with this operation.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "413": { "description": "Request body exceeds 16 KiB.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit or scan quota exceeded. Retry-After accompanies rate limits.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "Retry-After": { "description": "Seconds until a rate window permits another request. Quota errors may omit it.", "schema": { "type": "integer", "minimum": 1 } } } }, "503": { "description": "Authentication/rate infrastructure or repository access is unavailable.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Unexpected server error. Keep the request ID for support.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-required-scopes": [ "scans:delete" ], "security": [ { "ApiKeyBearer": [] } ] } }, "/api/v1/deletion-requests/{request_id}": { "get": { "tags": [ "developer-api" ], "summary": "Deletion Status", "operationId": "deletion_status_api_v1_deletion_requests__request_id__get", "parameters": [ { "name": "request_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Request Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApprovalOut" } } } }, "422": { "description": "Invalid request, filter, date range or pagination cursor.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "400": { "description": "Repository exceeds the configured size or scannable file limit.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Missing, malformed, expired or revoked API key.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing scope, current terms, workspace permission or owner deletion approval.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource missing or unavailable to this account.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Scan or approval state conflicts with this operation.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "413": { "description": "Request body exceeds 16 KiB.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit or scan quota exceeded. Retry-After accompanies rate limits.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "Retry-After": { "description": "Seconds until a rate window permits another request. Quota errors may omit it.", "schema": { "type": "integer", "minimum": 1 } } } }, "503": { "description": "Authentication/rate infrastructure or repository access is unavailable.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Unexpected server error. Keep the request ID for support.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-required-scopes": [ "scans:delete" ], "security": [ { "ApiKeyBearer": [] } ] } }, "/api/v1/scans/{scan_id}": { "delete": { "tags": [ "developer-api" ], "summary": "Delete Scan", "operationId": "delete_scan_api_v1_scans__scan_id__delete", "parameters": [ { "name": "scan_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Scan Id" } }, { "name": "X-Deletion-Approval", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "X-Deletion-Approval" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Invalid request, filter, date range or pagination cursor.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "400": { "description": "Repository exceeds the configured size or scannable file limit.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Missing, malformed, expired or revoked API key.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing scope, current terms, workspace permission or owner deletion approval.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource missing or unavailable to this account.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Scan or approval state conflicts with this operation.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "413": { "description": "Request body exceeds 16 KiB.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit or scan quota exceeded. Retry-After accompanies rate limits.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "Retry-After": { "description": "Seconds until a rate window permits another request. Quota errors may omit it.", "schema": { "type": "integer", "minimum": 1 } } } }, "503": { "description": "Authentication/rate infrastructure or repository access is unavailable.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Unexpected server error. Keep the request ID for support.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-required-scopes": [ "scans:delete" ], "security": [ { "ApiKeyBearer": [] } ] }, "get": { "tags": [ "developer-api" ], "summary": "Scan Status", "operationId": "scan_status_api_v1_scans__scan_id__get", "parameters": [ { "name": "scan_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Scan Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScanOut" } } } }, "422": { "description": "Invalid request, filter, date range or pagination cursor.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "400": { "description": "Repository exceeds the configured size or scannable file limit.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Missing, malformed, expired or revoked API key.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing scope, current terms, workspace permission or owner deletion approval.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource missing or unavailable to this account.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Scan or approval state conflicts with this operation.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "413": { "description": "Request body exceeds 16 KiB.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit or scan quota exceeded. Retry-After accompanies rate limits.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "Retry-After": { "description": "Seconds until a rate window permits another request. Quota errors may omit it.", "schema": { "type": "integer", "minimum": 1 } } } }, "503": { "description": "Authentication/rate infrastructure or repository access is unavailable.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Unexpected server error. Keep the request ID for support.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-required-scopes": [ "scans:read" ], "security": [ { "ApiKeyBearer": [] } ] } }, "/api/v1/account": { "get": { "tags": [ "developer-api" ], "summary": "Account Summary", "operationId": "account_summary_api_v1_account_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountOut" } } } }, "400": { "description": "Repository exceeds the configured size or scannable file limit.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Missing, malformed, expired or revoked API key.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing scope, current terms, workspace permission or owner deletion approval.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource missing or unavailable to this account.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Scan or approval state conflicts with this operation.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "413": { "description": "Request body exceeds 16 KiB.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Invalid request, filter, date range or pagination cursor.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit or scan quota exceeded. Retry-After accompanies rate limits.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "Retry-After": { "description": "Seconds until a rate window permits another request. Quota errors may omit it.", "schema": { "type": "integer", "minimum": 1 } } } }, "503": { "description": "Authentication/rate infrastructure or repository access is unavailable.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Unexpected server error. Keep the request ID for support.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-required-scopes": [ "account:read" ], "security": [ { "ApiKeyBearer": [] } ] } }, "/api/v1/workspaces": { "get": { "tags": [ "developer-api" ], "summary": "List Workspaces", "operationId": "list_workspaces_api_v1_workspaces_get", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 25, "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_WorkspaceOut_" } } } }, "422": { "description": "Invalid request, filter, date range or pagination cursor.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "400": { "description": "Repository exceeds the configured size or scannable file limit.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Missing, malformed, expired or revoked API key.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing scope, current terms, workspace permission or owner deletion approval.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource missing or unavailable to this account.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Scan or approval state conflicts with this operation.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "413": { "description": "Request body exceeds 16 KiB.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit or scan quota exceeded. Retry-After accompanies rate limits.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "Retry-After": { "description": "Seconds until a rate window permits another request. Quota errors may omit it.", "schema": { "type": "integer", "minimum": 1 } } } }, "503": { "description": "Authentication/rate infrastructure or repository access is unavailable.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Unexpected server error. Keep the request ID for support.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-required-scopes": [ "workspaces:read" ], "security": [ { "ApiKeyBearer": [] } ] } }, "/api/v1/workspaces/{workspace_id}": { "get": { "tags": [ "developer-api" ], "summary": "Workspace Detail", "operationId": "workspace_detail_api_v1_workspaces__workspace_id__get", "parameters": [ { "name": "workspace_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Workspace Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceDetailOut" } } } }, "422": { "description": "Invalid request, filter, date range or pagination cursor.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "400": { "description": "Repository exceeds the configured size or scannable file limit.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Missing, malformed, expired or revoked API key.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing scope, current terms, workspace permission or owner deletion approval.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource missing or unavailable to this account.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Scan or approval state conflicts with this operation.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "413": { "description": "Request body exceeds 16 KiB.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit or scan quota exceeded. Retry-After accompanies rate limits.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "Retry-After": { "description": "Seconds until a rate window permits another request. Quota errors may omit it.", "schema": { "type": "integer", "minimum": 1 } } } }, "503": { "description": "Authentication/rate infrastructure or repository access is unavailable.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Unexpected server error. Keep the request ID for support.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-required-scopes": [ "workspaces:read" ], "security": [ { "ApiKeyBearer": [] } ] } }, "/api/v1/workspaces/{workspace_id}/scans": { "post": { "tags": [ "developer-api" ], "summary": "Submit Scan", "operationId": "submit_scan_api_v1_workspaces__workspace_id__scans_post", "parameters": [ { "name": "workspace_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Workspace Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScanRequest" } } } }, "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScanQueued" } } } }, "422": { "description": "Invalid request, filter, date range or pagination cursor.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "400": { "description": "Repository exceeds the configured size or scannable file limit.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Missing, malformed, expired or revoked API key.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing scope, current terms, workspace permission or owner deletion approval.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource missing or unavailable to this account.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Scan or approval state conflicts with this operation.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "413": { "description": "Request body exceeds 16 KiB.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit or scan quota exceeded. Retry-After accompanies rate limits.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "Retry-After": { "description": "Seconds until a rate window permits another request. Quota errors may omit it.", "schema": { "type": "integer", "minimum": 1 } } } }, "503": { "description": "Authentication/rate infrastructure or repository access is unavailable.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Unexpected server error. Keep the request ID for support.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-required-scopes": [ "scans:create" ], "security": [ { "ApiKeyBearer": [] } ] }, "get": { "tags": [ "developer-api" ], "summary": "List Scans", "operationId": "list_scans_api_v1_workspaces__workspace_id__scans_get", "parameters": [ { "name": "workspace_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Workspace Id" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 25, "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_ScanOut_" } } } }, "422": { "description": "Invalid request, filter, date range or pagination cursor.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "400": { "description": "Repository exceeds the configured size or scannable file limit.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Missing, malformed, expired or revoked API key.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing scope, current terms, workspace permission or owner deletion approval.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource missing or unavailable to this account.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Scan or approval state conflicts with this operation.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "413": { "description": "Request body exceeds 16 KiB.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit or scan quota exceeded. Retry-After accompanies rate limits.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "Retry-After": { "description": "Seconds until a rate window permits another request. Quota errors may omit it.", "schema": { "type": "integer", "minimum": 1 } } } }, "503": { "description": "Authentication/rate infrastructure or repository access is unavailable.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Unexpected server error. Keep the request ID for support.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-required-scopes": [ "scans:read" ], "security": [ { "ApiKeyBearer": [] } ] } }, "/api/v1/scans/{scan_id}/report": { "get": { "tags": [ "developer-api" ], "summary": "Scan Report", "operationId": "scan_report_api_v1_scans__scan_id__report_get", "parameters": [ { "name": "scan_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Scan Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportOut" } } } }, "422": { "description": "Invalid request, filter, date range or pagination cursor.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "400": { "description": "Repository exceeds the configured size or scannable file limit.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Missing, malformed, expired or revoked API key.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing scope, current terms, workspace permission or owner deletion approval.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource missing or unavailable to this account.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Scan or approval state conflicts with this operation.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "413": { "description": "Request body exceeds 16 KiB.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit or scan quota exceeded. Retry-After accompanies rate limits.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "Retry-After": { "description": "Seconds until a rate window permits another request. Quota errors may omit it.", "schema": { "type": "integer", "minimum": 1 } } } }, "503": { "description": "Authentication/rate infrastructure or repository access is unavailable.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Unexpected server error. Keep the request ID for support.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-required-scopes": [ "scans:read" ], "security": [ { "ApiKeyBearer": [] } ] } }, "/api/v1/workspaces/{workspace_id}/submissions": { "post": { "tags": [ "developer-api" ], "summary": "Submit Async", "operationId": "submit_async_api_v1_workspaces__workspace_id__submissions_post", "parameters": [ { "name": "workspace_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Workspace Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "example": "submission-request-001", "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScanRequest" } } } }, "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmissionOut" } } } }, "422": { "description": "Invalid request, filter, date range or pagination cursor.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "400": { "description": "Repository exceeds the configured size or scannable file limit.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Missing, malformed, expired or revoked API key.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing scope, current terms, workspace permission or owner deletion approval.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource missing or unavailable to this account.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Scan or approval state conflicts with this operation.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "413": { "description": "Request body exceeds 16 KiB.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit or scan quota exceeded. Retry-After accompanies rate limits.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "Retry-After": { "description": "Seconds until a rate window permits another request. Quota errors may omit it.", "schema": { "type": "integer", "minimum": 1 } } } }, "503": { "description": "Authentication/rate infrastructure or repository access is unavailable.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Unexpected server error. Keep the request ID for support.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-required-scopes": [ "scans:create" ], "security": [ { "ApiKeyBearer": [] } ] } }, "/api/v1/submissions/{submission_id}": { "get": { "tags": [ "developer-api" ], "summary": "Submission Status", "operationId": "submission_status_api_v1_submissions__submission_id__get", "parameters": [ { "name": "submission_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Submission Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmissionOut" } } } }, "422": { "description": "Invalid request, filter, date range or pagination cursor.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "400": { "description": "Repository exceeds the configured size or scannable file limit.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Missing, malformed, expired or revoked API key.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing scope, current terms, workspace permission or owner deletion approval.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource missing or unavailable to this account.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Scan or approval state conflicts with this operation.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "413": { "description": "Request body exceeds 16 KiB.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit or scan quota exceeded. Retry-After accompanies rate limits.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "Retry-After": { "description": "Seconds until a rate window permits another request. Quota errors may omit it.", "schema": { "type": "integer", "minimum": 1 } } } }, "503": { "description": "Authentication/rate infrastructure or repository access is unavailable.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Unexpected server error. Keep the request ID for support.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-required-scopes": [ "scans:read" ], "security": [ { "ApiKeyBearer": [] } ] } }, "/api/v1/findings": { "get": { "tags": [ "developer-api" ], "summary": "List Findings", "operationId": "list_findings_api_v1_findings_get", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "scan_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Scan Id" } }, { "name": "severity", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Severity", "enum": [ "CRITICAL", "HIGH", "LOW", "MEDIUM" ] } }, { "name": "category", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category", "enum": [ "code", "dependency", "secret" ] } }, { "name": "rule_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ], "title": "Rule Id" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status", "enum": [ "fixed", "ignored", "in_progress", "open" ] } }, { "name": "verification_state", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Verification State", "enum": [ "ai_reviewed", "corroborated", "detected", "disproved", "runtime_confirmed" ] } }, { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 120 }, { "type": "null" } ], "title": "Q" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 25, "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_FindingOut_" } } } }, "422": { "description": "Invalid request, filter, date range or pagination cursor.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "400": { "description": "Repository exceeds the configured size or scannable file limit.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Missing, malformed, expired or revoked API key.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing scope, current terms, workspace permission or owner deletion approval.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource missing or unavailable to this account.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Scan or approval state conflicts with this operation.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "413": { "description": "Request body exceeds 16 KiB.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit or scan quota exceeded. Retry-After accompanies rate limits.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "Retry-After": { "description": "Seconds until a rate window permits another request. Quota errors may omit it.", "schema": { "type": "integer", "minimum": 1 } } } }, "503": { "description": "Authentication/rate infrastructure or repository access is unavailable.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Unexpected server error. Keep the request ID for support.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-required-scopes": [ "findings:read" ], "security": [ { "ApiKeyBearer": [] } ] } }, "/api/v1/findings/{finding_id}": { "get": { "tags": [ "developer-api" ], "summary": "Finding Detail", "operationId": "finding_detail_api_v1_findings__finding_id__get", "parameters": [ { "name": "finding_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Finding Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FindingDetailOut" } } } }, "422": { "description": "Invalid request, filter, date range or pagination cursor.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "400": { "description": "Repository exceeds the configured size or scannable file limit.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Missing, malformed, expired or revoked API key.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing scope, current terms, workspace permission or owner deletion approval.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource missing or unavailable to this account.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Scan or approval state conflicts with this operation.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "413": { "description": "Request body exceeds 16 KiB.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit or scan quota exceeded. Retry-After accompanies rate limits.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "Retry-After": { "description": "Seconds until a rate window permits another request. Quota errors may omit it.", "schema": { "type": "integer", "minimum": 1 } } } }, "503": { "description": "Authentication/rate infrastructure or repository access is unavailable.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Unexpected server error. Keep the request ID for support.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-required-scopes": [ "findings:read" ], "security": [ { "ApiKeyBearer": [] } ] } }, "/api/v1/audit-events": { "get": { "tags": [ "developer-api" ], "summary": "List Audit Events", "operationId": "list_audit_events_api_v1_audit_events_get", "parameters": [ { "name": "from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "From" } }, { "name": "to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "To" } }, { "name": "category", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category", "enum": [ "account", "billing", "mcp", "repo", "scan", "workspace" ] } }, { "name": "action", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 48 }, { "type": "null" } ], "title": "Action" } }, { "name": "source", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source", "enum": [ "account", "audit", "payment", "plan", "scan_log", "workspace" ] } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 25, "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_AuditOut_" } } } }, "422": { "description": "Invalid request, filter, date range or pagination cursor.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "400": { "description": "Repository exceeds the configured size or scannable file limit.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Missing, malformed, expired or revoked API key.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing scope, current terms, workspace permission or owner deletion approval.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource missing or unavailable to this account.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Scan or approval state conflicts with this operation.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "413": { "description": "Request body exceeds 16 KiB.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit or scan quota exceeded. Retry-After accompanies rate limits.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "Retry-After": { "description": "Seconds until a rate window permits another request. Quota errors may omit it.", "schema": { "type": "integer", "minimum": 1 } } } }, "503": { "description": "Authentication/rate infrastructure or repository access is unavailable.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Unexpected server error. Keep the request ID for support.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-required-scopes": [ "audit:read" ], "security": [ { "ApiKeyBearer": [] } ] } } }, "components": { "schemas": { "AccountOut": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "login": { "type": "string", "title": "Login" }, "plan": { "type": "string", "title": "Plan" }, "included_scans_remaining": { "type": "integer", "title": "Included Scans Remaining" }, "scan_credits": { "type": "integer", "title": "Scan Credits" }, "scans_used_in_period": { "type": "integer", "title": "Scans Used In Period" }, "scan_limit_in_period": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Scan Limit In Period" }, "period": { "type": "string", "title": "Period" } }, "type": "object", "required": [ "id", "login", "plan", "included_scans_remaining", "scan_credits", "scans_used_in_period", "scan_limit_in_period", "period" ], "title": "AccountOut" }, "ApprovalOut": { "properties": { "request_id": { "type": "string", "format": "uuid", "title": "Request Id" }, "scan_id": { "type": "string", "format": "uuid", "title": "Scan Id" }, "status": { "type": "string", "title": "Status" }, "expires_at": { "type": "string", "format": "date-time", "title": "Expires At" }, "approval_url": { "type": "string", "title": "Approval Url" } }, "type": "object", "required": [ "request_id", "scan_id", "status", "expires_at", "approval_url" ], "title": "ApprovalOut", "example": { "request_id": "00000000-0000-4000-8000-000000000001", "scan_id": "00000000-0000-4000-8000-000000000001", "status": "pending", "expires_at": "2026-09-30T12:10:00Z", "approval_url": "https://sentrint.com/dashboard/api/deletion-approvals/00000000-0000-4000-8000-000000000001" } }, "AuditOut": { "properties": { "id": { "type": "string", "title": "Id" }, "at": { "type": "string", "format": "date-time", "title": "At" }, "source": { "type": "string", "title": "Source" }, "category": { "type": "string", "title": "Category" }, "action": { "type": "string", "title": "Action" }, "label": { "type": "string", "title": "Label" }, "target": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target" }, "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Detail" } }, "type": "object", "required": [ "id", "at", "source", "category", "action", "label", "target", "detail" ], "title": "AuditOut" }, "EvidenceOut": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "origin": { "type": "string", "title": "Origin" }, "kind": { "type": "string", "title": "Kind" }, "producer": { "type": "string", "title": "Producer" }, "payload": { "additionalProperties": true, "type": "object", "title": "Payload" } }, "type": "object", "required": [ "id", "origin", "kind", "producer", "payload" ], "title": "EvidenceOut" }, "FindingDetailOut": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "scan_id": { "type": "string", "format": "uuid", "title": "Scan Id" }, "rule_id": { "type": "string", "title": "Rule Id" }, "file_path": { "type": "string", "title": "File Path" }, "line": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Line" }, "severity": { "type": "string", "title": "Severity" }, "category": { "type": "string", "title": "Category" }, "message": { "type": "string", "title": "Message" }, "status": { "type": "string", "title": "Status" }, "verification_state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Verification State" }, "suggestion": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Suggestion" }, "snippet": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Snippet" }, "evidence": { "items": { "$ref": "#/components/schemas/EvidenceOut" }, "type": "array", "title": "Evidence" }, "guidance_locked": { "type": "boolean", "title": "Guidance Locked" } }, "type": "object", "required": [ "id", "scan_id", "rule_id", "file_path", "line", "severity", "category", "message", "status", "verification_state", "suggestion", "snippet", "guidance_locked" ], "title": "FindingDetailOut" }, "FindingOut": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "scan_id": { "type": "string", "format": "uuid", "title": "Scan Id" }, "rule_id": { "type": "string", "title": "Rule Id" }, "file_path": { "type": "string", "title": "File Path" }, "line": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Line" }, "severity": { "type": "string", "title": "Severity" }, "category": { "type": "string", "title": "Category" }, "message": { "type": "string", "title": "Message" }, "status": { "type": "string", "title": "Status" }, "verification_state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Verification State" } }, "type": "object", "required": [ "id", "scan_id", "rule_id", "file_path", "line", "severity", "category", "message", "status", "verification_state" ], "title": "FindingOut" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "Page_AuditOut_": { "properties": { "data": { "items": { "$ref": "#/components/schemas/AuditOut" }, "type": "array", "title": "Data" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "type": "object", "required": [ "data" ], "title": "Page[AuditOut]" }, "Page_FindingOut_": { "properties": { "data": { "items": { "$ref": "#/components/schemas/FindingOut" }, "type": "array", "title": "Data" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "type": "object", "required": [ "data" ], "title": "Page[FindingOut]" }, "Page_ScanOut_": { "properties": { "data": { "items": { "$ref": "#/components/schemas/ScanOut" }, "type": "array", "title": "Data" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "type": "object", "required": [ "data" ], "title": "Page[ScanOut]" }, "Page_WorkspaceOut_": { "properties": { "data": { "items": { "$ref": "#/components/schemas/WorkspaceOut" }, "type": "array", "title": "Data" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "type": "object", "required": [ "data" ], "title": "Page[WorkspaceOut]" }, "ReportOut": { "properties": { "scan_id": { "type": "string", "format": "uuid", "title": "Scan Id" }, "score": { "type": "integer", "title": "Score" }, "grade": { "type": "string", "title": "Grade" }, "critical": { "type": "integer", "title": "Critical" }, "high": { "type": "integer", "title": "High" }, "medium": { "type": "integer", "title": "Medium" }, "low": { "type": "integer", "title": "Low" }, "top_rules": { "items": { "type": "string" }, "type": "array", "title": "Top Rules" }, "summary_text": { "type": "string", "title": "Summary Text" }, "guidance_locked": { "type": "boolean", "title": "Guidance Locked" } }, "type": "object", "required": [ "scan_id", "score", "grade", "critical", "high", "medium", "low", "top_rules", "summary_text", "guidance_locked" ], "title": "ReportOut" }, "RepositoryOut": { "properties": { "full_name": { "type": "string", "title": "Full Name" }, "repo_url": { "type": "string", "title": "Repo Url" } }, "type": "object", "required": [ "full_name", "repo_url" ], "title": "RepositoryOut" }, "ScanOut": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "workspace_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Workspace Id" }, "status": { "type": "string", "title": "Status" }, "repo_url": { "type": "string", "title": "Repo Url" }, "commit_sha": { "type": "string", "title": "Commit Sha" }, "score": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Score" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" } }, "type": "object", "required": [ "id", "workspace_id", "status", "repo_url", "commit_sha", "score", "created_at", "updated_at" ], "title": "ScanOut" }, "ScanQueued": { "properties": { "scan_id": { "type": "string", "format": "uuid", "title": "Scan Id" }, "status": { "type": "string", "title": "Status" }, "status_url": { "type": "string", "title": "Status Url" }, "reused": { "type": "boolean", "title": "Reused" } }, "type": "object", "required": [ "scan_id", "status", "status_url", "reused" ], "title": "ScanQueued", "example": { "scan_id": "00000000-0000-4000-8000-000000000001", "status": "pending", "status_url": "/api/v1/scans/00000000-0000-4000-8000-000000000001", "reused": false } }, "ScanRequest": { "properties": { "repo_url": { "type": "string", "maxLength": 512, "title": "Repo Url" }, "branch": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ], "title": "Branch" }, "force": { "type": "boolean", "title": "Force", "default": false }, "commit_sha": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{40}$" }, { "type": "null" } ], "title": "Commit Sha" } }, "additionalProperties": false, "type": "object", "required": [ "repo_url" ], "title": "ScanRequest", "example": { "repo_url": "https://github.com/your-org/your-repo", "branch": "main", "force": false } }, "SubmissionOut": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "status": { "type": "string", "enum": [ "accepted", "validating", "failed", "scan_ready" ], "title": "Status" }, "status_url": { "type": "string", "title": "Status Url" }, "scan_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Scan Id" }, "scan_status_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scan Status Url" }, "reused": { "type": "boolean", "title": "Reused" }, "error_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Code" }, "error_detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Detail" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" } }, "type": "object", "required": [ "id", "status", "status_url", "scan_id", "scan_status_url", "reused", "error_code", "error_detail", "created_at", "updated_at" ], "title": "SubmissionOut" }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" }, "input": { "title": "Input" }, "ctx": { "type": "object", "title": "Context" } }, "type": "object", "required": [ "loc", "msg", "type" ], "title": "ValidationError" }, "WorkspaceDetailOut": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "tracked_repository_count": { "type": "integer", "title": "Tracked Repository Count" }, "repositories": { "items": { "$ref": "#/components/schemas/RepositoryOut" }, "type": "array", "title": "Repositories" }, "repositories_truncated": { "type": "boolean", "title": "Repositories Truncated", "default": false } }, "type": "object", "required": [ "id", "name", "created_at", "tracked_repository_count" ], "title": "WorkspaceDetailOut" }, "WorkspaceOut": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" } }, "type": "object", "required": [ "id", "name", "created_at" ], "title": "WorkspaceOut" }, "Problem": { "type": "object", "required": [ "type", "title", "status", "code", "detail", "request_id" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "request_id": { "type": "string" } }, "example": { "type": "about:blank", "title": "Unauthorized", "status": 401, "code": "invalid_api_key", "detail": "A valid Bearer API key is required.", "request_id": "example-request-id" } } }, "securitySchemes": { "ApiKeyBearer": { "type": "http", "scheme": "bearer", "bearerFormat": "opaque API key", "description": "Send Authorization: Bearer . Keys are shown once on creation from the dashboard API page. x-required-scopes lists each operation's permissions; HTTP Bearer itself has no OAuth scopes." } } }, "servers": [ { "url": "https://sentrint.com", "description": "Sentrint" } ], "x-rate-limits": [ { "key": "api_auth_ip", "label": "Invalid authentication", "identity": "IP address", "requests": 30, "seconds": 60 }, { "key": "api_total", "label": "All authenticated API requests", "identity": "Account, shared by all keys", "requests": 600, "seconds": 600 }, { "key": "api_scan_submit", "label": "Submit a scan", "identity": "API key", "requests": 10, "seconds": 60 }, { "key": "api_scan_status", "label": "Read scan status", "identity": "API key", "requests": 120, "seconds": 60 }, { "key": "api_read", "label": "Other reads, including approval status", "identity": "API key", "requests": 60, "seconds": 60 }, { "key": "api_audit", "label": "Read audit events", "identity": "API key", "requests": 30, "seconds": 60 }, { "key": "api_approval", "label": "Request deletion approval", "identity": "Account and IP address", "requests": 3, "seconds": 900 }, { "key": "api_approval_browser", "label": "Owner approval browser actions", "identity": "Account and IP address", "requests": 5, "seconds": 900 }, { "key": "api_delete", "label": "Delete scan results", "identity": "Account", "requests": 3, "seconds": 3600 }, { "key": "mcp_register_ip", "label": "Register an AI app", "identity": "IP address", "requests": 10, "seconds": 3600 }, { "key": "mcp_token_ip", "label": "AI app sign-in tokens", "identity": "IP address", "requests": 60, "seconds": 60 }, { "key": "mcp_authorize_ip", "label": "AI app sign-in requests", "identity": "IP address", "requests": 60, "seconds": 60 }, { "key": "mcp_revoke_ip", "label": "Revoke AI app tokens", "identity": "IP address", "requests": 60, "seconds": 60 }, { "key": "api_key_create", "label": "Create an API key", "identity": "Browser account, independent action bucket", "requests": 3, "seconds": 300 }, { "key": "api_key_revoke", "label": "Revoke an API key", "identity": "Browser account, independent action bucket", "requests": 20, "seconds": 60 } ] }