{ "components": { "securitySchemes": { "oAuth2": { "type": "oauth2", "description": "This API uses OAuth 2 with the authorizationCode flow.", "flows": { "authorizationCode": { "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "tokenUrl": "https://oauth2.googleapis.com/token", "scopes": {} } } } }, "schemas": { "BaseRequestOptions": { "description": "Base Request Options class to be extended by other option types. ", "properties": { "filter_patterns": { "items": { "type": "string" }, "title": "Filter Patterns", "type": "array" }, "group_id": { "title": "Group Id", "type": "string" }, "jobs_allowlist": { "items": { "type": "string" }, "title": "Jobs Allowlist", "type": "array" }, "jobs_denylist": { "items": { "type": "string" }, "title": "Jobs Denylist", "type": "array" }, "reason": { "title": "Reason", "type": "string" }, "recipe_data": { "title": "Recipe Data", "type": "string" }, "recipe_name": { "title": "Recipe Name", "type": "string" }, "request_id": { "title": "Request Id", "type": "string" }, "requester": { "title": "Requester", "type": "string" }, "sketch_id": { "title": "Sketch Id", "type": "integer" }, "yara_rules": { "title": "Yara Rules", "type": "string" } }, "title": "BaseRequestOptions", "type": "object" }, "Body_upload_evidence_api_evidence_upload_post": { "properties": { "calculate_hash": { "default": false, "title": "Calculate Hash", "type": "boolean" }, "files": { "items": { "format": "binary", "type": "string" }, "title": "Files", "type": "array" }, "ticket_id": { "title": "Ticket Id", "type": "string" } }, "required": [ "ticket_id", "files" ], "title": "Body_upload_evidence_api_evidence_upload_post", "type": "object" }, "CompleteTurbiniaStats": { "description": "Statistics for different groups of tasks.", "properties": { "all_tasks": { "default": {}, "title": "All Tasks", "type": "object" }, "failed_tasks": { "default": {}, "title": "Failed Tasks", "type": "object" }, "requests": { "default": {}, "title": "Requests", "type": "object" }, "successful_tasks": { "default": {}, "title": "Successful Tasks", "type": "object" }, "tasks_per_type": { "default": {}, "title": "Tasks Per Type", "type": "object" }, "tasks_per_user": { "default": {}, "title": "Tasks Per User", "type": "object" }, "tasks_per_worker": { "default": {}, "title": "Tasks Per Worker", "type": "object" } }, "title": "CompleteTurbiniaStats", "type": "object" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "title": "Detail", "type": "array" } }, "title": "HTTPValidationError", "type": "object" }, "Request": { "description": "Base request object. ", "properties": { "description": { "default": "Turbinia request object", "title": "Description", "type": "string" }, "evidence": { "title": "Evidence", "type": "object" }, "request_options": { "$ref": "#/components/schemas/BaseRequestOptions" } }, "required": [ "evidence", "request_options" ], "title": "Request", "type": "object" }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "title": "Location", "type": "array" }, "msg": { "title": "Message", "type": "string" }, "type": { "title": "Error Type", "type": "string" } }, "required": [ "loc", "msg", "type" ], "title": "ValidationError", "type": "object" } } }, "info": { "description": "Turbinia is an open-source framework for deploying, managing, and running distributed forensic workloads", "license": { "name": "Apache License 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, "title": "Turbinia API Server", "version": "1.0.0" }, "openapi": "3.0.2", "paths": { "/api/config/": { "get": { "description": "Retrieve turbinia config.", "operationId": "read_config", "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" } }, "summary": "Read Config", "tags": [ "Turbinia Configuration" ] } }, "/api/config/request_options": { "get": { "description": "Returns a list BaseRequestOptions attributes.", "operationId": "get_request_options", "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" } }, "summary": "Get Request Options", "tags": [ "Turbinia Configuration" ] } }, "/api/config/version": { "get": { "description": "Returns the Turbinia version.", "operationId": "get_version", "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" } }, "summary": "Get Version", "tags": [ "Turbinia Configuration" ] } }, "/api/config/download": { "get": { "description": "Downloads the Turbinia configuration.", "operationId": "download_config", "responses": { "200": { "content": { "application/text": { "schema": { "type": "string" } } }, "description": "Successful Response" } }, "summary": "Download Configuration", "tags": [ "Turbinia Configuration" ] } }, "/api/download/output/{file_path}": { "get": { "description": "Download by path.\n\nRaises:\nHTTPException: if another exception is caught.", "operationId": "download_output_path", "parameters": [ { "in": "path", "name": "file_path", "required": true, "schema": { "title": "File Path", "type": "string" } } ], "responses": { "200": { "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Task Report", "tags": [ "Turbinia Tasks" ] } }, "/api/evidence/download/{evidence_id}": { "get": { "description": "Retrieves an evidence in Redis by using its UUID.\n\nArgs:\n evidence_id (str): The UUID of the evidence.\n\nRaises:\n HTTPException: if the evidence is not found.\n\nReturns:\n FileResponse: The evidence file.", "operationId": "download_by_evidence_id", "parameters": [ { "in": "path", "name": "evidence_id", "required": true, "schema": { "title": "Evidence Id" } } ], "responses": { "200": { "content": { "application/octet-stream": { "schema": { "format": "binary", "type": "string" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Download By Evidence Id", "tags": [ "Turbinia Evidence" ] } }, "/api/evidence/query": { "get": { "description": "Queries evidence in Redis that have the specified attribute value.\n\nArgs:\n attribute_name (str): Name of attribute to be queried.\n attribute_value (str): Value the attribute must have.\n output Optional(str): Sets how the evidence found will be output.\n\nReturns:\n summary (dict): Summary of all evidences and their content.\n\nRaises:\n HTTPException: If no matching evidence is found.", "operationId": "query_evidence", "parameters": [ { "in": "query", "name": "attribute_name", "required": false, "schema": { "default": "request_id", "enum": [ "_name", "cloud_only", "context_dependent", "copyable", "creation_time", "description", "has_child_evidence", "last_update", "local_path", "mount_path", "parent_evidence", "request_id", "resource_id", "resource_tracked", "save_metadata", "saved_path", "saved_path_type", "size", "source", "source_path", "type", "tasks" ], "title": "Attribute Name", "type": "string" } }, { "in": "query", "name": "attribute_value", "required": true, "schema": { "title": "Attribute Value", "type": "string" } }, { "in": "query", "name": "output", "required": false, "schema": { "default": "keys", "enum": [ "keys", "content", "count" ], "title": "Output", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Query Evidence", "tags": [ "Turbinia Evidence" ] } }, "/api/evidence/summary": { "get": { "description": "Retrieves a summary of all evidences in Redis.\n\nArgs:\n group Optional(str): Attribute used to group summary.\n output Optional(str): Sets how the evidence found will be output. \n\nReturns:\n summary (dict): Summary of all evidences and their content.\n\nRaises:\n HTTPException: if there are no evidences.", "operationId": "get_evidence_summary", "parameters": [ { "in": "query", "name": "group", "required": false, "schema": { "enum": [ "_name", "cloud_only", "context_dependent", "copyable", "creation_time", "description", "has_child_evidence", "last_update", "local_path", "mount_path", "parent_evidence", "request_id", "resource_id", "resource_tracked", "save_metadata", "saved_path", "saved_path_type", "size", "source", "source_path", "type" ], "title": "Group", "type": "string" } }, { "in": "query", "name": "output", "required": false, "schema": { "default": "keys", "enum": [ "keys", "content", "count" ], "title": "Output", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Evidence Summary", "tags": [ "Turbinia Evidence" ] } }, "/api/evidence/types": { "get": { "description": "Returns supported Evidence object types and required parameters.", "operationId": "get_evidence_types", "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" } }, "summary": "Get Evidence Types", "tags": [ "Turbinia Evidence" ] } }, "/api/evidence/types/{evidence_type}": { "get": { "description": "Returns supported required parameters for evidence type.\n\nArgs:\n evidence_type (str): Name of evidence type.", "operationId": "get_evidence_attributes", "parameters": [ { "in": "path", "name": "evidence_type", "required": true, "schema": { "title": "Evidence Type" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Evidence Attributes", "tags": [ "Turbinia Evidence" ] } }, "/api/evidence/upload": { "post": { "description": "Upload evidence file to server for processing.\n\nArgs:\n ticket_id (str): ID of the ticket, which will be the name of the folder \n where the evidence will be saved.\n calculate_hash (bool): Boolean defining if the hash of the evidence should\n be calculated.\n file (List[UploadFile]): Evidence files to be uploaded to folder for later\n processing. The maximum size of the file is 10 GB. \n\nReturns:\n List of uploaded evidences or warning messages if any.", "operationId": "upload_evidence", "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_upload_evidence_api_evidence_upload_post" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Upload Evidence", "tags": [ "Turbinia Evidence" ] } }, "/api/evidence/{evidence_id}": { "get": { "description": "Retrieves an evidence in Redis by using its UUID.\n\nArgs:\n evidence_id (str): The UUID of the evidence.\n\nRaises:\n HTTPException: if the evidence is not found.\n\nReturns:\n Dictionary of the stored evidence", "operationId": "get_evidence_by_id", "parameters": [ { "in": "path", "name": "evidence_id", "required": true, "schema": { "title": "Evidence Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Evidence By Id", "tags": [ "Turbinia Evidence" ] } }, "/api/jobs/": { "get": { "description": "Return enabled jobs from the current Turbinia config.", "operationId": "read_jobs", "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" } }, "summary": "Read Jobs", "tags": [ "Turbinia Jobs" ] } }, "/api/logs/api_server": { "get": { "description": "Retrieve log data.", "operationId": "get_api_server_logs", "parameters": [ { "in": "query", "name": "num_lines", "required": false, "schema": { "default": 500, "exclusiveMinimum": 0, "title": "Num Lines", "type": "integer" } } ], "responses": { "200": { "content": { "application/text": { "schema": { "type": "string" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Api Server Logs", "tags": [ "Turbinia Logs" ] } }, "/api/logs/server": { "get": { "description": "Retrieve log data.", "operationId": "get_server_logs", "parameters": [ { "in": "query", "name": "num_lines", "required": false, "schema": { "default": 500, "exclusiveMinimum": 0, "title": "Num Lines", "type": "integer" } } ], "responses": { "200": { "content": { "application/text": { "schema": { "type": "string" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Server Logs", "tags": [ "Turbinia Logs" ] } }, "/api/logs/{hostname}": { "get": { "description": "Retrieve log data.\n\nTurbinia currently stores logs on plaintext files. The log files are named\n.log for each instance of a worker, server or API server.\n\nIn some deployments, the same file can contain all logs (e.g. running all\nservices locally in the same container).", "operationId": "get_turbinia_logs", "parameters": [ { "in": "path", "name": "hostname", "required": true, "schema": { "title": "Hostname", "type": "string" } }, { "in": "query", "name": "num_lines", "required": false, "schema": { "default": 500, "exclusiveMinimum": 0, "title": "Num Lines", "type": "integer" } } ], "responses": { "200": { "content": { "application/text": { "schema": { "type": "string" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Turbinia Logs", "tags": [ "Turbinia Logs" ] } }, "/api/request/": { "post": { "description": "Create a new Turbinia request.\n\nArgs:\n request (Request): FastAPI request object.\n req (turbinia.api.schema.request): JSON object from the HTTP POST data\n matching the schema defined for a Turbinia Request. The schema is used\n by pydantic for field validation.\n\nRaises:\n ValidationError: if the Request object contains invalid data.\n HTTPException: If pre-conditions are not met.", "operationId": "create_request", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Request" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Create Request", "tags": [ "Turbinia Requests" ] } }, "/api/request/summary": { "get": { "description": "Retrieves a summary of all Turbinia requests.\n\nThe response is validated against the RequestSummary model.\n\nRaises:\n HTTPException: if another exception is caught.", "operationId": "get_requests_summary", "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" } }, "summary": "Get Requests Summary", "tags": [ "Turbinia Requests" ] } }, "/api/request/report/{request_id}": { "get": { "description": "Retrieves the markdown report for a Turbinia Request.\n\nArgs:\n request (Request): FastAPI request object.\n request_id (str): A Turbinia request identifier.\n\nRaises:\n HTTPException: if another exception is caught.", "operationId": "get_request_report", "parameters": [ { "in": "path", "name": "request_id", "required": true, "schema": { "title": "Request Id", "type": "string" } } ], "responses": { "200": { "content": { "application/text": { "schema": { "type": "string" } } }, "description": "Successful Response" } }, "summary": "Get Request Markdown Report", "tags": [ "Turbinia Requests" ] } }, "/api/request/{request_id}": { "get": { "description": "Retrieves status for a Turbinia Request.\n\nArgs:\n request (Request): FastAPI request object.\n request_id (str): A Turbinia request identifier.\n\nRaises:\n HTTPException: if another exception is caught.", "operationId": "get_request_status", "parameters": [ { "in": "path", "name": "request_id", "required": true, "schema": { "title": "Request Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Request Status", "tags": [ "Turbinia Requests" ] } }, "/api/result/plasofile/{task_id}": { "get": { "operationId": "get_plaso_file", "parameters": [ { "in": "path", "name": "task_id", "required": true, "schema": { "title": "Task Id", "type": "string" } } ], "responses": { "200": { "content": { "application/octet-stream": { "schema": { "format": "binary", "type": "string" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Plaso File", "tags": [ "Turbinia Request Results" ] } }, "/api/result/request/{request_id}": { "get": { "description": "Retrieve request output.", "operationId": "get_request_output", "parameters": [ { "in": "path", "name": "request_id", "required": true, "schema": { "title": "Request Id", "type": "string" } } ], "responses": { "200": { "content": { "application/octet-stream": { "schema": { "format": "binary", "type": "string" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Request Output", "tags": [ "Turbinia Request Results" ] } }, "/api/result/task/{task_id}": { "get": { "description": "Retrieves a task's output files.", "operationId": "get_task_output", "parameters": [ { "in": "path", "name": "task_id", "required": true, "schema": { "title": "Task Id", "type": "string" } } ], "responses": { "200": { "content": { "application/octet-stream": { "schema": { "format": "binary", "type": "string" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Task Output", "tags": [ "Turbinia Request Results" ] } }, "/api/task/report/{task_id}": { "get": { "description": "Retrieves the MarkDown report of a Turbinia task.\n\nRaises:\n HTTPException: if another exception is caught.", "operationId": "get_task_report", "parameters": [ { "in": "path", "name": "task_id", "required": true, "schema": { "title": "Task Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Task Report", "tags": [ "Turbinia Tasks" ] } }, "/api/task/statistics": { "get": { "description": "Retrieves statistics for Turbinia execution.\n\nArgs:\n days (int): The number of days we want history for.\n task_id (string): The Id of the task.\n request_id (string): The Id of the request we want tasks for.\n user (string): The user of the request we want tasks for.\n\nReturns:\n statistics (str): JSON-formatted task statistics report.", "operationId": "get_task_statistics", "parameters": [ { "in": "query", "name": "days", "required": false, "schema": { "title": "Days", "type": "integer" } }, { "in": "query", "name": "task_id", "required": false, "schema": { "title": "Task Id", "type": "string" } }, { "in": "query", "name": "request_id", "required": false, "schema": { "title": "Request Id", "type": "string" } }, { "in": "query", "name": "user", "required": false, "schema": { "title": "User", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompleteTurbiniaStats" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Task Statistics", "tags": [ "Turbinia Tasks" ] } }, "/api/task/workers": { "get": { "description": "Retrieves the workers status.\n\nArgs:\n days (int): The UUID of the evidence.\n all_fields (bool): Returns all status fields if set to true.\n\nReturns:\n workers_status (str): JSON-formatted workers status.\n\nRaises:\n HTTPException: if no worker is found.", "operationId": "get_workers_status", "parameters": [ { "in": "query", "name": "days", "required": false, "schema": { "default": 7, "title": "Days", "type": "integer" } }, { "in": "query", "name": "all_fields", "required": false, "schema": { "default": false, "title": "All Fields", "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Workers Status", "tags": [ "Turbinia Tasks" ] } }, "/api/task/{task_id}": { "get": { "description": "Retrieve task information.", "operationId": "get_task_status", "parameters": [ { "in": "path", "name": "task_id", "required": true, "schema": { "title": "Task Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Task Status", "tags": [ "Turbinia Tasks" ] } } }, "security": [ { "oAuth2": [] } ] }