{ "openapi": "3.1.0", "info": { "title": "Security.Run atomic API", "description": "Native atomic security tool runs, artifacts and execution evidence.", "version": "0.1.0" }, "paths": { "/v1/tools": { "get": { "summary": "Catalog", "operationId": "catalog_v1_tools_get", "parameters": [ { "name": "query", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 200, "default": "", "title": "Query" } }, { "name": "category", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category" } }, { "name": "include_unavailable", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Include Unavailable" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 20, "title": "Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/tools/{tool_id}": { "get": { "summary": "Inspect Tool", "operationId": "inspect_tool_v1_tools__tool_id__get", "parameters": [ { "name": "tool_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Tool Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/tool-runs": { "post": { "summary": "Submit", "operationId": "submit_v1_tool_runs_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "idempotency-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolRunInput" } } } }, "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/tool-runs/{run_id}": { "get": { "summary": "Get Run", "operationId": "get_run_v1_tool_runs__run_id__get", "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Run Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "summary": "Delete", "operationId": "delete_v1_tool_runs__run_id__delete", "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Run Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "idempotency-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/tool-runs/{run_id}/events": { "get": { "summary": "Events", "operationId": "events_v1_tool_runs__run_id__events_get", "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Run Id" } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "After" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/tool-runs/{run_id}/outputs/{name}": { "get": { "summary": "Output", "operationId": "output_v1_tool_runs__run_id__outputs__name__get", "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Run Id" } }, { "name": "name", "in": "path", "required": true, "schema": { "type": "string", "title": "Name" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/tool-runs/{run_id}/outputs/{name}/chunks": { "get": { "summary": "Output Chunk", "operationId": "output_chunk_v1_tool_runs__run_id__outputs__name__chunks_get", "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Run Id" } }, { "name": "name", "in": "path", "required": true, "schema": { "type": "string", "title": "Name" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } }, { "name": "length", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 65536, "minimum": 1, "default": 16384, "title": "Length" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/tool-runs/{run_id}/cancel": { "post": { "summary": "Cancel", "operationId": "cancel_v1_tool_runs__run_id__cancel_post", "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Run Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "idempotency-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/healthz": { "get": { "summary": "Health", "operationId": "health_healthz_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/v1/artifacts": { "post": { "summary": "Create Artifact", "operationId": "create_artifact_v1_artifacts_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "idempotency-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArtifactInput" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/artifacts/{artifact_id}/content": { "put": { "summary": "Upload", "operationId": "upload_v1_artifacts__artifact_id__content_put", "parameters": [ { "name": "artifact_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Artifact Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "summary": "Download Artifact", "operationId": "download_artifact_v1_artifacts__artifact_id__content_get", "parameters": [ { "name": "artifact_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Artifact Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/artifacts/{artifact_id}/complete": { "post": { "summary": "Complete Artifact", "operationId": "complete_artifact_v1_artifacts__artifact_id__complete_post", "parameters": [ { "name": "artifact_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Artifact Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "idempotency-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/artifacts/{artifact_id}": { "get": { "summary": "Artifact Metadata", "operationId": "artifact_metadata_v1_artifacts__artifact_id__get", "parameters": [ { "name": "artifact_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Artifact Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "summary": "Delete Atomic Artifact", "operationId": "delete_atomic_artifact_v1_artifacts__artifact_id__delete", "parameters": [ { "name": "artifact_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Artifact Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "idempotency-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } } }, "components": { "schemas": { "ArtifactInput": { "properties": { "filename": { "type": "string", "maxLength": 240, "minLength": 1, "pattern": "^[^/\\\\\\x00-\\x1f]+$", "title": "Filename" }, "size": { "type": "integer", "maximum": 67108864.0, "minimum": 1.0, "title": "Size" }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$", "title": "Sha256" }, "retention_seconds": { "type": "integer", "maximum": 7776000.0, "minimum": 3600.0, "title": "Retention Seconds", "default": 604800 } }, "additionalProperties": false, "type": "object", "required": [ "filename", "size", "sha256" ], "title": "ArtifactInput" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "NativeFile": { "properties": { "path": { "type": "string", "title": "Path" }, "artifact_id": { "type": "string", "pattern": "^artifact_[a-f0-9]{32}$", "title": "Artifact Id" }, "executable": { "type": "boolean", "title": "Executable", "default": false } }, "additionalProperties": false, "type": "object", "required": [ "path", "artifact_id" ], "title": "NativeFile" }, "NativeInvocation": { "properties": { "executable": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Executable" }, "args": { "items": { "type": "string" }, "type": "array", "maxItems": 256, "title": "Args" }, "files": { "items": { "$ref": "#/components/schemas/NativeFile" }, "type": "array", "maxItems": 64, "title": "Files" }, "empty_files": { "items": { "type": "string" }, "type": "array", "maxItems": 64, "title": "Empty Files" }, "directories": { "items": { "type": "string" }, "type": "array", "maxItems": 64, "title": "Directories" }, "stdin_artifact_id": { "anyOf": [ { "type": "string", "pattern": "^artifact_[a-f0-9]{32}$" }, { "type": "null" } ], "title": "Stdin Artifact Id" }, "environment": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Environment" }, "working_directory": { "type": "string", "title": "Working Directory", "default": "." }, "outputs": { "items": { "type": "string" }, "type": "array", "maxItems": 64, "title": "Outputs" }, "success_exit_codes": { "items": { "type": "integer" }, "type": "array", "maxItems": 16, "minItems": 1, "title": "Success Exit Codes" } }, "additionalProperties": false, "type": "object", "title": "NativeInvocation" }, "ToolRunInput": { "properties": { "tool": { "type": "string", "title": "Tool", "default": "yara" }, "operation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Operation" }, "version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version" }, "inputs": { "anyOf": [ { "$ref": "#/components/schemas/YaraInputs" }, { "type": "null" } ] }, "invocation": { "anyOf": [ { "$ref": "#/components/schemas/NativeInvocation" }, { "type": "null" } ] }, "timeout_seconds": { "type": "integer", "maximum": 120.0, "minimum": 1.0, "title": "Timeout Seconds", "default": 30 }, "target_profile": { "anyOf": [ { "type": "string", "pattern": "^[a-z0-9][a-z0-9_-]{0,63}$" }, { "type": "null" } ], "title": "Target Profile" } }, "additionalProperties": false, "type": "object", "title": "ToolRunInput" }, "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" }, "YaraInputs": { "properties": { "artifact_id": { "type": "string", "pattern": "^artifact_[a-f0-9]{32}$", "title": "Artifact Id" }, "rules_artifact_id": { "anyOf": [ { "type": "string", "pattern": "^artifact_[a-f0-9]{32}$" }, { "type": "null" } ], "title": "Rules Artifact Id" } }, "additionalProperties": false, "type": "object", "required": [ "artifact_id" ], "title": "YaraInputs" } } } }