{ "openapi": "3.1.0", "info": { "title": "Qtangl PQC Readiness API", "summary": "Post-quantum readiness platform: Assess, Monitor, Convert with signed evidence.", "description": "Tenant-scoped Monitor APIs, public verify/transparency endpoints, and PQC scan lifecycle. See https://www.qtangl.com/docs for authentication, RBAC, and error conventions.", "version": "0.9.1" }, "paths": { "/optimize": { "post": { "tags": [ "optimize" ], "summary": "Optimize", "operationId": "optimize_optimize_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OptimizeRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OptimizeResponse" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unprocessable Content" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Too Many Requests" }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Implemented" } } } }, "/hospital/roster": { "get": { "tags": [ "hospital" ], "summary": "Get Roster", "operationId": "get_roster_hospital_roster_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Roster Hospital Roster Get" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/hospital/scenarios": { "get": { "tags": [ "hospital" ], "summary": "Get Scenarios", "operationId": "get_scenarios_hospital_scenarios_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Scenarios Hospital Scenarios Get" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/hospital/callout": { "get": { "tags": [ "hospital" ], "summary": "Get Callout", "operationId": "get_callout_hospital_callout_get", "parameters": [ { "name": "scenarioId", "in": "query", "required": false, "schema": { "type": "string", "default": "callout-cath-acls", "title": "Scenarioid" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Callout Hospital Callout Get" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/hospital/qpu-trace": { "get": { "tags": [ "hospital" ], "summary": "Get Qpu Trace", "operationId": "get_qpu_trace_hospital_qpu_trace_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Qpu Trace Hospital Qpu Trace Get" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/hospital/upload-roster": { "post": { "tags": [ "hospital" ], "summary": "Upload Roster", "operationId": "upload_roster_hospital_upload_roster_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_upload_roster_hospital_upload_roster_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Upload Roster Hospital Upload Roster Post" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unprocessable Content" } } } }, "/hospital/callout/solve": { "post": { "tags": [ "hospital" ], "summary": "Solve Callout", "operationId": "solve_callout_hospital_callout_solve_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HospitalSolveRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Solve Callout Hospital Callout Solve Post" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/airline/network": { "get": { "tags": [ "airline" ], "summary": "Get Network", "operationId": "get_network_airline_network_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Network Airline Network Get" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/airline/scenarios": { "get": { "tags": [ "airline" ], "summary": "Get Scenarios", "operationId": "get_scenarios_airline_scenarios_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Scenarios Airline Scenarios Get" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/airline/disruption": { "get": { "tags": [ "airline" ], "summary": "Get Disruption", "operationId": "get_disruption_airline_disruption_get", "parameters": [ { "name": "scenarioId", "in": "query", "required": false, "schema": { "type": "string", "default": "mx-hold-ord-0612", "title": "Scenarioid" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Disruption Airline Disruption Get" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/airline/qpu-trace": { "get": { "tags": [ "airline" ], "summary": "Get Qpu Trace", "operationId": "get_qpu_trace_airline_qpu_trace_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Qpu Trace Airline Qpu Trace Get" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/airline/upload-crew": { "post": { "tags": [ "airline" ], "summary": "Upload Crew", "operationId": "upload_crew_airline_upload_crew_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_upload_crew_airline_upload_crew_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Upload Crew Airline Upload Crew Post" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unprocessable Content" } } } }, "/airline/recover/solve": { "post": { "tags": [ "airline" ], "summary": "Solve Recovery", "operationId": "solve_recovery_airline_recover_solve_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AirlineSolveRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Solve Recovery Airline Recover Solve Post" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/ev-fleet/depot": { "get": { "tags": [ "ev-fleet" ], "summary": "Get Depot", "operationId": "get_depot_ev_fleet_depot_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Depot Ev Fleet Depot Get" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/ev-fleet/scenarios": { "get": { "tags": [ "ev-fleet" ], "summary": "Get Scenarios", "operationId": "get_scenarios_ev_fleet_scenarios_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Scenarios Ev Fleet Scenarios Get" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/ev-fleet/window": { "get": { "tags": [ "ev-fleet" ], "summary": "Get Window", "operationId": "get_window_ev_fleet_window_get", "parameters": [ { "name": "scenarioId", "in": "query", "required": false, "schema": { "type": "string", "default": "tou-peak-ca", "title": "Scenarioid" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Window Ev Fleet Window Get" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/ev-fleet/qpu-trace": { "get": { "tags": [ "ev-fleet" ], "summary": "Get Qpu Trace", "operationId": "get_qpu_trace_ev_fleet_qpu_trace_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Qpu Trace Ev Fleet Qpu Trace Get" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/ev-fleet/upload-fleet": { "post": { "tags": [ "ev-fleet" ], "summary": "Upload Fleet", "operationId": "upload_fleet_ev_fleet_upload_fleet_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_upload_fleet_ev_fleet_upload_fleet_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Upload Fleet Ev Fleet Upload Fleet Post" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unprocessable Content" } } } }, "/ev-fleet/upload-stops": { "post": { "tags": [ "ev-fleet" ], "summary": "Upload Stops", "operationId": "upload_stops_ev_fleet_upload_stops_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_upload_stops_ev_fleet_upload_stops_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Upload Stops Ev Fleet Upload Stops Post" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unprocessable Content" } } } }, "/ev-fleet/plan/solve": { "post": { "tags": [ "ev-fleet" ], "summary": "Solve Plan", "operationId": "solve_plan_ev_fleet_plan_solve_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EvFleetSolveRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Solve Plan Ev Fleet Plan Solve Post" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/pqc/inventory": { "get": { "tags": [ "pqc" ], "summary": "Get Inventory", "operationId": "get_inventory_pqc_inventory_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Inventory Pqc Inventory Get" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/pqc/scenarios": { "get": { "tags": [ "pqc" ], "summary": "Get Scenarios", "operationId": "get_scenarios_pqc_scenarios_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Scenarios Pqc Scenarios Get" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/pqc/target": { "get": { "tags": [ "pqc" ], "summary": "Get Target", "operationId": "get_target_pqc_target_get", "parameters": [ { "name": "scenarioId", "in": "query", "required": false, "schema": { "type": "string", "default": "bank-tls-inventory", "title": "Scenarioid" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Target Pqc Target Get" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/pqc/handshake-trace": { "get": { "tags": [ "pqc" ], "summary": "Get Handshake Trace", "operationId": "get_handshake_trace_pqc_handshake_trace_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Handshake Trace Pqc Handshake Trace Get" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/pqc/standards": { "get": { "tags": [ "pqc" ], "summary": "Get Standards", "operationId": "get_standards_pqc_standards_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Standards Pqc Standards Get" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/pqc/upload-bundle": { "post": { "tags": [ "pqc" ], "summary": "Upload Bundle", "operationId": "upload_bundle_pqc_upload_bundle_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_upload_bundle_pqc_upload_bundle_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Upload Bundle Pqc Upload Bundle Post" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unprocessable Content" } } } }, "/pqc/scan": { "post": { "tags": [ "pqc" ], "summary": "Scan Pqc", "operationId": "scan_pqc_pqc_scan_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PqcScanRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Scan Pqc Pqc Scan Post" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/pqc/scan/{scan_id}": { "get": { "tags": [ "pqc" ], "summary": "Get Scan Status", "operationId": "get_scan_status_pqc_scan__scan_id__get", "parameters": [ { "name": "scan_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Scan Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Scan Status Pqc Scan Scan Id Get" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/pqc/handshake/prove": { "post": { "tags": [ "pqc" ], "summary": "Prove Handshake Endpoint", "operationId": "prove_handshake_endpoint_pqc_handshake_prove_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PqcHandshakeRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Prove Handshake Endpoint Pqc Handshake Prove Post" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/pqc/report/{scan_id}": { "get": { "tags": [ "pqc" ], "summary": "Download Report", "operationId": "download_report_pqc_report__scan_id__get", "parameters": [ { "name": "scan_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Scan Id" } }, { "name": "format", "in": "query", "required": false, "schema": { "type": "string", "default": "json", "title": "Format" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/pqc/scan/{scan_id}/persist": { "post": { "tags": [ "pqc" ], "summary": "Persist Scan Bundle", "description": "Store the scan bundle from the client when DB/worker persistence did not complete.", "operationId": "persist_scan_bundle_pqc_scan__scan_id__persist_post", "parameters": [ { "name": "scan_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Scan Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Persist Scan Bundle Pqc Scan Scan Id Persist Post" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unprocessable Content" } } } }, "/pqc/scan/{scan_id}/remediation/simulate": { "post": { "tags": [ "pqc" ], "summary": "Pqc Remediation Simulate", "operationId": "pqc_remediation_simulate_pqc_scan__scan_id__remediation_simulate_post", "parameters": [ { "name": "scan_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Scan Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Pqc Remediation Simulate Pqc Scan Scan Id Remediation Simulate Post" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/pqc/report/{scan_id}/availability": { "get": { "tags": [ "pqc" ], "summary": "Report Availability", "operationId": "report_availability_pqc_report__scan_id__availability_get", "parameters": [ { "name": "scan_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Scan Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Report Availability Pqc Report Scan Id Availability Get" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/pqc/verify/{scan_id}": { "get": { "tags": [ "pqc" ], "summary": "Verify Report", "description": "Public verification: recompute content hash and verify signature.", "operationId": "verify_report_pqc_verify__scan_id__get", "parameters": [ { "name": "scan_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Scan Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Verify Report Pqc Verify Scan Id Get" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/pqc/verify": { "post": { "tags": [ "pqc" ], "summary": "Verify Report Json", "description": "Verify pasted report JSON + signature block.", "operationId": "verify_report_json_pqc_verify_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerifyReportRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Verify Report Json Pqc Verify Post" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/pqc/dogfood/latest": { "get": { "tags": [ "pqc" ], "summary": "Dogfood Latest", "description": "Public latest Qtangl self-scan for trust center (dogfood tenant).", "operationId": "dogfood_latest_pqc_dogfood_latest_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Dogfood Latest Pqc Dogfood Latest Get" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/pqc/dogfood/summary": { "get": { "tags": [ "pqc" ], "summary": "Dogfood Summary", "description": "Public multi-domain dogfood posture summary.", "operationId": "dogfood_summary_pqc_dogfood_summary_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Dogfood Summary Pqc Dogfood Summary Get" } } } } } } }, "/pqc/dogfood/history": { "get": { "tags": [ "pqc" ], "summary": "Dogfood History Endpoint", "description": "Public readiness history for dogfood tenant scans.", "operationId": "dogfood_history_endpoint_pqc_dogfood_history_get", "parameters": [ { "name": "days", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 365, "minimum": 7, "default": 90, "title": "Days" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Dogfood History Endpoint Pqc Dogfood History Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/pqc/dogfood/auditor-bundle": { "get": { "tags": [ "pqc" ], "summary": "Dogfood Auditor Bundle", "description": "Quarterly-style auditor package metadata (verify URLs + transparency root).", "operationId": "dogfood_auditor_bundle_pqc_dogfood_auditor_bundle_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Dogfood Auditor Bundle Pqc Dogfood Auditor Bundle Get" } } } } } } }, "/pqc/index": { "get": { "tags": [ "pqc" ], "summary": "Readiness Index", "description": "Published Readiness Index snapshot (public, rate-limited).", "operationId": "readiness_index_pqc_index_get", "parameters": [ { "name": "industry", "in": "query", "required": false, "schema": { "type": "string", "default": "financial", "title": "Industry" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Readiness Index Pqc Index Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/pqc/index/drift": { "get": { "tags": [ "pqc" ], "summary": "Readiness Index Drift", "description": "Public k-anonymized drift aggregate for opted-in cohort (no PII).", "operationId": "readiness_index_drift_pqc_index_drift_get", "parameters": [ { "name": "industry", "in": "query", "required": false, "schema": { "type": "string", "default": "financial", "title": "Industry" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Readiness Index Drift Pqc Index Drift Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/pqc/transparency/consistency": { "get": { "tags": [ "pqc" ], "summary": "Transparency Consistency", "operationId": "transparency_consistency_pqc_transparency_consistency_get", "parameters": [ { "name": "from_seq", "in": "query", "required": false, "schema": { "type": "integer", "default": 0, "title": "From Seq" } }, { "name": "to_seq", "in": "query", "required": false, "schema": { "type": "integer", "default": 0, "title": "To Seq" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Transparency Consistency Pqc Transparency Consistency Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/pqc/transparency/witnesses": { "get": { "tags": [ "pqc" ], "summary": "Transparency Witnesses", "operationId": "transparency_witnesses_pqc_transparency_witnesses_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Transparency Witnesses Pqc Transparency Witnesses Get" } } } } } } }, "/pqc/transparency/witness": { "post": { "tags": [ "pqc" ], "summary": "Transparency Witness Submit", "operationId": "transparency_witness_submit_pqc_transparency_witness_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WitnessSubmitRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Transparency Witness Submit Pqc Transparency Witness Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/pqc/transparency/root": { "get": { "tags": [ "pqc" ], "summary": "Transparency Root", "description": "Current append-only transparency log root (hashes only; no PII).", "operationId": "transparency_root_pqc_transparency_root_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Transparency Root Pqc Transparency Root Get" } } } } } } }, "/pqc/transparency/keys": { "get": { "tags": [ "pqc" ], "summary": "Transparency Keys", "description": "Public signing key history for offline verification.", "operationId": "transparency_keys_pqc_transparency_keys_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Transparency Keys Pqc Transparency Keys Get" } } } } } } }, "/pqc/transparency/{content_hash}": { "get": { "tags": [ "pqc" ], "summary": "Transparency Inclusion", "description": "Inclusion proof for a report content hash.", "operationId": "transparency_inclusion_pqc_transparency__content_hash__get", "parameters": [ { "name": "content_hash", "in": "path", "required": true, "schema": { "type": "string", "title": "Content Hash" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Transparency Inclusion Pqc Transparency Content Hash Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/pqc/cbom/ingest": { "post": { "tags": [ "pqc" ], "summary": "Cbom Ingest", "description": "Ingest a third-party CycloneDX CBOM (1.6/1.7) into the tenant aggregate.", "operationId": "cbom_ingest_pqc_cbom_ingest_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Cbom Ingest Pqc Cbom Ingest Post" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unprocessable Content" } } } }, "/pqc/cbom/sources": { "get": { "tags": [ "pqc" ], "summary": "Cbom Sources", "operationId": "cbom_sources_pqc_cbom_sources_get", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Cbom Sources Pqc Cbom Sources Get" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/pqc/cbom/aggregate": { "get": { "tags": [ "pqc" ], "summary": "Cbom Aggregate", "operationId": "cbom_aggregate_pqc_cbom_aggregate_get", "parameters": [ { "name": "format", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Format" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Cbom Aggregate Pqc Cbom Aggregate Get" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/pqc/cbom/conflicts": { "get": { "tags": [ "pqc" ], "summary": "Cbom Conflicts", "operationId": "cbom_conflicts_pqc_cbom_conflicts_get", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Cbom Conflicts Pqc Cbom Conflicts Get" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/pqc/cbom/conflicts/{conflict_id}": { "put": { "tags": [ "pqc" ], "summary": "Cbom Resolve Conflict", "operationId": "cbom_resolve_conflict_pqc_cbom_conflicts__conflict_id__put", "parameters": [ { "name": "conflict_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Conflict Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CbomConflictResolveRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Cbom Resolve Conflict Pqc Cbom Conflicts Conflict Id Put" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/pqc/cbom/diff": { "get": { "tags": [ "pqc" ], "summary": "Cbom Diff", "operationId": "cbom_diff_pqc_cbom_diff_get", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Cbom Diff Pqc Cbom Diff Get" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/pqc/cbom/pull/{provider}": { "post": { "tags": [ "pqc" ], "summary": "Cbom Cloud Pull", "operationId": "cbom_cloud_pull_pqc_cbom_pull__provider__post", "parameters": [ { "name": "provider", "in": "path", "required": true, "schema": { "type": "string", "title": "Provider" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Cbom Cloud Pull Pqc Cbom Pull Provider Post" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unprocessable Content" } } } }, "/pqc/transparency/keys/retire": { "post": { "tags": [ "pqc" ], "summary": "Retire Signing Key Endpoint", "operationId": "retire_signing_key_endpoint_pqc_transparency_keys_retire_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetireKeyRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Retire Signing Key Endpoint Pqc Transparency Keys Retire Post" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/me": { "get": { "tags": [ "tenant" ], "summary": "Tenant Me", "operationId": "tenant_me_tenant_me_get", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Me Tenant Me Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/scans": { "get": { "tags": [ "tenant" ], "summary": "Tenant Scans", "operationId": "tenant_scans_tenant_scans_get", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 25, "title": "Limit" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Scans Tenant Scans Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/scans/batch": { "post": { "tags": [ "tenant" ], "summary": "Tenant Scans Batch", "operationId": "tenant_scans_batch_tenant_scans_batch_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchScanRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Scans Batch Tenant Scans Batch Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/scans/{scan_id}": { "get": { "tags": [ "tenant" ], "summary": "Tenant Scan Detail", "operationId": "tenant_scan_detail_tenant_scans__scan_id__get", "parameters": [ { "name": "scan_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Scan Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Scan Detail Tenant Scans Scan Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "tenant" ], "summary": "Tenant Delete Scan", "operationId": "tenant_delete_scan_tenant_scans__scan_id__delete", "parameters": [ { "name": "scan_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Scan Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Delete Scan Tenant Scans Scan Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/scans/{scan_id}/diff": { "get": { "tags": [ "tenant" ], "summary": "Tenant Scan Diff", "operationId": "tenant_scan_diff_tenant_scans__scan_id__diff_get", "parameters": [ { "name": "scan_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Scan Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Scan Diff Tenant Scans Scan Id Diff Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/scans/{scan_id}/report": { "get": { "tags": [ "tenant" ], "summary": "Tenant Scan Report", "operationId": "tenant_scan_report_tenant_scans__scan_id__report_get", "parameters": [ { "name": "scan_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Scan Id" } }, { "name": "format", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^(pdf|json|bundle|executive|board|auditor)$", "default": "pdf", "title": "Format" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/scans/{scan_id}/email": { "post": { "tags": [ "tenant" ], "summary": "Tenant Email Report", "operationId": "tenant_email_report_tenant_scans__scan_id__email_post", "parameters": [ { "name": "scan_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Scan Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailReportRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Email Report Tenant Scans Scan Id Email Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/scans/{scan_id}/remediation": { "get": { "tags": [ "tenant" ], "summary": "Tenant Remediation List", "operationId": "tenant_remediation_list_tenant_scans__scan_id__remediation_get", "parameters": [ { "name": "scan_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Scan Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Remediation List Tenant Scans Scan Id Remediation Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "tenant" ], "summary": "Tenant Remediation Update", "operationId": "tenant_remediation_update_tenant_scans__scan_id__remediation_post", "parameters": [ { "name": "scan_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Scan Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemediationUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Remediation Update Tenant Scans Scan Id Remediation Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/schedules": { "get": { "tags": [ "tenant" ], "summary": "Tenant Schedules", "operationId": "tenant_schedules_tenant_schedules_get", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Schedules Tenant Schedules Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "tenant" ], "summary": "Tenant Create Schedule", "operationId": "tenant_create_schedule_tenant_schedules_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Create Schedule Tenant Schedules Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/schedules/batch": { "post": { "tags": [ "tenant" ], "summary": "Tenant Create Schedules Batch", "operationId": "tenant_create_schedules_batch_tenant_schedules_batch_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchScheduleRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Create Schedules Batch Tenant Schedules Batch Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/schedules/{schedule_id}": { "patch": { "tags": [ "tenant" ], "summary": "Tenant Patch Schedule", "operationId": "tenant_patch_schedule_tenant_schedules__schedule_id__patch", "parameters": [ { "name": "schedule_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Schedule Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchedulePatchRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Patch Schedule Tenant Schedules Schedule Id Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "tenant" ], "summary": "Tenant Delete Schedule", "operationId": "tenant_delete_schedule_tenant_schedules__schedule_id__delete", "parameters": [ { "name": "schedule_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Schedule Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Delete Schedule Tenant Schedules Schedule Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/schedules/{schedule_id}/runs": { "get": { "tags": [ "tenant" ], "summary": "Tenant Schedule Runs", "operationId": "tenant_schedule_runs_tenant_schedules__schedule_id__runs_get", "parameters": [ { "name": "schedule_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Schedule Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Schedule Runs Tenant Schedules Schedule Id Runs Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/settings": { "get": { "tags": [ "tenant" ], "summary": "Tenant Settings Get", "operationId": "tenant_settings_get_tenant_settings_get", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Settings Get Tenant Settings Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "tenant" ], "summary": "Tenant Settings Put", "operationId": "tenant_settings_put_tenant_settings_put", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantSettingsRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Settings Put Tenant Settings Put" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/workspace": { "patch": { "tags": [ "tenant" ], "summary": "Tenant Workspace Patch", "operationId": "tenant_workspace_patch_tenant_workspace_patch", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantWorkspacePatchRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Workspace Patch Tenant Workspace Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/authorized-domains": { "get": { "tags": [ "tenant" ], "summary": "Tenant Authorized Domains Get", "operationId": "tenant_authorized_domains_get_tenant_authorized_domains_get", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Authorized Domains Get Tenant Authorized Domains Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "tenant" ], "summary": "Tenant Authorized Domains Post", "operationId": "tenant_authorized_domains_post_tenant_authorized_domains_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizedDomainsRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Authorized Domains Post Tenant Authorized Domains Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "tenant" ], "summary": "Tenant Authorized Domains Patch", "operationId": "tenant_authorized_domains_patch_tenant_authorized_domains_patch", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizedDomainsPatchRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Authorized Domains Patch Tenant Authorized Domains Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/audit": { "get": { "tags": [ "tenant" ], "summary": "Tenant Audit", "operationId": "tenant_audit_tenant_audit_get", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "action", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Action" } }, { "name": "since", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Since" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Audit Tenant Audit Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/audit/export": { "get": { "tags": [ "tenant" ], "summary": "Tenant Audit Export", "operationId": "tenant_audit_export_tenant_audit_export_get", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 5000, "minimum": 1, "default": 500, "title": "Limit" } }, { "name": "since", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Since" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/scans/{scan_id}/remediation/automate": { "post": { "tags": [ "tenant" ], "summary": "Tenant Remediation Automate", "operationId": "tenant_remediation_automate_tenant_scans__scan_id__remediation_automate_post", "parameters": [ { "name": "scan_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Scan Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemediationAutomateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Remediation Automate Tenant Scans Scan Id Remediation Automate Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/scans/{scan_id}/remediation/verify": { "post": { "tags": [ "tenant" ], "summary": "Tenant Remediation Verify", "operationId": "tenant_remediation_verify_tenant_scans__scan_id__remediation_verify_post", "parameters": [ { "name": "scan_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Scan Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemediationVerifyRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Remediation Verify Tenant Scans Scan Id Remediation Verify Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/scans/{scan_id}/share": { "post": { "tags": [ "tenant" ], "summary": "Tenant Create Share Link", "operationId": "tenant_create_share_link_tenant_scans__scan_id__share_post", "parameters": [ { "name": "scan_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Scan Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShareLinkRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Create Share Link Tenant Scans Scan Id Share Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/passports": { "get": { "tags": [ "tenant" ], "summary": "Tenant List Passports", "operationId": "tenant_list_passports_tenant_passports_get", "parameters": [ { "name": "scanId", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scanid" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant List Passports Tenant Passports Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/share/{link_id}": { "delete": { "tags": [ "tenant" ], "summary": "Tenant Revoke Share", "operationId": "tenant_revoke_share_tenant_share__link_id__delete", "parameters": [ { "name": "link_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Link Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Revoke Share Tenant Share Link Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/portfolio": { "get": { "tags": [ "tenant" ], "summary": "Tenant Portfolio", "operationId": "tenant_portfolio_tenant_portfolio_get", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Portfolio Tenant Portfolio Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "tenant" ], "summary": "Tenant Add Portfolio Target", "operationId": "tenant_add_portfolio_target_tenant_portfolio_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortfolioTargetRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Add Portfolio Target Tenant Portfolio Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/webhooks": { "get": { "tags": [ "tenant" ], "summary": "Tenant Webhooks", "operationId": "tenant_webhooks_tenant_webhooks_get", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Webhooks Tenant Webhooks Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "tenant" ], "summary": "Tenant Create Webhook", "operationId": "tenant_create_webhook_tenant_webhooks_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Create Webhook Tenant Webhooks Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/webhooks/{webhook_id}": { "delete": { "tags": [ "tenant" ], "summary": "Tenant Delete Webhook", "operationId": "tenant_delete_webhook_tenant_webhooks__webhook_id__delete", "parameters": [ { "name": "webhook_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Webhook Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Delete Webhook Tenant Webhooks Webhook Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/webhooks/dlq": { "get": { "tags": [ "tenant" ], "summary": "Tenant Webhook Dlq", "operationId": "tenant_webhook_dlq_tenant_webhooks_dlq_get", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Webhook Dlq Tenant Webhooks Dlq Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/webhooks/replay": { "post": { "tags": [ "tenant" ], "summary": "Tenant Webhook Replay", "operationId": "tenant_webhook_replay_tenant_webhooks_replay_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeadLetterReplayRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Webhook Replay Tenant Webhooks Replay Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/integrations": { "get": { "tags": [ "tenant" ], "summary": "Tenant Integrations", "operationId": "tenant_integrations_tenant_integrations_get", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Integrations Tenant Integrations Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/integrations/{provider}": { "post": { "tags": [ "tenant" ], "summary": "Tenant Upsert Integration", "operationId": "tenant_upsert_integration_tenant_integrations__provider__post", "parameters": [ { "name": "provider", "in": "path", "required": true, "schema": { "type": "string", "title": "Provider" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationConfigRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Upsert Integration Tenant Integrations Provider Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/scans/{scan_id}/integrations/push": { "post": { "tags": [ "tenant" ], "summary": "Tenant Push Remediation", "operationId": "tenant_push_remediation_tenant_scans__scan_id__integrations_push_post", "parameters": [ { "name": "scan_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Scan Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationPushRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Push Remediation Tenant Scans Scan Id Integrations Push Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/integrations/pull": { "post": { "tags": [ "tenant" ], "summary": "Tenant Pull Integration Status", "operationId": "tenant_pull_integration_status_tenant_integrations_pull_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationPullRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Pull Integration Status Tenant Integrations Pull Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/scans/{scan_id}/remediation/intelligence": { "get": { "tags": [ "tenant" ], "summary": "Tenant Remediation Intelligence", "operationId": "tenant_remediation_intelligence_tenant_scans__scan_id__remediation_intelligence_get", "parameters": [ { "name": "scan_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Scan Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Remediation Intelligence Tenant Scans Scan Id Remediation Intelligence Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/scans/{scan_id}/remediation/simulate": { "post": { "tags": [ "tenant" ], "summary": "Tenant Remediation Simulate", "operationId": "tenant_remediation_simulate_tenant_scans__scan_id__remediation_simulate_post", "parameters": [ { "name": "scan_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Scan Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemediationSimulationRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Remediation Simulate Tenant Scans Scan Id Remediation Simulate Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/cloud-import": { "post": { "tags": [ "tenant" ], "summary": "Tenant Cloud Import", "description": "Parse cloud PKI JSON/CSV and return normalized inventory rows for upload-bundle scans.", "operationId": "tenant_cloud_import_tenant_cloud_import_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Cloud Import Tenant Cloud Import Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/export": { "get": { "tags": [ "tenant" ], "summary": "Tenant Export Data", "description": "Export tenant scan metadata and live remediation status.", "operationId": "tenant_export_data_tenant_export_get", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Export Data Tenant Export Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/slo": { "get": { "tags": [ "tenant" ], "summary": "Tenant Slo", "operationId": "tenant_slo_tenant_slo_get", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Slo Tenant Slo Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/portfolio/command-center": { "get": { "tags": [ "tenant" ], "summary": "Tenant Portfolio Command Center", "operationId": "tenant_portfolio_command_center_tenant_portfolio_command_center_get", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Portfolio Command Center Tenant Portfolio Command Center Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/data": { "delete": { "tags": [ "tenant" ], "summary": "Tenant Delete Data", "description": "Delete all tenant data (retention / offboarding).", "operationId": "tenant_delete_data_tenant_data_delete", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Delete Data Tenant Data Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/offboard": { "post": { "tags": [ "tenant" ], "summary": "Tenant Offboard", "description": "Admin-only alias for full tenant offboarding.", "operationId": "tenant_offboard_tenant_offboard_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Offboard Tenant Offboard Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/coverage/cloud/{provider}": { "get": { "tags": [ "tenant" ], "summary": "Tenant Cloud Pull", "operationId": "tenant_cloud_pull_tenant_coverage_cloud__provider__get", "parameters": [ { "name": "provider", "in": "path", "required": true, "schema": { "type": "string", "title": "Provider" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Cloud Pull Tenant Coverage Cloud Provider Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/ai/explain": { "post": { "tags": [ "tenant" ], "summary": "Tenant Ai Explain", "operationId": "tenant_ai_explain_tenant_ai_explain_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Ai Explain Tenant Ai Explain Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/ai/explain-scan": { "post": { "tags": [ "tenant" ], "summary": "Tenant Ai Explain Scan", "operationId": "tenant_ai_explain_scan_tenant_ai_explain_scan_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Ai Explain Scan Tenant Ai Explain Scan Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/ai/explain-portfolio": { "post": { "tags": [ "tenant" ], "summary": "Tenant Ai Explain Portfolio", "operationId": "tenant_ai_explain_portfolio_tenant_ai_explain_portfolio_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Ai Explain Portfolio Tenant Ai Explain Portfolio Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/dashboard/recommendations": { "get": { "tags": [ "tenant" ], "summary": "Tenant Dashboard Recommendations", "operationId": "tenant_dashboard_recommendations_tenant_dashboard_recommendations_get", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Dashboard Recommendations Tenant Dashboard Recommendations Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/recommendations/{recommendation_id}/dismiss": { "post": { "tags": [ "tenant" ], "summary": "Tenant Dismiss Recommendation", "operationId": "tenant_dismiss_recommendation_tenant_recommendations__recommendation_id__dismiss_post", "parameters": [ { "name": "recommendation_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Recommendation Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Dismiss Recommendation Tenant Recommendations Recommendation Id Dismiss Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/alerts/{alert_id}/read": { "patch": { "tags": [ "tenant" ], "summary": "Tenant Mark Alert Read", "operationId": "tenant_mark_alert_read_tenant_alerts__alert_id__read_patch", "parameters": [ { "name": "alert_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Alert Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Mark Alert Read Tenant Alerts Alert Id Read Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/alerts/read-all": { "post": { "tags": [ "tenant" ], "summary": "Tenant Mark All Alerts Read", "operationId": "tenant_mark_all_alerts_read_tenant_alerts_read_all_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Mark All Alerts Read Tenant Alerts Read All Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/analytics/anomaly": { "get": { "tags": [ "tenant" ], "summary": "Tenant Anomaly", "operationId": "tenant_anomaly_tenant_analytics_anomaly_get", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Anomaly Tenant Analytics Anomaly Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/analytics/readiness-trend": { "get": { "tags": [ "tenant" ], "summary": "Tenant Readiness Trend", "operationId": "tenant_readiness_trend_tenant_analytics_readiness_trend_get", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 30, "title": "Limit" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Readiness Trend Tenant Analytics Readiness Trend Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/analytics/track": { "post": { "tags": [ "tenant" ], "summary": "Tenant Track Event", "operationId": "tenant_track_event_tenant_analytics_track_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrackEventRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Track Event Tenant Analytics Track Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/dashboard/summary": { "get": { "tags": [ "tenant" ], "summary": "Tenant Dashboard Summary", "operationId": "tenant_dashboard_summary_tenant_dashboard_summary_get", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Dashboard Summary Tenant Dashboard Summary Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/dashboard/tab/{tab_name}": { "get": { "tags": [ "tenant" ], "summary": "Tenant Dashboard Tab", "operationId": "tenant_dashboard_tab_tenant_dashboard_tab__tab_name__get", "parameters": [ { "name": "tab_name", "in": "path", "required": true, "schema": { "type": "string", "title": "Tab Name" } }, { "name": "scan_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scan Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Dashboard Tab Tenant Dashboard Tab Tab Name Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/partner/portfolio-summary": { "get": { "tags": [ "tenant" ], "summary": "Tenant Partner Portfolio Summary", "operationId": "tenant_partner_portfolio_summary_tenant_partner_portfolio_summary_get", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Partner Portfolio Summary Tenant Partner Portfolio Summary Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/partner/program": { "get": { "tags": [ "tenant" ], "summary": "Tenant Partner Program", "operationId": "tenant_partner_program_tenant_partner_program_get", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Partner Program Tenant Partner Program Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/partner/portfolio-board": { "get": { "tags": [ "tenant" ], "summary": "Tenant Partner Portfolio Board", "operationId": "tenant_partner_portfolio_board_tenant_partner_portfolio_board_get", "parameters": [ { "name": "format", "in": "query", "required": false, "schema": { "type": "string", "default": "pdf", "title": "Format" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/partner/bulk/weekly-digest": { "post": { "tags": [ "tenant" ], "summary": "Tenant Partner Bulk Weekly Digest", "operationId": "tenant_partner_bulk_weekly_digest_tenant_partner_bulk_weekly_digest_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerBulkDigestBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Partner Bulk Weekly Digest Tenant Partner Bulk Weekly Digest Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/partner/bulk/schedule-template": { "post": { "tags": [ "tenant" ], "summary": "Tenant Partner Bulk Schedule Template", "operationId": "tenant_partner_bulk_schedule_template_tenant_partner_bulk_schedule_template_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerBulkScheduleBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Partner Bulk Schedule Template Tenant Partner Bulk Schedule Template Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/partner/deal-registration": { "post": { "tags": [ "tenant" ], "summary": "Tenant Partner Deal Registration", "operationId": "tenant_partner_deal_registration_tenant_partner_deal_registration_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerDealRegistrationBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Partner Deal Registration Tenant Partner Deal Registration Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/partner/usage-export": { "get": { "tags": [ "tenant" ], "summary": "Tenant Partner Usage Export", "operationId": "tenant_partner_usage_export_tenant_partner_usage_export_get", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/dashboard/digest/preview": { "post": { "tags": [ "tenant" ], "summary": "Tenant Dashboard Digest Preview", "operationId": "tenant_dashboard_digest_preview_tenant_dashboard_digest_preview_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Dashboard Digest Preview Tenant Dashboard Digest Preview Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/dashboard/digest/send-test": { "post": { "tags": [ "tenant" ], "summary": "Tenant Dashboard Digest Send Test", "operationId": "tenant_dashboard_digest_send_test_tenant_dashboard_digest_send_test_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigestPreviewRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Dashboard Digest Send Test Tenant Dashboard Digest Send Test Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/scans/bulk-export": { "post": { "tags": [ "tenant" ], "summary": "Tenant Scans Bulk Export", "operationId": "tenant_scans_bulk_export_tenant_scans_bulk_export_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkExportRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/dashboard/events": { "get": { "tags": [ "tenant" ], "summary": "Tenant Dashboard Events", "operationId": "tenant_dashboard_events_tenant_dashboard_events_get", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/analytics/forecast": { "get": { "tags": [ "tenant" ], "summary": "Tenant Forecast", "operationId": "tenant_forecast_tenant_analytics_forecast_get", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Forecast Tenant Analytics Forecast Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/benchmarks": { "get": { "tags": [ "tenant" ], "summary": "Tenant Benchmarks", "operationId": "tenant_benchmarks_tenant_benchmarks_get", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Benchmarks Tenant Benchmarks Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/drift-intel": { "get": { "tags": [ "tenant" ], "summary": "Tenant Drift Intel", "operationId": "tenant_drift_intel_tenant_drift_intel_get", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Drift Intel Tenant Drift Intel Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/oidc": { "get": { "tags": [ "tenant" ], "summary": "Tenant Oidc Get", "operationId": "tenant_oidc_get_tenant_oidc_get", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Oidc Get Tenant Oidc Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "tenant" ], "summary": "Tenant Oidc Put", "operationId": "tenant_oidc_put_tenant_oidc_put", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OidcConfigRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Oidc Put Tenant Oidc Put" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/compliance/posture": { "get": { "tags": [ "tenant" ], "summary": "Tenant Compliance Posture", "operationId": "tenant_compliance_posture_tenant_compliance_posture_get", "parameters": [ { "name": "scan_id", "in": "query", "required": true, "schema": { "type": "string", "title": "Scan Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Compliance Posture Tenant Compliance Posture Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/partner/children": { "get": { "tags": [ "tenant" ], "summary": "Tenant Partner Children", "operationId": "tenant_partner_children_tenant_partner_children_get", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Partner Children Tenant Partner Children Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "tenant" ], "summary": "Tenant Partner Link Child", "operationId": "tenant_partner_link_child_tenant_partner_children_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Partner Link Child Tenant Partner Children Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/partner/children/{child_tenant_id}": { "delete": { "tags": [ "tenant" ], "summary": "Tenant Partner Unlink Child", "operationId": "tenant_partner_unlink_child_tenant_partner_children__child_tenant_id__delete", "parameters": [ { "name": "child_tenant_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Child Tenant Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Partner Unlink Child Tenant Partner Children Child Tenant Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "tenant" ], "summary": "Tenant Partner Update Child Label", "operationId": "tenant_partner_update_child_label_tenant_partner_children__child_tenant_id__patch", "parameters": [ { "name": "child_tenant_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Child Tenant Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Partner Update Child Label Tenant Partner Children Child Tenant Id Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/partner/provision-child": { "post": { "tags": [ "tenant" ], "summary": "Tenant Partner Provision Child", "operationId": "tenant_partner_provision_child_tenant_partner_provision_child_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerProvisionChildBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Partner Provision Child Tenant Partner Provision Child Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/onboarding": { "patch": { "tags": [ "tenant" ], "summary": "Tenant Patch Onboarding", "operationId": "tenant_patch_onboarding_tenant_onboarding_patch", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboardingPatchBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Patch Onboarding Tenant Onboarding Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/legal/accept": { "post": { "tags": [ "tenant" ], "summary": "Tenant Legal Accept", "operationId": "tenant_legal_accept_tenant_legal_accept_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegalAcceptBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Legal Accept Tenant Legal Accept Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/billing/checkout": { "post": { "tags": [ "tenant" ], "summary": "Tenant Billing Checkout", "operationId": "tenant_billing_checkout_tenant_billing_checkout_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingCheckoutBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Billing Checkout Tenant Billing Checkout Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/billing/portal": { "post": { "tags": [ "tenant" ], "summary": "Tenant Billing Portal", "operationId": "tenant_billing_portal_tenant_billing_portal_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Billing Portal Tenant Billing Portal Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "tenant" ], "summary": "Tenant Billing Portal", "operationId": "tenant_billing_portal_tenant_billing_portal_get", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Billing Portal Tenant Billing Portal Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/evidence": { "get": { "tags": [ "tenant" ], "summary": "Tenant Evidence Vault", "operationId": "tenant_evidence_vault_tenant_evidence_get", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Evidence Vault Tenant Evidence Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/evidence/{scan_id}/retain": { "post": { "tags": [ "tenant" ], "summary": "Tenant Retain Evidence", "operationId": "tenant_retain_evidence_tenant_evidence__scan_id__retain_post", "parameters": [ { "name": "scan_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Scan Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Retain Evidence Tenant Evidence Scan Id Retain Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/integrations/cloud": { "get": { "tags": [ "tenant" ], "summary": "Tenant Cloud Integrations", "operationId": "tenant_cloud_integrations_tenant_integrations_cloud_get", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Cloud Integrations Tenant Integrations Cloud Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/integrations/cloud/{provider}": { "post": { "tags": [ "tenant" ], "summary": "Tenant Upsert Cloud Integration", "operationId": "tenant_upsert_cloud_integration_tenant_integrations_cloud__provider__post", "parameters": [ { "name": "provider", "in": "path", "required": true, "schema": { "type": "string", "title": "Provider" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudIntegrationRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Upsert Cloud Integration Tenant Integrations Cloud Provider Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/integrations/cloud/{provider}/test": { "post": { "tags": [ "tenant" ], "summary": "Tenant Test Cloud Integration", "operationId": "tenant_test_cloud_integration_tenant_integrations_cloud__provider__test_post", "parameters": [ { "name": "provider", "in": "path", "required": true, "schema": { "type": "string", "title": "Provider" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Test Cloud Integration Tenant Integrations Cloud Provider Test Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/integrations/keyfactor": { "post": { "tags": [ "tenant" ], "summary": "Tenant Upsert Keyfactor", "operationId": "tenant_upsert_keyfactor_tenant_integrations_keyfactor_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyfactorIntegrationRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Upsert Keyfactor Tenant Integrations Keyfactor Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/integrations/keyfactor/test": { "post": { "tags": [ "tenant" ], "summary": "Tenant Test Keyfactor", "operationId": "tenant_test_keyfactor_tenant_integrations_keyfactor_test_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Test Keyfactor Tenant Integrations Keyfactor Test Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/integrations/clm/{clm_provider}": { "post": { "tags": [ "tenant" ], "summary": "Tenant Upsert Clm", "operationId": "tenant_upsert_clm_tenant_integrations_clm__clm_provider__post", "parameters": [ { "name": "clm_provider", "in": "path", "required": true, "schema": { "type": "string", "title": "Clm Provider" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClmIntegrationRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Upsert Clm Tenant Integrations Clm Clm Provider Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/integrations/clm/{clm_provider}/test": { "post": { "tags": [ "tenant" ], "summary": "Tenant Test Clm", "operationId": "tenant_test_clm_tenant_integrations_clm__clm_provider__test_post", "parameters": [ { "name": "clm_provider", "in": "path", "required": true, "schema": { "type": "string", "title": "Clm Provider" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Test Clm Tenant Integrations Clm Clm Provider Test Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/api-keys": { "get": { "tags": [ "tenant" ], "summary": "Tenant List Api Keys", "operationId": "tenant_list_api_keys_tenant_api_keys_get", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant List Api Keys Tenant Api Keys Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "tenant" ], "summary": "Tenant Create Api Key", "operationId": "tenant_create_api_key_tenant_api_keys_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeyCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Create Api Key Tenant Api Keys Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/api-keys/{key_id}": { "delete": { "tags": [ "tenant" ], "summary": "Tenant Revoke Api Key", "operationId": "tenant_revoke_api_key_tenant_api_keys__key_id__delete", "parameters": [ { "name": "key_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Key Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Revoke Api Key Tenant Api Keys Key Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/members": { "get": { "tags": [ "tenant" ], "summary": "Tenant List Members", "operationId": "tenant_list_members_tenant_members_get", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant List Members Tenant Members Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/members/{membership_id}": { "delete": { "tags": [ "tenant" ], "summary": "Tenant Remove Member", "operationId": "tenant_remove_member_tenant_members__membership_id__delete", "parameters": [ { "name": "membership_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Membership Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Remove Member Tenant Members Membership Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "tenant" ], "summary": "Tenant Update Member Role", "operationId": "tenant_update_member_role_tenant_members__membership_id__patch", "parameters": [ { "name": "membership_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Membership Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberRoleUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Update Member Role Tenant Members Membership Id Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/invites": { "get": { "tags": [ "tenant" ], "summary": "Tenant List Invites", "operationId": "tenant_list_invites_tenant_invites_get", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant List Invites Tenant Invites Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "tenant" ], "summary": "Tenant Create Invite", "operationId": "tenant_create_invite_tenant_invites_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamInviteRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Create Invite Tenant Invites Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/invites/{invite_id}": { "delete": { "tags": [ "tenant" ], "summary": "Tenant Revoke Invite", "operationId": "tenant_revoke_invite_tenant_invites__invite_id__delete", "parameters": [ { "name": "invite_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Invite Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Revoke Invite Tenant Invites Invite Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/sso/portal-link": { "post": { "tags": [ "tenant" ], "summary": "Tenant Sso Portal Link", "operationId": "tenant_sso_portal_link_tenant_sso_portal_link_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SsoPortalRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Sso Portal Link Tenant Sso Portal Link Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/discovery/fleets": { "post": { "tags": [ "discovery" ], "summary": "Create Discovery Fleet", "operationId": "create_discovery_fleet_tenant_discovery_fleets_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create Discovery Fleet Tenant Discovery Fleets Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "discovery" ], "summary": "Get Discovery Fleets", "operationId": "get_discovery_fleets_tenant_discovery_fleets_get", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Discovery Fleets Tenant Discovery Fleets Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/discovery/agents": { "get": { "tags": [ "discovery" ], "summary": "Get Discovery Agents", "operationId": "get_discovery_agents_tenant_discovery_agents_get", "parameters": [ { "name": "fleetId", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Fleetid" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Discovery Agents Tenant Discovery Agents Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/discovery/agents/{agent_id}/findings": { "get": { "tags": [ "discovery" ], "summary": "Get Agent Findings", "operationId": "get_agent_findings_tenant_discovery_agents__agent_id__findings_get", "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 50, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "default": 0, "title": "Offset" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Agent Findings Tenant Discovery Agents Agent Id Findings Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/discovery/findings/{finding_id}": { "get": { "tags": [ "discovery" ], "summary": "Get Host Finding Detail", "operationId": "get_host_finding_detail_tenant_discovery_findings__finding_id__get", "parameters": [ { "name": "finding_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Finding Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Host Finding Detail Tenant Discovery Findings Finding Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/discovery/summary": { "get": { "tags": [ "discovery" ], "summary": "Get Discovery Summary", "operationId": "get_discovery_summary_tenant_discovery_summary_get", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Discovery Summary Tenant Discovery Summary Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/discovery/fleets/{fleet_id}/rotate-token": { "post": { "tags": [ "discovery" ], "summary": "Rotate Token", "operationId": "rotate_token_tenant_discovery_fleets__fleet_id__rotate_token_post", "parameters": [ { "name": "fleet_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Fleet Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Rotate Token Tenant Discovery Fleets Fleet Id Rotate Token Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/discovery/agents/revoke": { "post": { "tags": [ "discovery" ], "summary": "Revoke Discovery Agents", "operationId": "revoke_discovery_agents_tenant_discovery_agents_revoke_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Revoke Discovery Agents Tenant Discovery Agents Revoke Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/discovery/host-scan": { "post": { "tags": [ "discovery" ], "summary": "Trigger Host Scan", "operationId": "trigger_host_scan_tenant_discovery_host_scan_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Trigger Host Scan Tenant Discovery Host Scan Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/discovery/agent/enroll": { "post": { "tags": [ "discovery" ], "summary": "Agent Enroll", "operationId": "agent_enroll_discovery_agent_enroll_post", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Body" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Agent Enroll Discovery Agent Enroll Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/discovery/agent/heartbeat": { "post": { "tags": [ "discovery" ], "summary": "Agent Heartbeat", "operationId": "agent_heartbeat_discovery_agent_heartbeat_post", "parameters": [ { "name": "X-Qtangl-Agent-Cert", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Agent-Cert" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Agent Heartbeat Discovery Agent Heartbeat Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/discovery/agent/findings": { "post": { "tags": [ "discovery" ], "summary": "Agent Findings", "operationId": "agent_findings_discovery_agent_findings_post", "parameters": [ { "name": "X-Qtangl-Discovery-Schema", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Discovery-Schema" } }, { "name": "X-Qtangl-Agent-Cert", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Agent-Cert" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Agent Findings Discovery Agent Findings Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/coverage/code-scan": { "post": { "tags": [ "discovery" ], "summary": "Tenant Code Scan Async", "operationId": "tenant_code_scan_async_tenant_coverage_code_scan_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Code Scan Async Tenant Coverage Code Scan Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/discovery/jobs/{job_id}": { "get": { "tags": [ "discovery" ], "summary": "Get Job Status", "operationId": "get_job_status_tenant_discovery_jobs__job_id__get", "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Job Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Job Status Tenant Discovery Jobs Job Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/discovery/host-drift": { "get": { "tags": [ "discovery" ], "summary": "Get Host Drift", "operationId": "get_host_drift_tenant_discovery_host_drift_get", "parameters": [ { "name": "scope_key", "in": "query", "required": false, "schema": { "type": "string", "default": "fleet", "title": "Scope Key" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Host Drift Tenant Discovery Host Drift Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/discovery/agent/update": { "get": { "tags": [ "discovery" ], "summary": "Agent Update Check", "operationId": "agent_update_check_discovery_agent_update_get", "parameters": [ { "name": "version", "in": "query", "required": false, "schema": { "type": "string", "default": "0.1.0", "title": "Version" } }, { "name": "ring", "in": "query", "required": false, "schema": { "type": "string", "default": "stable", "title": "Ring" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Agent Update Check Discovery Agent Update Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/discovery/code-targets": { "get": { "tags": [ "discovery" ], "summary": "Get Code Targets", "operationId": "get_code_targets_tenant_discovery_code_targets_get", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Code Targets Tenant Discovery Code Targets Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "discovery" ], "summary": "Post Code Target", "operationId": "post_code_target_tenant_discovery_code_targets_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Post Code Target Tenant Discovery Code Targets Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/discovery/image-targets": { "get": { "tags": [ "discovery" ], "summary": "Get Image Targets", "operationId": "get_image_targets_tenant_discovery_image_targets_get", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Image Targets Tenant Discovery Image Targets Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "discovery" ], "summary": "Post Image Target", "operationId": "post_image_target_tenant_discovery_image_targets_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Post Image Target Tenant Discovery Image Targets Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/discovery/github-webhook": { "post": { "tags": [ "discovery" ], "summary": "Github Webhook", "operationId": "github_webhook_tenant_discovery_github_webhook_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Github Webhook Tenant Discovery Github Webhook Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/discovery/pr-comment": { "post": { "tags": [ "discovery" ], "summary": "Pr Comment", "operationId": "pr_comment_tenant_discovery_pr_comment_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Pr Comment Tenant Discovery Pr Comment Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/discovery/gitlab-webhook": { "post": { "tags": [ "discovery" ], "summary": "Gitlab Webhook", "operationId": "gitlab_webhook_tenant_discovery_gitlab_webhook_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Gitlab Webhook Tenant Discovery Gitlab Webhook Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/discovery/ado-webhook": { "post": { "tags": [ "discovery" ], "summary": "Ado Webhook", "operationId": "ado_webhook_tenant_discovery_ado_webhook_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Ado Webhook Tenant Discovery Ado Webhook Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/discovery/binary-scan": { "post": { "tags": [ "discovery" ], "summary": "Trigger Binary Scan", "operationId": "trigger_binary_scan_tenant_discovery_binary_scan_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Trigger Binary Scan Tenant Discovery Binary Scan Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/discovery/offline-upload": { "post": { "tags": [ "discovery" ], "summary": "Offline Sensor Upload", "operationId": "offline_sensor_upload_tenant_discovery_offline_upload_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Offline Sensor Upload Tenant Discovery Offline Upload Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/discovery/cmdb-coverage": { "get": { "tags": [ "discovery" ], "summary": "Get Cmdb Coverage", "operationId": "get_cmdb_coverage_tenant_discovery_cmdb_coverage_get", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Cmdb Coverage Tenant Discovery Cmdb Coverage Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/discovery/registry/test-connection": { "post": { "tags": [ "discovery" ], "summary": "Test Registry Connection", "operationId": "test_registry_connection_tenant_discovery_registry_test_connection_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Test Registry Connection Tenant Discovery Registry Test Connection Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/discovery/github-app/install": { "get": { "tags": [ "discovery" ], "summary": "Github App Install Url", "operationId": "github_app_install_url_tenant_discovery_github_app_install_get", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Github App Install Url Tenant Discovery Github App Install Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/discovery/github-app/callback": { "post": { "tags": [ "discovery" ], "summary": "Github App Callback", "operationId": "github_app_callback_tenant_discovery_github_app_callback_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Github App Callback Tenant Discovery Github App Callback Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/discovery/source-runtime-diff": { "post": { "tags": [ "discovery" ], "summary": "Source Runtime Diff", "operationId": "source_runtime_diff_tenant_discovery_source_runtime_diff_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Source Runtime Diff Tenant Discovery Source Runtime Diff Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/drift/summary": { "get": { "tags": [ "tenant" ], "summary": "Drift Summary", "operationId": "drift_summary_tenant_drift_summary_get", "parameters": [ { "name": "since_days", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 365, "minimum": 1, "default": 7, "title": "Since Days" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Drift Summary Tenant Drift Summary Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/drift/{source_type}/{scope_key}": { "get": { "tags": [ "tenant" ], "summary": "Drift Scope Detail", "operationId": "drift_scope_detail_tenant_drift__source_type___scope_key__get", "parameters": [ { "name": "source_type", "in": "path", "required": true, "schema": { "type": "string", "title": "Source Type" } }, { "name": "scope_key", "in": "path", "required": true, "schema": { "type": "string", "title": "Scope Key" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Drift Scope Detail Tenant Drift Source Type Scope Key Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/drift/history": { "get": { "tags": [ "tenant" ], "summary": "Drift History", "operationId": "drift_history_tenant_drift_history_get", "parameters": [ { "name": "source_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Type" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Drift History Tenant Drift History Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/remediation/program": { "get": { "tags": [ "tenant" ], "summary": "Program List", "operationId": "program_list_tenant_remediation_program_get", "parameters": [ { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Program List Tenant Remediation Program Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "tenant" ], "summary": "Program Create", "operationId": "program_create_tenant_remediation_program_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProgramCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Program Create Tenant Remediation Program Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/remediation/program/velocity": { "get": { "tags": [ "tenant" ], "summary": "Program Velocity Endpoint", "operationId": "program_velocity_endpoint_tenant_remediation_program_velocity_get", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Program Velocity Endpoint Tenant Remediation Program Velocity Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/remediation/program/simulate": { "post": { "tags": [ "tenant" ], "summary": "Program Simulate", "operationId": "program_simulate_tenant_remediation_program_simulate_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProgramSimulateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Program Simulate Tenant Remediation Program Simulate Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/remediation/program/migrate-legacy": { "post": { "tags": [ "tenant" ], "summary": "Program Migrate Legacy", "operationId": "program_migrate_legacy_tenant_remediation_program_migrate_legacy_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Program Migrate Legacy Tenant Remediation Program Migrate Legacy Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/remediation/program/{item_id}": { "put": { "tags": [ "tenant" ], "summary": "Program Update", "operationId": "program_update_tenant_remediation_program__item_id__put", "parameters": [ { "name": "item_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Item Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProgramUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Program Update Tenant Remediation Program Item Id Put" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/remediation/program/recommendations": { "get": { "tags": [ "tenant" ], "summary": "Program Recommendations", "operationId": "program_recommendations_tenant_remediation_program_recommendations_get", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Program Recommendations Tenant Remediation Program Recommendations Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/remediation/program/{item_id}/playbook": { "get": { "tags": [ "tenant" ], "summary": "Program Playbook", "operationId": "program_playbook_tenant_remediation_program__item_id__playbook_get", "parameters": [ { "name": "item_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Item Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Program Playbook Tenant Remediation Program Item Id Playbook Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/remediation/program/{item_id}/verify": { "post": { "tags": [ "tenant" ], "summary": "Program Verify", "operationId": "program_verify_tenant_remediation_program__item_id__verify_post", "parameters": [ { "name": "item_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Item Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProgramVerifyRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Program Verify Tenant Remediation Program Item Id Verify Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/remediation/program/{program_item_id}/flip/dry-run": { "post": { "tags": [ "tenant" ], "summary": "Flip Dry Run", "operationId": "flip_dry_run_tenant_remediation_program__program_item_id__flip_dry_run_post", "parameters": [ { "name": "program_item_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Program Item Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipDryRunRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Flip Dry Run Tenant Remediation Program Program Item Id Flip Dry Run Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/remediation/program/{program_item_id}/flip": { "post": { "tags": [ "tenant" ], "summary": "Flip Submit", "operationId": "flip_submit_tenant_remediation_program__program_item_id__flip_post", "parameters": [ { "name": "program_item_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Program Item Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipSubmitRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Flip Submit Tenant Remediation Program Program Item Id Flip Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/flips": { "get": { "tags": [ "tenant" ], "summary": "Flips List", "operationId": "flips_list_tenant_flips_get", "parameters": [ { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "flipSurface", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Flipsurface" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Flips List Tenant Flips Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/flips/{job_id}": { "get": { "tags": [ "tenant" ], "summary": "Flips Get", "operationId": "flips_get_tenant_flips__job_id__get", "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Job Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Flips Get Tenant Flips Job Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/flips/{job_id}/approve": { "post": { "tags": [ "tenant" ], "summary": "Flips Approve", "operationId": "flips_approve_tenant_flips__job_id__approve_post", "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Job Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipApproveRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Flips Approve Tenant Flips Job Id Approve Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/flips/{job_id}/cancel": { "post": { "tags": [ "tenant" ], "summary": "Flips Cancel", "operationId": "flips_cancel_tenant_flips__job_id__cancel_post", "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Job Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipCancelRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Flips Cancel Tenant Flips Job Id Cancel Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/flips/{job_id}/retry": { "post": { "tags": [ "tenant" ], "summary": "Flips Retry", "operationId": "flips_retry_tenant_flips__job_id__retry_post", "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Job Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Flips Retry Tenant Flips Job Id Retry Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/flips/{job_id}/poll": { "get": { "tags": [ "tenant" ], "summary": "Flips Poll", "operationId": "flips_poll_tenant_flips__job_id__poll_get", "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Job Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Flips Poll Tenant Flips Job Id Poll Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/integrations/jira/webhook": { "post": { "tags": [ "integrations" ], "summary": "Jira Webhook", "description": "Authenticated relay for Jira issue_updated events; not a native webhook verifier.", "operationId": "jira_webhook_integrations_jira_webhook_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Jira Webhook Integrations Jira Webhook Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/integrations/slack/actions": { "post": { "tags": [ "integrations" ], "summary": "Slack Inbound Action", "description": "Authenticated Slack relay; native Slack signatures are not verified here.", "operationId": "slack_inbound_action_integrations_slack_actions_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Slack Inbound Action Integrations Slack Actions Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/integrations/teams/actions": { "post": { "tags": [ "integrations" ], "summary": "Teams Inbound Action", "description": "Authenticated Teams relay; native Bot Framework JWTs are not accepted.", "operationId": "teams_inbound_action_integrations_teams_actions_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Teams Inbound Action Integrations Teams Actions Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/platform/summary": { "get": { "tags": [ "admin" ], "summary": "Admin Platform Summary", "operationId": "admin_platform_summary_admin_platform_summary_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Admin Platform Summary Admin Platform Summary Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/tenants": { "get": { "tags": [ "admin" ], "summary": "Admin List Tenants", "operationId": "admin_list_tenants_admin_tenants_get", "parameters": [ { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search" } }, { "name": "tier", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tier" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Admin List Tenants Admin Tenants Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "admin" ], "summary": "Admin Create Tenant", "operationId": "admin_create_tenant_admin_tenants_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTenantRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Admin Create Tenant Admin Tenants Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/tenants/{tenant_id}": { "get": { "tags": [ "admin" ], "summary": "Admin Get Tenant", "operationId": "admin_get_tenant_admin_tenants__tenant_id__get", "parameters": [ { "name": "tenant_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Tenant Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Admin Get Tenant Admin Tenants Tenant Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "admin" ], "summary": "Admin Patch Tenant", "operationId": "admin_patch_tenant_admin_tenants__tenant_id__patch", "parameters": [ { "name": "tenant_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Tenant Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchTenantRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Admin Patch Tenant Admin Tenants Tenant Id Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/users": { "get": { "tags": [ "admin" ], "summary": "Admin List Users", "operationId": "admin_list_users_admin_users_get", "parameters": [ { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Admin List Users Admin Users Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/tenants/{tenant_id}/authorized-domains": { "put": { "tags": [ "admin" ], "summary": "Admin Set Authorized Domains", "operationId": "admin_set_authorized_domains_admin_tenants__tenant_id__authorized_domains_put", "parameters": [ { "name": "tenant_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Tenant Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizedDomainsAdminRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Admin Set Authorized Domains Admin Tenants Tenant Id Authorized Domains Put" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/tenants/{tenant_id}/mssp-parent": { "put": { "tags": [ "admin" ], "summary": "Admin Set Mssp Parent", "description": "R3: Link child tenant to MSSP parent for portfolio / white-label.", "operationId": "admin_set_mssp_parent_admin_tenants__tenant_id__mssp_parent_put", "parameters": [ { "name": "tenant_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Tenant Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MsspParentRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Admin Set Mssp Parent Admin Tenants Tenant Id Mssp Parent Put" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/tenants/{tenant_id}/settings": { "put": { "tags": [ "admin" ], "summary": "Admin Upsert Tenant Settings", "operationId": "admin_upsert_tenant_settings_admin_tenants__tenant_id__settings_put", "parameters": [ { "name": "tenant_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Tenant Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantSettingsAdminRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Admin Upsert Tenant Settings Admin Tenants Tenant Id Settings Put" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/tenants/{tenant_id}/keys": { "post": { "tags": [ "admin" ], "summary": "Admin Issue Key", "operationId": "admin_issue_key_admin_tenants__tenant_id__keys_post", "parameters": [ { "name": "tenant_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Tenant Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueKeyRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Admin Issue Key Admin Tenants Tenant Id Keys Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "admin" ], "summary": "Admin List Keys", "operationId": "admin_list_keys_admin_tenants__tenant_id__keys_get", "parameters": [ { "name": "tenant_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Tenant Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Admin List Keys Admin Tenants Tenant Id Keys Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/keys/{key_id}": { "delete": { "tags": [ "admin" ], "summary": "Admin Revoke Key", "operationId": "admin_revoke_key_admin_keys__key_id__delete", "parameters": [ { "name": "key_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Key Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Admin Revoke Key Admin Keys Key Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/admin/analytics/funnel": { "get": { "tags": [ "admin" ], "summary": "Admin Analytics Funnel", "description": "Internal golden-path funnel snapshot from tenant product state.", "operationId": "admin_analytics_funnel_admin_analytics_funnel_get", "parameters": [ { "name": "days", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 365, "minimum": 1, "default": 30, "title": "Days" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Admin Analytics Funnel Admin Analytics Funnel Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/internal/dashboard/bootstrap": { "get": { "tags": [ "internal-dashboard" ], "summary": "Dashboard Bootstrap", "operationId": "dashboard_bootstrap_internal_dashboard_bootstrap_get", "parameters": [ { "name": "workos_user_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 3, "title": "Workos User Id" } }, { "name": "email", "in": "query", "required": true, "schema": { "type": "string", "minLength": 3, "title": "Email" } }, { "name": "name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" } }, { "name": "active_tenant_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Active Tenant Id" } }, { "name": "onboarding_token", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "minLength": 8 }, { "type": "null" } ], "title": "Onboarding Token" } }, { "name": "X-Qtangl-Bff-Secret", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Bff-Secret" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Dashboard Bootstrap Internal Dashboard Bootstrap Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/internal/dashboard/link-invite": { "post": { "tags": [ "internal-dashboard" ], "summary": "Dashboard Link Invite", "operationId": "dashboard_link_invite_internal_dashboard_link_invite_post", "parameters": [ { "name": "workos_user_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 3, "title": "Workos User Id" } }, { "name": "email", "in": "query", "required": true, "schema": { "type": "string", "minLength": 3, "title": "Email" } }, { "name": "X-Qtangl-Bff-Secret", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Bff-Secret" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Dashboard Link Invite Internal Dashboard Link Invite Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/internal/dashboard/user": { "get": { "tags": [ "internal-dashboard" ], "summary": "Dashboard User Lookup", "operationId": "dashboard_user_lookup_internal_dashboard_user_get", "parameters": [ { "name": "workos_user_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 3, "title": "Workos User Id" } }, { "name": "X-Qtangl-Bff-Secret", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Bff-Secret" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Dashboard User Lookup Internal Dashboard User Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/scans/{scan_id}/graph": { "get": { "tags": [ "tenant" ], "summary": "Tenant Scan Graph", "operationId": "tenant_scan_graph_tenant_scans__scan_id__graph_get", "parameters": [ { "name": "scan_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Scan Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScanGraphResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/hndl/exposure": { "get": { "tags": [ "tenant" ], "summary": "Tenant Hndl Exposure", "operationId": "tenant_hndl_exposure_tenant_hndl_exposure_get", "parameters": [ { "name": "scan_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scan Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HndlExposureResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/findings/{finding_id}/comments": { "get": { "tags": [ "tenant" ], "summary": "Tenant Finding Comments List", "operationId": "tenant_finding_comments_list_tenant_findings__finding_id__comments_get", "parameters": [ { "name": "finding_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Finding Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FindingCommentListResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "tenant" ], "summary": "Tenant Finding Comments Create", "operationId": "tenant_finding_comments_create_tenant_findings__finding_id__comments_post", "parameters": [ { "name": "finding_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Finding Id" } }, { "name": "scan_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scan Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FindingCommentCreate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FindingCommentListResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/findings/{finding_id}/comments/{comment_id}": { "delete": { "tags": [ "tenant" ], "summary": "Tenant Finding Comments Delete", "operationId": "tenant_finding_comments_delete_tenant_findings__finding_id__comments__comment_id__delete", "parameters": [ { "name": "finding_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Finding Id" } }, { "name": "comment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Comment Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/saved-views": { "get": { "tags": [ "tenant" ], "summary": "Tenant Saved Views List", "operationId": "tenant_saved_views_list_tenant_saved_views_get", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SavedViewListResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/saved-views/{view_id}": { "put": { "tags": [ "tenant" ], "summary": "Tenant Saved Views Upsert", "operationId": "tenant_saved_views_upsert_tenant_saved_views__view_id__put", "parameters": [ { "name": "view_id", "in": "path", "required": true, "schema": { "type": "string", "title": "View Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SavedViewCreate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SavedViewListResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "tenant" ], "summary": "Tenant Saved Views Delete", "operationId": "tenant_saved_views_delete_tenant_saved_views__view_id__delete", "parameters": [ { "name": "view_id", "in": "path", "required": true, "schema": { "type": "string", "title": "View Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/inbox": { "get": { "tags": [ "tenant" ], "summary": "Tenant Inbox", "operationId": "tenant_inbox_tenant_inbox_get", "parameters": [ { "name": "owner", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Owner" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InboxResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/war-rooms": { "get": { "tags": [ "tenant" ], "summary": "Tenant War Rooms List", "operationId": "tenant_war_rooms_list_tenant_war_rooms_get", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WarRoom" }, "title": "Response Tenant War Rooms List Tenant War Rooms Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "tenant" ], "summary": "Tenant War Rooms Create", "operationId": "tenant_war_rooms_create_tenant_war_rooms_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WarRoomCreate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WarRoom" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/ai/query": { "post": { "tags": [ "tenant" ], "summary": "Tenant Ai Query", "operationId": "tenant_ai_query_tenant_ai_query_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AiQueryRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AiQueryResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/ai/executive-narrative": { "get": { "tags": [ "tenant" ], "summary": "Tenant Executive Narrative", "operationId": "tenant_executive_narrative_tenant_ai_executive_narrative_get", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExecutiveNarrativeResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/ai/remediation-pr-draft": { "post": { "tags": [ "tenant" ], "summary": "Tenant Remediation Pr Draft", "operationId": "tenant_remediation_pr_draft_tenant_ai_remediation_pr_draft_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemediationPrDraftRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemediationPrDraftResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/ai/agentic-plan/{remediation_id}": { "get": { "tags": [ "tenant" ], "summary": "Tenant Agentic Plan", "operationId": "tenant_agentic_plan_tenant_ai_agentic_plan__remediation_id__get", "parameters": [ { "name": "remediation_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Remediation Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgenticPlanResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/incidents/correlated": { "get": { "tags": [ "tenant" ], "summary": "Tenant Correlated Incidents", "operationId": "tenant_correlated_incidents_tenant_incidents_correlated_get", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CorrelatedIncidentsResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/cadence/recommendation": { "get": { "tags": [ "tenant" ], "summary": "Tenant Cadence Recommendation", "operationId": "tenant_cadence_recommendation_tenant_cadence_recommendation_get", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CadenceRecommendation" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/analytics/anomaly-explanations": { "get": { "tags": [ "tenant" ], "summary": "Tenant Anomaly Explanations", "operationId": "tenant_anomaly_explanations_tenant_analytics_anomaly_explanations_get", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Anomaly Explanations Tenant Analytics Anomaly Explanations Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/analytics/trajectory-forecast": { "get": { "tags": [ "tenant" ], "summary": "Tenant Trajectory Forecast", "operationId": "tenant_trajectory_forecast_tenant_analytics_trajectory_forecast_get", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Trajectory Forecast Tenant Analytics Trajectory Forecast Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/evidence/transparency": { "get": { "tags": [ "tenant" ], "summary": "Tenant Evidence Transparency", "operationId": "tenant_evidence_transparency_tenant_evidence_transparency_get", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransparencyLogResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/evidence/auditor-packet": { "post": { "tags": [ "tenant" ], "summary": "Tenant Auditor Packet", "operationId": "tenant_auditor_packet_tenant_evidence_auditor_packet_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuditorPacketResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/portfolio/rollup": { "get": { "tags": [ "tenant" ], "summary": "Tenant Portfolio Rollup", "operationId": "tenant_portfolio_rollup_tenant_portfolio_rollup_get", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortfolioRollupResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/benchmarks/percentiles": { "get": { "tags": [ "tenant" ], "summary": "Tenant Benchmark Percentiles", "operationId": "tenant_benchmark_percentiles_tenant_benchmarks_percentiles_get", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PeerPercentileResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/notification-preferences": { "get": { "tags": [ "tenant" ], "summary": "Tenant Notification Preferences Get", "operationId": "tenant_notification_preferences_get_tenant_notification_preferences_get", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationPreferences" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "tenant" ], "summary": "Tenant Notification Preferences Put", "operationId": "tenant_notification_preferences_put_tenant_notification_preferences_put", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationPreferences" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationPreferences" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/qros/next-actions": { "get": { "tags": [ "tenant" ], "summary": "Tenant Qros Next Actions", "operationId": "tenant_qros_next_actions_tenant_qros_next_actions_get", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NextBestActionResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/qros/next-actions/{action_id}/mutate": { "post": { "tags": [ "tenant" ], "summary": "Tenant Qros Nba Mutate", "operationId": "tenant_qros_nba_mutate_tenant_qros_next_actions__action_id__mutate_post", "parameters": [ { "name": "action_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Action Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NbaActionRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Qros Nba Mutate Tenant Qros Next Actions Action Id Mutate Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/qros/morning-briefing": { "get": { "tags": [ "tenant" ], "summary": "Tenant Qros Morning Briefing", "operationId": "tenant_qros_morning_briefing_tenant_qros_morning_briefing_get", "parameters": [ { "name": "persona", "in": "query", "required": false, "schema": { "type": "string", "default": "operator", "title": "Persona" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MorningBriefingResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/qros/runway": { "get": { "tags": [ "tenant" ], "summary": "Tenant Qros Runway", "operationId": "tenant_qros_runway_tenant_qros_runway_get", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunwayResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/qros/scenario/simulate": { "post": { "tags": [ "tenant" ], "summary": "Tenant Qros Scenario Simulate", "operationId": "tenant_qros_scenario_simulate_tenant_qros_scenario_simulate_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScenarioSimRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScenarioSimResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/qros/digital-twin/{scan_id}": { "get": { "tags": [ "tenant" ], "summary": "Tenant Qros Digital Twin", "operationId": "tenant_qros_digital_twin_tenant_qros_digital_twin__scan_id__get", "parameters": [ { "name": "scan_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Scan Id" } }, { "name": "selectedNodeId", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Selectednodeid" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DigitalTwinResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/qros/board-deck": { "post": { "tags": [ "tenant" ], "summary": "Tenant Qros Board Deck", "operationId": "tenant_qros_board_deck_tenant_qros_board_deck_post", "parameters": [ { "name": "format", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Format" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/qros/agentic/execute": { "post": { "tags": [ "tenant" ], "summary": "Tenant Qros Agentic Execute", "operationId": "tenant_qros_agentic_execute_tenant_qros_agentic_execute_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgenticActionRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgenticActionResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/qros/marketplace/tiles": { "get": { "tags": [ "tenant" ], "summary": "Tenant Qros Marketplace Tiles", "operationId": "tenant_qros_marketplace_tiles_tenant_qros_marketplace_tiles_get", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarketplaceResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/qros/marketplace/tiles/{tile_id}/install": { "post": { "tags": [ "tenant" ], "summary": "Tenant Qros Marketplace Install", "operationId": "tenant_qros_marketplace_install_tenant_qros_marketplace_tiles__tile_id__install_post", "parameters": [ { "name": "tile_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Tile Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarketplaceResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "tenant" ], "summary": "Tenant Qros Marketplace Uninstall", "operationId": "tenant_qros_marketplace_uninstall_tenant_qros_marketplace_tiles__tile_id__install_delete", "parameters": [ { "name": "tile_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Tile Id" } }, { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/qros/push-briefing/send": { "post": { "tags": [ "tenant" ], "summary": "Tenant Qros Push Briefing Send", "operationId": "tenant_qros_push_briefing_send_tenant_qros_push_briefing_send_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PushBriefingRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Qros Push Briefing Send Tenant Qros Push Briefing Send Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/tenant/qros/push-briefing": { "post": { "tags": [ "tenant" ], "summary": "Tenant Qros Push Briefing", "operationId": "tenant_qros_push_briefing_tenant_qros_push_briefing_post", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "count_toward_rate_limit", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Count Toward Rate Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "X-Qtangl-Session", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Qtangl-Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PushBriefingRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Qros Push Briefing Tenant Qros Push Briefing Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "tenant" ], "summary": "Tenant Qros Push Briefing Preferences", "operationId": "tenant_qros_push_briefing_preferences_tenant_qros_push_briefing_get", "parameters": [ { "name": "api_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Tenant Qros Push Briefing Preferences Tenant Qros Push Briefing Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/demo/status": { "get": { "tags": [ "demo" ], "summary": "Demo Status", "operationId": "demo_status_demo_status_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Demo Status Demo Status Get" } } } } } } }, "/demo/trend": { "get": { "tags": [ "demo" ], "summary": "Demo Trend", "operationId": "demo_trend_demo_trend_get", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 30, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Demo Trend Demo Trend Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/demo/resources": { "get": { "tags": [ "demo" ], "summary": "Demo List Resources", "operationId": "demo_list_resources_demo_resources_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Demo List Resources Demo Resources Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "demo" ], "summary": "Demo Create Resource", "operationId": "demo_create_resource_demo_resources_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DemoResourceCreate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Demo Create Resource Demo Resources Post" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/demo/resources/{resource_id}": { "patch": { "tags": [ "demo" ], "summary": "Demo Patch Resource", "operationId": "demo_patch_resource_demo_resources__resource_id__patch", "parameters": [ { "name": "resource_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Resource Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DemoResourcePatch" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Demo Patch Resource Demo Resources Resource Id Patch" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "demo" ], "summary": "Demo Delete Resource", "operationId": "demo_delete_resource_demo_resources__resource_id__delete", "parameters": [ { "name": "resource_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Resource Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Demo Delete Resource Demo Resources Resource Id Delete" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/demo/reassess": { "post": { "tags": [ "demo" ], "summary": "Demo Reassess", "operationId": "demo_reassess_demo_reassess_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Demo Reassess Demo Reassess Post" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/demo/scene/{scene_id}": { "post": { "tags": [ "demo" ], "summary": "Demo Apply Scene", "operationId": "demo_apply_scene_demo_scene__scene_id__post", "parameters": [ { "name": "scene_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Scene Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Demo Apply Scene Demo Scene Scene Id Post" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/demo/scenes": { "get": { "tags": [ "demo" ], "summary": "Demo Scenes", "operationId": "demo_scenes_demo_scenes_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Demo Scenes Demo Scenes Get" } } } } } } }, "/demo/inject": { "post": { "tags": [ "demo" ], "summary": "Demo Inject", "operationId": "demo_inject_demo_inject_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InjectRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Demo Inject Demo Inject Post" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/demo/chaos": { "post": { "tags": [ "demo" ], "summary": "Demo Chaos", "operationId": "demo_chaos_demo_chaos_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChaosRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Demo Chaos Demo Chaos Post" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/demo/campaigns": { "get": { "tags": [ "demo" ], "summary": "Demo Campaigns", "operationId": "demo_campaigns_demo_campaigns_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Demo Campaigns Demo Campaigns Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/demo/campaign": { "post": { "tags": [ "demo" ], "summary": "Demo Save Campaign", "operationId": "demo_save_campaign_demo_campaign_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignCreate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Demo Save Campaign Demo Campaign Post" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/demo/campaign/{campaign_id}/play": { "post": { "tags": [ "demo" ], "summary": "Demo Play Campaign", "operationId": "demo_play_campaign_demo_campaign__campaign_id__play_post", "parameters": [ { "name": "campaign_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Campaign Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Demo Play Campaign Demo Campaign Campaign Id Play Post" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/demo/campaign/{campaign_id}/pause": { "post": { "tags": [ "demo" ], "summary": "Demo Pause Campaign", "operationId": "demo_pause_campaign_demo_campaign__campaign_id__pause_post", "parameters": [ { "name": "campaign_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Campaign Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Demo Pause Campaign Demo Campaign Campaign Id Pause Post" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/demo/campaign/{campaign_id}/state": { "get": { "tags": [ "demo" ], "summary": "Demo Campaign State", "operationId": "demo_campaign_state_demo_campaign__campaign_id__state_get", "parameters": [ { "name": "campaign_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Campaign Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Demo Campaign State Demo Campaign Campaign Id State Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/demo/campaign/{campaign_id}/scrub": { "post": { "tags": [ "demo" ], "summary": "Demo Scrub Campaign", "operationId": "demo_scrub_campaign_demo_campaign__campaign_id__scrub_post", "parameters": [ { "name": "campaign_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Campaign Id" } }, { "name": "stepIndex", "in": "query", "required": false, "schema": { "type": "integer", "default": 0, "title": "Stepindex" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-api-key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Demo Scrub Campaign Demo Campaign Campaign Id Scrub Post" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/demo/compliance": { "get": { "tags": [ "demo" ], "summary": "Demo Compliance", "operationId": "demo_compliance_demo_compliance_get", "parameters": [ { "name": "scanId", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scanid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Demo Compliance Demo Compliance Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/demo/portfolio": { "get": { "tags": [ "demo" ], "summary": "Demo Portfolio", "operationId": "demo_portfolio_demo_portfolio_get", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 30, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Demo Portfolio Demo Portfolio Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/demo/graph": { "get": { "tags": [ "demo" ], "summary": "Demo Graph", "operationId": "demo_graph_demo_graph_get", "parameters": [ { "name": "scanId", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scanid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Demo Graph Demo Graph Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/demo/narration": { "get": { "tags": [ "demo" ], "summary": "Demo Narration", "operationId": "demo_narration_demo_narration_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Demo Narration Demo Narration Get" } } } } } } }, "/demo/verify/{snapshot_id}": { "get": { "tags": [ "demo" ], "summary": "Demo Verify", "operationId": "demo_verify_demo_verify__snapshot_id__get", "parameters": [ { "name": "snapshot_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Snapshot Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Demo Verify Demo Verify Snapshot Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/demo/events": { "get": { "tags": [ "demo" ], "summary": "Demo Events", "operationId": "demo_events_demo_events_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/public/verify/branding": { "get": { "tags": [ "public" ], "summary": "Public Verify Branding", "description": "Public co-branding for verify page and share links (resolved MSSP parent + child).", "operationId": "public_verify_branding_public_verify_branding_get", "parameters": [ { "name": "scanId", "in": "query", "required": true, "schema": { "type": "string", "minLength": 3, "maxLength": 120, "title": "Scanid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Public Verify Branding Public Verify Branding Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/public/assess-signup": { "post": { "tags": [ "public" ], "summary": "Public Assess Signup", "description": "Self-serve Assess signup \u2014 free tier tenant + onboarding token.", "operationId": "public_assess_signup_public_assess_signup_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssessSignupRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Public Assess Signup Public Assess Signup Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/public/monitor-signup": { "post": { "tags": [ "public" ], "summary": "Public Monitor Signup", "description": "Start Monitor tier checkout (Stripe) or return contact instructions.", "operationId": "public_monitor_signup_public_monitor_signup_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MonitorSignupRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Public Monitor Signup Public Monitor Signup Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/public/monitor-provision": { "post": { "tags": [ "public" ], "summary": "Public Monitor Provision", "description": "Manual provision after Stripe payment (webhook alternative for pilots).", "operationId": "public_monitor_provision_public_monitor_provision_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MonitorProvisionRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Public Monitor Provision Public Monitor Provision Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/public/lead-capture": { "post": { "tags": [ "public" ], "summary": "Public Lead Capture", "description": "Capture mini-assessment lead and trigger onboarding drip step 1.", "operationId": "public_lead_capture_public_lead_capture_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeadCaptureRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Public Lead Capture Public Lead Capture Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/public/unsubscribe": { "post": { "tags": [ "public" ], "summary": "Public Unsubscribe", "operationId": "public_unsubscribe_public_unsubscribe_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnsubscribeRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Public Unsubscribe Public Unsubscribe Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/public/onboarding-key/{token}": { "get": { "tags": [ "public" ], "summary": "Public Redeem Onboarding Key", "description": "Onboarding after Assess/Monitor signup (24h TTL). Use peek=true for assess-first (non-destructive).", "operationId": "public_redeem_onboarding_key_public_onboarding_key__token__get", "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string", "title": "Token" } }, { "name": "peek", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Peek" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Public Redeem Onboarding Key Public Onboarding Key Token Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/public/workos/webhook": { "post": { "tags": [ "public" ], "summary": "Workos Webhook", "operationId": "workos_webhook_public_workos_webhook_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Workos Webhook Public Workos Webhook Post" } } } } } } }, "/public/stripe-webhook": { "post": { "tags": [ "public" ], "summary": "Stripe Webhook", "description": "Stripe lifecycle events \u2192 provision or update Monitor tenant.", "operationId": "stripe_webhook_public_stripe_webhook_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Stripe Webhook Public Stripe Webhook Post" } } } } } } }, "/health": { "get": { "tags": [ "health" ], "summary": "Health", "operationId": "health_health_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Response Health Health Get" } } } } } } }, "/health/ready": { "get": { "tags": [ "health" ], "summary": "Health Ready", "operationId": "health_ready_health_ready_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Health Ready Health Ready Get" } } } } } } }, "/metrics": { "get": { "tags": [ "health" ], "summary": "Metrics Endpoint", "operationId": "metrics_endpoint_metrics_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/r/{token}": { "get": { "tags": [ "sharing" ], "summary": "Shared Report Readonly", "description": "Expiring read-only report summary via signed share token.", "operationId": "shared_report_readonly_r__token__get", "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string", "title": "Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Shared Report Readonly R Token Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/r/{token}/report": { "get": { "tags": [ "sharing" ], "summary": "Shared Report Download", "description": "Download PDF or evidence bundle via expiring share token (no API key).", "operationId": "shared_report_download_r__token__report_get", "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string", "title": "Token" } }, { "name": "format", "in": "query", "required": false, "schema": { "type": "string", "default": "pdf", "title": "Format" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } } }, "components": { "schemas": { "AgenticActionRequest": { "properties": { "action": { "type": "string", "maxLength": 64, "minLength": 1, "title": "Action" }, "payload": { "additionalProperties": true, "type": "object", "title": "Payload" }, "dryRun": { "type": "boolean", "title": "Dryrun", "default": true }, "approved": { "type": "boolean", "title": "Approved", "default": false } }, "type": "object", "required": [ "action" ], "title": "AgenticActionRequest" }, "AgenticActionResponse": { "properties": { "action": { "type": "string", "title": "Action" }, "dryRun": { "type": "boolean", "title": "Dryrun" }, "status": { "type": "string", "title": "Status" }, "steps": { "items": { "type": "string" }, "type": "array", "title": "Steps" }, "payload": { "additionalProperties": true, "type": "object", "title": "Payload" }, "guardrails": { "items": { "type": "string" }, "type": "array", "title": "Guardrails" } }, "type": "object", "required": [ "action", "dryRun", "status", "steps" ], "title": "AgenticActionResponse" }, "AgenticPlanResponse": { "properties": { "remediationId": { "type": "string", "title": "Remediationid" }, "steps": { "items": { "$ref": "#/components/schemas/AgenticPlanStep" }, "type": "array", "title": "Steps" }, "assumptions": { "items": { "type": "string" }, "type": "array", "title": "Assumptions" } }, "type": "object", "required": [ "remediationId", "steps" ], "title": "AgenticPlanResponse" }, "AgenticPlanStep": { "properties": { "id": { "type": "string", "title": "Id" }, "label": { "type": "string", "title": "Label" }, "status": { "type": "string", "enum": [ "pending", "approved", "completed", "skipped" ], "title": "Status", "default": "pending" }, "requiresApproval": { "type": "boolean", "title": "Requiresapproval", "default": true } }, "type": "object", "required": [ "id", "label" ], "title": "AgenticPlanStep" }, "AiCitation": { "properties": { "kind": { "type": "string", "title": "Kind" }, "ref": { "type": "string", "title": "Ref" }, "label": { "type": "string", "title": "Label" } }, "type": "object", "required": [ "kind", "ref", "label" ], "title": "AiCitation" }, "AiQueryRequest": { "properties": { "query": { "type": "string", "maxLength": 2000, "minLength": 1, "title": "Query" }, "persona": { "type": "string", "title": "Persona", "default": "operator" } }, "type": "object", "required": [ "query" ], "title": "AiQueryRequest" }, "AiQueryResponse": { "properties": { "answer": { "type": "string", "title": "Answer" }, "intent": { "type": "string", "title": "Intent" }, "filters": { "additionalProperties": true, "type": "object", "title": "Filters" }, "citations": { "items": { "$ref": "#/components/schemas/AiCitation" }, "type": "array", "title": "Citations" }, "confidence": { "type": "string", "enum": [ "low", "medium", "high" ], "title": "Confidence", "default": "medium" }, "assumptions": { "items": { "type": "string" }, "type": "array", "title": "Assumptions" }, "guardrailPassed": { "type": "boolean", "title": "Guardrailpassed", "default": true } }, "type": "object", "required": [ "answer", "intent" ], "title": "AiQueryResponse" }, "AirlineSolveRequest": { "properties": { "scenarioId": { "type": "string", "title": "Scenarioid", "default": "mx-hold-ord-0612" }, "useFixture": { "type": "boolean", "title": "Usefixture", "default": true }, "seed": { "type": "integer", "title": "Seed", "default": 1234 }, "crewSessionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Crewsessionid" } }, "type": "object", "title": "AirlineSolveRequest" }, "ApiKeyCreateRequest": { "properties": { "label": { "type": "string", "maxLength": 64, "title": "Label", "default": "automation" }, "role": { "type": "string", "pattern": "^(admin|operator|executive|viewer)$", "title": "Role", "default": "operator" } }, "type": "object", "title": "ApiKeyCreateRequest" }, "AssessSignupRequest": { "properties": { "email": { "type": "string", "maxLength": 320, "minLength": 3, "title": "Email" }, "company": { "type": "string", "maxLength": 200, "minLength": 2, "title": "Company" }, "domain": { "anyOf": [ { "type": "string", "maxLength": 253 }, { "type": "null" } ], "title": "Domain" } }, "type": "object", "required": [ "email", "company" ], "title": "AssessSignupRequest" }, "AuditorPacketResponse": { "properties": { "scanIds": { "items": { "type": "string" }, "type": "array", "title": "Scanids" }, "bundleUrls": { "items": { "type": "string" }, "type": "array", "title": "Bundleurls" }, "verifyCli": { "type": "string", "title": "Verifycli" }, "caveats": { "items": { "type": "string" }, "type": "array", "title": "Caveats" } }, "type": "object", "required": [ "scanIds", "bundleUrls", "verifyCli", "caveats" ], "title": "AuditorPacketResponse" }, "AuthorizedDomainsAdminRequest": { "properties": { "domains": { "items": { "type": "string" }, "type": "array", "maxItems": 100, "title": "Domains" }, "attestation": { "type": "string", "maxLength": 4000, "title": "Attestation", "default": "Sales-led provisioning" } }, "type": "object", "title": "AuthorizedDomainsAdminRequest" }, "AuthorizedDomainsPatchRequest": { "properties": { "action": { "type": "string", "pattern": "^(add|remove|add_many)$", "title": "Action" }, "domain": { "anyOf": [ { "type": "string", "maxLength": 253 }, { "type": "null" } ], "title": "Domain" }, "domains": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "maxItems": 50 }, { "type": "null" } ], "title": "Domains" }, "attestation": { "anyOf": [ { "type": "string", "maxLength": 4000 }, { "type": "null" } ], "title": "Attestation" } }, "type": "object", "required": [ "action" ], "title": "AuthorizedDomainsPatchRequest" }, "AuthorizedDomainsRequest": { "properties": { "domains": { "items": { "type": "string" }, "type": "array", "maxItems": 50, "title": "Domains" }, "attestation": { "type": "string", "maxLength": 4000, "minLength": 10, "title": "Attestation" } }, "type": "object", "required": [ "attestation" ], "title": "AuthorizedDomainsRequest" }, "BatchScanRequest": { "properties": { "domains": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "maxItems": 50 }, { "type": "null" } ], "title": "Domains" }, "industry": { "anyOf": [ { "type": "string", "maxLength": 64 }, { "type": "null" } ], "title": "Industry" }, "depth": { "type": "string", "pattern": "^(standard|lite)$", "title": "Depth", "default": "standard" }, "createSchedules": { "type": "boolean", "title": "Createschedules", "default": false }, "scheduleCadenceHours": { "type": "integer", "maximum": 8760.0, "minimum": 1.0, "title": "Schedulecadencehours", "default": 168 }, "notifyEmail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Notifyemail" }, "skipExistingSchedules": { "type": "boolean", "title": "Skipexistingschedules", "default": true } }, "type": "object", "title": "BatchScanRequest" }, "BatchScheduleRequest": { "properties": { "targets": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "maxItems": 50 }, { "type": "null" } ], "title": "Targets" }, "cadenceHours": { "type": "integer", "maximum": 8760.0, "minimum": 1.0, "title": "Cadencehours", "default": 168 }, "notifyEmail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Notifyemail" }, "scenarioId": { "type": "string", "title": "Scenarioid", "default": "production-baseline" }, "skipExisting": { "type": "boolean", "title": "Skipexisting", "default": true } }, "type": "object", "title": "BatchScheduleRequest" }, "BillingCheckoutBody": { "properties": { "product": { "type": "string", "pattern": "^(assess|monitor)$", "title": "Product" }, "successUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Successurl" }, "cancelUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cancelurl" } }, "type": "object", "required": [ "product" ], "title": "BillingCheckoutBody" }, "Body_upload_bundle_pqc_upload_bundle_post": { "properties": { "file": { "type": "string", "contentMediaType": "application/octet-stream", "title": "File" } }, "type": "object", "required": [ "file" ], "title": "Body_upload_bundle_pqc_upload_bundle_post" }, "Body_upload_crew_airline_upload_crew_post": { "properties": { "file": { "type": "string", "contentMediaType": "application/octet-stream", "title": "File" } }, "type": "object", "required": [ "file" ], "title": "Body_upload_crew_airline_upload_crew_post" }, "Body_upload_fleet_ev_fleet_upload_fleet_post": { "properties": { "file": { "type": "string", "contentMediaType": "application/octet-stream", "title": "File" } }, "type": "object", "required": [ "file" ], "title": "Body_upload_fleet_ev_fleet_upload_fleet_post" }, "Body_upload_roster_hospital_upload_roster_post": { "properties": { "file": { "type": "string", "contentMediaType": "application/octet-stream", "title": "File" } }, "type": "object", "required": [ "file" ], "title": "Body_upload_roster_hospital_upload_roster_post" }, "Body_upload_stops_ev_fleet_upload_stops_post": { "properties": { "file": { "type": "string", "contentMediaType": "application/octet-stream", "title": "File" } }, "type": "object", "required": [ "file" ], "title": "Body_upload_stops_ev_fleet_upload_stops_post" }, "BulkExportRequest": { "properties": { "scanIds": { "items": { "type": "string" }, "type": "array", "title": "Scanids" } }, "type": "object", "title": "BulkExportRequest" }, "CadenceRecommendation": { "properties": { "currentCadenceHours": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Currentcadencehours" }, "recommendedCadenceHours": { "type": "integer", "title": "Recommendedcadencehours" }, "volatilityScore": { "type": "number", "title": "Volatilityscore" }, "rationale": { "type": "string", "title": "Rationale" }, "assumptions": { "items": { "type": "string" }, "type": "array", "title": "Assumptions" } }, "type": "object", "required": [ "recommendedCadenceHours", "volatilityScore", "rationale" ], "title": "CadenceRecommendation" }, "CampaignCreate": { "properties": { "name": { "type": "string", "maxLength": 200, "minLength": 1, "title": "Name" }, "steps": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Steps" } }, "type": "object", "required": [ "name" ], "title": "CampaignCreate" }, "CbomConflictResolveRequest": { "properties": { "resolvedValue": { "type": "string", "title": "Resolvedvalue" } }, "type": "object", "required": [ "resolvedValue" ], "title": "CbomConflictResolveRequest" }, "ChaosRequest": { "properties": { "enabled": { "type": "boolean", "title": "Enabled" } }, "type": "object", "required": [ "enabled" ], "title": "ChaosRequest" }, "ClmIntegrationRequest": { "properties": { "apiKey": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Apikey" }, "host": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Host" }, "token": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Token" }, "tenant": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant" } }, "type": "object", "title": "ClmIntegrationRequest" }, "CloudIntegrationRequest": { "properties": { "region": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Region" }, "vaultName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vaultname" }, "roleArn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Rolearn" }, "externalId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Externalid" }, "projectId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Projectid" }, "credentialsJson": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Credentialsjson" }, "kubeconfigJson": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Kubeconfigjson" }, "namespace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Namespace" }, "context": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Context" }, "tenantId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenantid" }, "clientId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Clientid" }, "clientSecret": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Clientsecret" } }, "type": "object", "title": "CloudIntegrationRequest" }, "CorrelatedIncident": { "properties": { "id": { "type": "string", "title": "Id" }, "title": { "type": "string", "title": "Title" }, "alertIds": { "items": { "type": "string" }, "type": "array", "title": "Alertids" }, "correlationKeys": { "items": { "type": "string" }, "type": "array", "title": "Correlationkeys" }, "severity": { "type": "string", "title": "Severity" }, "summary": { "type": "string", "title": "Summary" }, "createdAt": { "type": "string", "title": "Createdat" } }, "type": "object", "required": [ "id", "title", "alertIds", "correlationKeys", "severity", "summary", "createdAt" ], "title": "CorrelatedIncident" }, "CorrelatedIncidentsResponse": { "properties": { "incidents": { "items": { "$ref": "#/components/schemas/CorrelatedIncident" }, "type": "array", "title": "Incidents" } }, "type": "object", "required": [ "incidents" ], "title": "CorrelatedIncidentsResponse" }, "CreateTenantRequest": { "properties": { "name": { "type": "string", "maxLength": 200, "minLength": 1, "title": "Name" }, "tenantId": { "anyOf": [ { "type": "string", "maxLength": 64 }, { "type": "null" } ], "title": "Tenantid" }, "tier": { "type": "string", "pattern": "^(free|monitor|convert|enterprise)$", "title": "Tier", "default": "monitor" } }, "type": "object", "required": [ "name" ], "title": "CreateTenantRequest" }, "DeadLetterReplayRequest": { "properties": { "deadLetterId": { "type": "string", "title": "Deadletterid" } }, "type": "object", "required": [ "deadLetterId" ], "title": "DeadLetterReplayRequest" }, "DemoResourceCreate": { "properties": { "label": { "type": "string", "maxLength": 200, "minLength": 1, "title": "Label" }, "kind": { "type": "string", "title": "Kind", "default": "tls" }, "host": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Host" }, "port": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Port" }, "businessUnit": { "type": "string", "maxLength": 64, "title": "Businessunit", "default": "default" }, "posture": { "type": "string", "title": "Posture", "default": "classical" }, "complianceTarget": { "type": "string", "title": "Compliancetarget", "default": "general" }, "enabled": { "type": "boolean", "title": "Enabled", "default": true } }, "type": "object", "required": [ "label", "host" ], "title": "DemoResourceCreate" }, "DemoResourcePatch": { "properties": { "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Label" }, "posture": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Posture" }, "complianceTarget": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Compliancetarget" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enabled" }, "activeEvents": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Activeevents" } }, "type": "object", "title": "DemoResourcePatch" }, "DigestPreviewRequest": { "properties": { "recipients": { "items": { "type": "string" }, "type": "array", "title": "Recipients" } }, "type": "object", "title": "DigestPreviewRequest" }, "DigitalTwinResponse": { "properties": { "graph": { "additionalProperties": true, "type": "object", "title": "Graph" }, "selectedNodeId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Selectednodeid" }, "blastRadius": { "items": { "type": "string" }, "type": "array", "title": "Blastradius" }, "simulationNote": { "type": "string", "title": "Simulationnote" } }, "type": "object", "required": [ "graph", "blastRadius", "simulationNote" ], "title": "DigitalTwinResponse" }, "EmailReportRequest": { "properties": { "email": { "type": "string", "title": "Email" }, "format": { "type": "string", "pattern": "^(board|pdf)$", "title": "Format", "default": "board" } }, "type": "object", "required": [ "email" ], "title": "EmailReportRequest" }, "ErrorResponse": { "properties": { "status": { "type": "string", "const": "error", "title": "Status" }, "message": { "type": "string", "title": "Message" } }, "type": "object", "required": [ "status", "message" ], "title": "ErrorResponse" }, "EvFleetSolveRequest": { "properties": { "scenarioId": { "type": "string", "title": "Scenarioid", "default": "tou-peak-ca" }, "useFixture": { "type": "boolean", "title": "Usefixture", "default": true }, "seed": { "type": "integer", "title": "Seed", "default": 1234 }, "fleetSessionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Fleetsessionid" }, "stopsSessionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stopssessionid" } }, "type": "object", "title": "EvFleetSolveRequest" }, "ExecutiveNarrativeResponse": { "properties": { "narrative": { "type": "string", "title": "Narrative" }, "citations": { "items": { "$ref": "#/components/schemas/AiCitation" }, "type": "array", "title": "Citations" }, "confidence": { "type": "string", "enum": [ "low", "medium", "high" ], "title": "Confidence", "default": "medium" }, "assumptions": { "items": { "type": "string" }, "type": "array", "title": "Assumptions" } }, "type": "object", "required": [ "narrative" ], "title": "ExecutiveNarrativeResponse" }, "FindingComment": { "properties": { "id": { "type": "string", "title": "Id" }, "findingId": { "type": "string", "title": "Findingid" }, "scanId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scanid" }, "author": { "type": "string", "title": "Author" }, "body": { "type": "string", "title": "Body" }, "mentions": { "items": { "type": "string" }, "type": "array", "title": "Mentions" }, "createdAt": { "type": "string", "title": "Createdat" }, "updatedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updatedat" } }, "type": "object", "required": [ "id", "findingId", "author", "body", "createdAt" ], "title": "FindingComment" }, "FindingCommentCreate": { "properties": { "body": { "type": "string", "maxLength": 8000, "minLength": 1, "title": "Body" }, "mentions": { "items": { "type": "string" }, "type": "array", "maxItems": 20, "title": "Mentions" } }, "type": "object", "required": [ "body" ], "title": "FindingCommentCreate" }, "FindingCommentListResponse": { "properties": { "findingId": { "type": "string", "title": "Findingid" }, "comments": { "items": { "$ref": "#/components/schemas/FindingComment" }, "type": "array", "title": "Comments" }, "total": { "type": "integer", "title": "Total" } }, "type": "object", "required": [ "findingId", "comments", "total" ], "title": "FindingCommentListResponse" }, "FlipApproveRequest": { "properties": { "approvalNote": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Approvalnote" }, "childTenantId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Childtenantid" } }, "type": "object", "title": "FlipApproveRequest" }, "FlipCancelRequest": { "properties": { "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reason" } }, "type": "object", "title": "FlipCancelRequest" }, "FlipDryRunRequest": { "properties": { "flipSurface": { "type": "string", "title": "Flipsurface" }, "provider": { "type": "string", "title": "Provider" }, "targetEnv": { "type": "string", "title": "Targetenv", "default": "staging" }, "request": { "additionalProperties": true, "type": "object", "title": "Request" } }, "type": "object", "required": [ "flipSurface", "provider" ], "title": "FlipDryRunRequest" }, "FlipSubmitRequest": { "properties": { "flipSurface": { "type": "string", "title": "Flipsurface" }, "provider": { "type": "string", "title": "Provider" }, "targetEnv": { "type": "string", "title": "Targetenv", "default": "staging" }, "request": { "additionalProperties": true, "type": "object", "title": "Request" }, "skipApproval": { "type": "boolean", "title": "Skipapproval", "default": false } }, "type": "object", "required": [ "flipSurface", "provider" ], "title": "FlipSubmitRequest" }, "GraphEdge": { "properties": { "source": { "type": "string", "title": "Source" }, "target": { "type": "string", "title": "Target" }, "kind": { "type": "string", "title": "Kind", "default": "depends_on" } }, "type": "object", "required": [ "source", "target" ], "title": "GraphEdge" }, "GraphNode": { "properties": { "id": { "type": "string", "title": "Id" }, "label": { "type": "string", "title": "Label" }, "kind": { "type": "string", "enum": [ "host", "service", "cert", "algorithm" ], "title": "Kind" }, "quantumVulnerable": { "type": "boolean", "title": "Quantumvulnerable", "default": false }, "severity": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Severity" }, "drillTarget": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Drilltarget" } }, "type": "object", "required": [ "id", "label", "kind" ], "title": "GraphNode" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "HndlAssetExposure": { "properties": { "assetId": { "type": "string", "title": "Assetid" }, "host": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Host" }, "algorithm": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Algorithm" }, "exposureScore": { "type": "number", "title": "Exposurescore" }, "exposureBand": { "type": "string", "enum": [ "low", "moderate", "elevated", "critical" ], "title": "Exposureband" }, "hndlExposed": { "type": "boolean", "title": "Hndlexposed" }, "forwardSecrecy": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Forwardsecrecy" }, "dataSensitivity": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Datasensitivity" }, "verdict": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Verdict" } }, "type": "object", "required": [ "assetId", "exposureScore", "exposureBand", "hndlExposed" ], "title": "HndlAssetExposure" }, "HndlExposureResponse": { "properties": { "scanId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scanid" }, "totalAssets": { "type": "integer", "title": "Totalassets" }, "exposedCount": { "type": "integer", "title": "Exposedcount" }, "items": { "items": { "$ref": "#/components/schemas/HndlAssetExposure" }, "type": "array", "title": "Items" }, "framing": { "type": "string", "title": "Framing", "default": "Exposure window quantification based on long-lived secrets and algorithm class \u2014 not a prediction of when cryptography breaks." }, "assumptions": { "items": { "type": "string" }, "type": "array", "title": "Assumptions" } }, "type": "object", "required": [ "totalAssets", "exposedCount", "items" ], "title": "HndlExposureResponse" }, "HospitalSolveRequest": { "properties": { "scenarioId": { "type": "string", "title": "Scenarioid", "default": "callout-cath-acls" }, "useFixture": { "type": "boolean", "title": "Usefixture", "default": true }, "seed": { "type": "integer", "title": "Seed", "default": 1234 }, "rosterSessionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Rostersessionid" } }, "type": "object", "title": "HospitalSolveRequest" }, "InboxItem": { "properties": { "id": { "type": "string", "title": "Id" }, "kind": { "type": "string", "enum": [ "remediation", "alert", "scan" ], "title": "Kind" }, "title": { "type": "string", "title": "Title" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" }, "owner": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Owner" }, "dueAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Dueat" }, "deepLink": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Deeplink" }, "severity": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Severity" } }, "type": "object", "required": [ "id", "kind", "title" ], "title": "InboxItem" }, "InboxResponse": { "properties": { "owner": { "type": "string", "title": "Owner" }, "items": { "items": { "$ref": "#/components/schemas/InboxItem" }, "type": "array", "title": "Items" }, "total": { "type": "integer", "title": "Total" } }, "type": "object", "required": [ "owner", "items", "total" ], "title": "InboxResponse" }, "InjectRequest": { "properties": { "eventType": { "type": "string", "title": "Eventtype" }, "resourceId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Resourceid" } }, "type": "object", "required": [ "eventType" ], "title": "InjectRequest" }, "IntegrationConfigRequest": { "properties": { "config": { "additionalProperties": true, "type": "object", "title": "Config" } }, "type": "object", "title": "IntegrationConfigRequest" }, "IntegrationPullRequest": { "properties": { "remediationId": { "type": "string", "title": "Remediationid" } }, "type": "object", "required": [ "remediationId" ], "title": "IntegrationPullRequest" }, "IntegrationPushRequest": { "properties": { "remediationId": { "type": "string", "title": "Remediationid" }, "provider": { "type": "string", "title": "Provider", "default": "jira" } }, "type": "object", "required": [ "remediationId" ], "title": "IntegrationPushRequest" }, "IssueKeyRequest": { "properties": { "label": { "type": "string", "maxLength": 64, "title": "Label", "default": "default" } }, "type": "object", "title": "IssueKeyRequest" }, "KeyfactorIntegrationRequest": { "properties": { "baseUrl": { "type": "string", "title": "Baseurl" }, "apiToken": { "type": "string", "title": "Apitoken" }, "collectionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Collectionid" }, "writeBackEnabled": { "type": "boolean", "title": "Writebackenabled", "default": false } }, "type": "object", "required": [ "baseUrl", "apiToken" ], "title": "KeyfactorIntegrationRequest" }, "LeadCaptureRequest": { "properties": { "email": { "type": "string", "maxLength": 320, "minLength": 3, "title": "Email" }, "source": { "type": "string", "maxLength": 128, "title": "Source", "default": "mini-assessment" }, "scenario": { "type": "string", "maxLength": 64, "title": "Scenario", "default": "" } }, "type": "object", "required": [ "email" ], "title": "LeadCaptureRequest" }, "LegalAcceptBody": { "properties": { "termsVersion": { "type": "string", "maxLength": 32, "minLength": 4, "title": "Termsversion" }, "scanAuthorization": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Scanauthorization" }, "domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Domain" } }, "type": "object", "required": [ "termsVersion" ], "title": "LegalAcceptBody" }, "MarketplaceResponse": { "properties": { "tiles": { "items": { "$ref": "#/components/schemas/MarketplaceTile" }, "type": "array", "title": "Tiles" } }, "type": "object", "required": [ "tiles" ], "title": "MarketplaceResponse" }, "MarketplaceTile": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "publisher": { "type": "string", "title": "Publisher" }, "description": { "type": "string", "title": "Description" }, "category": { "type": "string", "title": "Category" }, "installed": { "type": "boolean", "title": "Installed", "default": false } }, "type": "object", "required": [ "id", "name", "publisher", "description", "category" ], "title": "MarketplaceTile" }, "MemberRoleUpdate": { "properties": { "role": { "type": "string", "pattern": "^(admin|operator|executive|viewer)$", "title": "Role" } }, "type": "object", "required": [ "role" ], "title": "MemberRoleUpdate" }, "MonitorProvisionRequest": { "properties": { "email": { "type": "string", "maxLength": 320, "minLength": 3, "title": "Email" }, "company": { "type": "string", "maxLength": 200, "minLength": 2, "title": "Company" }, "domain": { "anyOf": [ { "type": "string", "maxLength": 253 }, { "type": "null" } ], "title": "Domain" }, "adminSecret": { "type": "string", "title": "Adminsecret" } }, "type": "object", "required": [ "email", "company", "adminSecret" ], "title": "MonitorProvisionRequest" }, "MonitorSignupRequest": { "properties": { "email": { "type": "string", "maxLength": 320, "minLength": 3, "title": "Email" }, "company": { "type": "string", "maxLength": 200, "minLength": 2, "title": "Company" }, "domain": { "anyOf": [ { "type": "string", "maxLength": 253 }, { "type": "null" } ], "title": "Domain" } }, "type": "object", "required": [ "email", "company" ], "title": "MonitorSignupRequest" }, "MorningBriefingResponse": { "properties": { "generatedAt": { "type": "string", "title": "Generatedat" }, "persona": { "type": "string", "title": "Persona" }, "headline": { "type": "string", "title": "Headline" }, "bullets": { "items": { "type": "string" }, "type": "array", "title": "Bullets" }, "nextActions": { "items": { "$ref": "#/components/schemas/NextBestAction" }, "type": "array", "title": "Nextactions" }, "methodNote": { "type": "string", "title": "Methodnote" } }, "type": "object", "required": [ "generatedAt", "persona", "headline", "bullets", "nextActions", "methodNote" ], "title": "MorningBriefingResponse" }, "MsspParentRequest": { "properties": { "parentTenantId": { "type": "string", "maxLength": 64, "minLength": 1, "title": "Parenttenantid" } }, "type": "object", "required": [ "parentTenantId" ], "title": "MsspParentRequest" }, "NbaActionRequest": { "properties": { "op": { "type": "string", "enum": [ "snooze", "dismiss", "assign" ], "title": "Op", "default": "dismiss" }, "owner": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Owner" }, "snoozeHours": { "type": "integer", "maximum": 168.0, "minimum": 1.0, "title": "Snoozehours", "default": 24 } }, "type": "object", "title": "NbaActionRequest" }, "NextBestAction": { "properties": { "id": { "type": "string", "title": "Id" }, "kind": { "type": "string", "title": "Kind" }, "title": { "type": "string", "title": "Title" }, "impact": { "type": "string", "title": "Impact" }, "effort": { "type": "string", "title": "Effort", "default": "medium" }, "score": { "type": "integer", "title": "Score", "default": 0 }, "owner": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Owner" }, "deepLink": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Deeplink" }, "cta": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Cta" } }, "type": "object", "required": [ "id", "kind", "title", "impact" ], "title": "NextBestAction" }, "NextBestActionResponse": { "properties": { "actions": { "items": { "$ref": "#/components/schemas/NextBestAction" }, "type": "array", "title": "Actions" }, "generatedAt": { "type": "string", "title": "Generatedat" } }, "type": "object", "required": [ "actions", "generatedAt" ], "title": "NextBestActionResponse" }, "NotificationPreferences": { "properties": { "channels": { "additionalProperties": { "type": "boolean" }, "type": "object", "title": "Channels" }, "digestCadenceHours": { "type": "integer", "title": "Digestcadencehours", "default": 24 }, "quietHoursStart": { "anyOf": [ { "type": "integer", "maximum": 23.0, "minimum": 0.0 }, { "type": "null" } ], "title": "Quiethoursstart" }, "quietHoursEnd": { "anyOf": [ { "type": "integer", "maximum": 23.0, "minimum": 0.0 }, { "type": "null" } ], "title": "Quiethoursend" }, "minSeverity": { "type": "string", "title": "Minseverity", "default": "medium" }, "pushEnabled": { "type": "boolean", "title": "Pushenabled", "default": false } }, "type": "object", "title": "NotificationPreferences" }, "OidcConfigRequest": { "properties": { "issuerUrl": { "type": "string", "title": "Issuerurl" }, "clientId": { "type": "string", "title": "Clientid" }, "clientSecret": { "type": "string", "title": "Clientsecret", "default": "" }, "enabled": { "type": "boolean", "title": "Enabled", "default": false } }, "type": "object", "required": [ "issuerUrl", "clientId" ], "title": "OidcConfigRequest" }, "OnboardingPatchBody": { "properties": { "step": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Step" }, "dismissed": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Dismissed" }, "complete": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Complete" }, "toursCompleted": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tourscompleted" } }, "type": "object", "title": "OnboardingPatchBody" }, "OptimizeRequest": { "properties": { "type": { "type": "string", "enum": [ "schedule", "scheduling", "routing", "allocation" ], "title": "Type" }, "data": { "additionalProperties": true, "type": "object", "title": "Data" }, "constraints": { "items": { "type": "string" }, "type": "array", "title": "Constraints" }, "tasks": { "items": { "$ref": "#/components/schemas/ScheduleTaskInput" }, "type": "array", "title": "Tasks" }, "stops": { "items": { "$ref": "#/components/schemas/RoutingStopInput" }, "type": "array", "title": "Stops" }, "vehicles": { "items": { "$ref": "#/components/schemas/VehicleInput" }, "type": "array", "title": "Vehicles" }, "shifts": { "items": { "$ref": "#/components/schemas/ShiftInput" }, "type": "array", "title": "Shifts" }, "staff": { "items": { "$ref": "#/components/schemas/StaffInput" }, "type": "array", "title": "Staff" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "OptimizeRequest" }, "OptimizeResponse": { "properties": { "status": { "type": "string", "const": "success", "title": "Status" }, "summary": { "type": "string", "title": "Summary" }, "solution": { "title": "Solution" }, "metrics": { "additionalProperties": true, "type": "object", "title": "Metrics" }, "method": { "type": "string", "enum": [ "classical", "hybrid" ], "title": "Method" }, "details": { "additionalProperties": true, "type": "object", "title": "Details" }, "visualization": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Visualization" } }, "type": "object", "required": [ "status", "summary", "solution", "metrics", "method", "details" ], "title": "OptimizeResponse" }, "PartnerBulkDigestBody": { "properties": { "enabled": { "type": "boolean", "title": "Enabled", "default": true } }, "type": "object", "title": "PartnerBulkDigestBody" }, "PartnerBulkScheduleBody": { "properties": { "cadenceHours": { "type": "integer", "maximum": 8760.0, "minimum": 24.0, "title": "Cadencehours", "default": 168 }, "scenarioId": { "type": "string", "maxLength": 64, "title": "Scenarioid", "default": "qtangl-baseline" } }, "type": "object", "title": "PartnerBulkScheduleBody" }, "PartnerDealRegistrationBody": { "properties": { "companyName": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Companyname" }, "contactEmail": { "type": "string", "maxLength": 320, "minLength": 3, "title": "Contactemail" }, "estimatedValue": { "anyOf": [ { "type": "string", "maxLength": 64 }, { "type": "null" } ], "title": "Estimatedvalue" }, "notes": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ], "title": "Notes" } }, "type": "object", "required": [ "companyName", "contactEmail" ], "title": "PartnerDealRegistrationBody" }, "PartnerProvisionChildBody": { "properties": { "customerName": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Customername" }, "label": { "type": "string", "maxLength": 255, "title": "Label", "default": "" }, "tier": { "type": "string", "pattern": "^(monitor|convert|enterprise|free)$", "title": "Tier", "default": "monitor" }, "primaryDomain": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ], "title": "Primarydomain" }, "inviteEmail": { "anyOf": [ { "type": "string", "maxLength": 320 }, { "type": "null" } ], "title": "Inviteemail" }, "inviteRole": { "type": "string", "maxLength": 64, "title": "Inviterole", "default": "customer_executive" } }, "type": "object", "required": [ "customerName" ], "title": "PartnerProvisionChildBody" }, "PatchTenantRequest": { "properties": { "tier": { "type": "string", "pattern": "^(free|monitor|convert|enterprise)$", "title": "Tier" } }, "type": "object", "required": [ "tier" ], "title": "PatchTenantRequest" }, "PeerPercentileResponse": { "properties": { "readinessPercentile": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Readinesspercentile" }, "velocityPercentile": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Velocitypercentile" }, "sector": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sector" }, "sampleSize": { "type": "integer", "title": "Samplesize" }, "assumptions": { "items": { "type": "string" }, "type": "array", "title": "Assumptions" } }, "type": "object", "required": [ "sampleSize" ], "title": "PeerPercentileResponse" }, "PortfolioRollupResponse": { "properties": { "childCount": { "type": "integer", "title": "Childcount" }, "avgReadiness": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Avgreadiness" }, "tenants": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Tenants" }, "assumptions": { "items": { "type": "string" }, "type": "array", "title": "Assumptions" } }, "type": "object", "required": [ "childCount", "tenants" ], "title": "PortfolioRollupResponse" }, "PortfolioTargetRequest": { "properties": { "target": { "type": "string", "title": "Target" }, "businessUnit": { "type": "string", "title": "Businessunit", "default": "default" }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Label" }, "autoSchedule": { "type": "boolean", "title": "Autoschedule", "default": false }, "cadenceHours": { "type": "integer", "maximum": 8760.0, "minimum": 1.0, "title": "Cadencehours", "default": 168 }, "notifyEmail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Notifyemail" } }, "type": "object", "required": [ "target" ], "title": "PortfolioTargetRequest" }, "PqcHandshakeRequest": { "properties": { "useFixture": { "type": "boolean", "title": "Usefixture", "default": true } }, "type": "object", "title": "PqcHandshakeRequest" }, "PqcScanRequest": { "properties": { "scenarioId": { "type": "string", "title": "Scenarioid", "default": "bank-tls-inventory" }, "useFixture": { "type": "boolean", "title": "Usefixture", "default": true }, "target": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target" }, "seed": { "type": "integer", "title": "Seed", "default": 1234 }, "bundleSessionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Bundlesessionid" }, "depth": { "type": "string", "pattern": "^(standard|lite)$", "title": "Depth", "default": "standard" }, "industry": { "anyOf": [ { "type": "string", "maxLength": 64 }, { "type": "null" } ], "title": "Industry" } }, "type": "object", "title": "PqcScanRequest" }, "ProgramCreateRequest": { "properties": { "sourceType": { "type": "string", "title": "Sourcetype", "default": "manual" }, "sourceRef": { "type": "string", "title": "Sourceref" }, "title": { "type": "string", "title": "Title", "default": "" }, "status": { "type": "string", "title": "Status", "default": "open" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Notes" } }, "type": "object", "required": [ "sourceRef" ], "title": "ProgramCreateRequest" }, "ProgramSimulateRequest": { "properties": { "programItemIds": { "items": { "type": "string" }, "type": "array", "title": "Programitemids" } }, "type": "object", "title": "ProgramSimulateRequest" }, "ProgramUpdateRequest": { "properties": { "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" }, "owner": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Owner" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Notes" }, "targetDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Targetdate" } }, "type": "object", "title": "ProgramUpdateRequest" }, "ProgramVerifyRequest": { "properties": { "verifyScanId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Verifyscanid" } }, "type": "object", "title": "ProgramVerifyRequest" }, "PushBriefingRequest": { "properties": { "channels": { "items": { "type": "string", "enum": [ "email", "slack", "teams", "webhook" ] }, "type": "array", "maxItems": 4, "minItems": 1, "title": "Channels" }, "recipients": { "items": { "type": "string" }, "type": "array", "maxItems": 50, "title": "Recipients" }, "cadenceHours": { "type": "integer", "maximum": 168.0, "minimum": 1.0, "title": "Cadencehours", "default": 24 }, "enabled": { "type": "boolean", "title": "Enabled", "default": false } }, "type": "object", "title": "PushBriefingRequest" }, "RemediationAutomateRequest": { "properties": { "remediationId": { "type": "string", "title": "Remediationid" }, "action": { "type": "string", "pattern": "^(acme|github_pr|venafi)$", "title": "Action" }, "domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Domain" }, "repo": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Repo" }, "branch": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Branch" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "policyId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Policyid" } }, "type": "object", "required": [ "remediationId", "action" ], "title": "RemediationAutomateRequest" }, "RemediationPrDraftRequest": { "properties": { "remediationId": { "type": "string", "title": "Remediationid" }, "scanId": { "type": "string", "title": "Scanid" } }, "type": "object", "required": [ "remediationId", "scanId" ], "title": "RemediationPrDraftRequest" }, "RemediationPrDraftResponse": { "properties": { "remediationId": { "type": "string", "title": "Remediationid" }, "title": { "type": "string", "title": "Title" }, "description": { "type": "string", "title": "Description" }, "files": { "items": { "additionalProperties": { "type": "string" }, "type": "object" }, "type": "array", "title": "Files" }, "checklist": { "items": { "type": "string" }, "type": "array", "title": "Checklist" } }, "type": "object", "required": [ "remediationId", "title", "description" ], "title": "RemediationPrDraftResponse" }, "RemediationSimulationRequest": { "properties": { "remediationIds": { "items": { "type": "string" }, "type": "array", "title": "Remediationids" } }, "type": "object", "title": "RemediationSimulationRequest" }, "RemediationUpdateRequest": { "properties": { "remediationId": { "type": "string", "title": "Remediationid" }, "status": { "type": "string", "title": "Status" }, "owner": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Owner" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Notes" }, "targetDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Targetdate" }, "assetId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Assetid" } }, "type": "object", "required": [ "remediationId", "status" ], "title": "RemediationUpdateRequest" }, "RemediationVerifyRequest": { "properties": { "remediationId": { "type": "string", "title": "Remediationid" }, "verifyScanId": { "type": "string", "title": "Verifyscanid" } }, "type": "object", "required": [ "remediationId", "verifyScanId" ], "title": "RemediationVerifyRequest" }, "RetireKeyRequest": { "properties": { "keyFingerprint": { "type": "string", "title": "Keyfingerprint" } }, "type": "object", "required": [ "keyFingerprint" ], "title": "RetireKeyRequest" }, "RoutingStopInput": { "properties": { "id": { "type": "string", "title": "Id" }, "serviceWindow": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Servicewindow" } }, "type": "object", "required": [ "id" ], "title": "RoutingStopInput" }, "RunwayMilestone": { "properties": { "id": { "type": "string", "title": "Id" }, "label": { "type": "string", "title": "Label" }, "date": { "type": "string", "title": "Date" }, "kind": { "type": "string", "title": "Kind" }, "description": { "type": "string", "title": "Description" } }, "type": "object", "required": [ "id", "label", "date", "kind", "description" ], "title": "RunwayMilestone" }, "RunwayResponse": { "properties": { "milestones": { "items": { "$ref": "#/components/schemas/RunwayMilestone" }, "type": "array", "title": "Milestones" }, "scenarios": { "items": { "$ref": "#/components/schemas/RunwayScenario" }, "type": "array", "title": "Scenarios" }, "framing": { "type": "string", "title": "Framing" } }, "type": "object", "required": [ "milestones", "scenarios", "framing" ], "title": "RunwayResponse" }, "RunwayScenario": { "properties": { "id": { "type": "string", "title": "Id" }, "label": { "type": "string", "title": "Label" }, "readinessDelta": { "type": "integer", "title": "Readinessdelta" }, "description": { "type": "string", "title": "Description" } }, "type": "object", "required": [ "id", "label", "readinessDelta", "description" ], "title": "RunwayScenario" }, "SavedView": { "properties": { "name": { "type": "string", "maxLength": 120, "minLength": 1, "title": "Name" }, "persona": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Persona" }, "filters": { "$ref": "#/components/schemas/SavedViewFilters" }, "id": { "type": "string", "title": "Id" }, "createdAt": { "type": "string", "title": "Createdat" }, "updatedAt": { "type": "string", "title": "Updatedat" } }, "type": "object", "required": [ "name", "filters", "id", "createdAt", "updatedAt" ], "title": "SavedView" }, "SavedViewCreate": { "properties": { "name": { "type": "string", "maxLength": 120, "minLength": 1, "title": "Name" }, "persona": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Persona" }, "filters": { "$ref": "#/components/schemas/SavedViewFilters" } }, "type": "object", "required": [ "name", "filters" ], "title": "SavedViewCreate" }, "SavedViewFilters": { "properties": { "tab": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tab" }, "severity": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Severity" }, "businessUnit": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Businessunit" }, "scanSource": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scansource" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Query" }, "extra": { "additionalProperties": true, "type": "object", "title": "Extra" } }, "type": "object", "title": "SavedViewFilters" }, "SavedViewListResponse": { "properties": { "views": { "items": { "$ref": "#/components/schemas/SavedView" }, "type": "array", "title": "Views" } }, "type": "object", "required": [ "views" ], "title": "SavedViewListResponse" }, "ScanGraphResponse": { "properties": { "scanId": { "type": "string", "title": "Scanid" }, "nodes": { "items": { "$ref": "#/components/schemas/GraphNode" }, "type": "array", "title": "Nodes" }, "edges": { "items": { "$ref": "#/components/schemas/GraphEdge" }, "type": "array", "title": "Edges" }, "nodeCount": { "type": "integer", "title": "Nodecount" }, "truncated": { "type": "boolean", "title": "Truncated", "default": false }, "assumptions": { "items": { "type": "string" }, "type": "array", "title": "Assumptions" } }, "type": "object", "required": [ "scanId", "nodes", "edges", "nodeCount" ], "title": "ScanGraphResponse" }, "ScenarioSimRequest": { "properties": { "scenarioId": { "type": "string", "title": "Scenarioid", "default": "baseline" } }, "type": "object", "title": "ScenarioSimRequest" }, "ScenarioSimResponse": { "properties": { "scenarioId": { "type": "string", "title": "Scenarioid" }, "projectedReadiness": { "type": "number", "title": "Projectedreadiness" }, "confidenceBand": { "additionalProperties": { "type": "number" }, "type": "object", "title": "Confidenceband" }, "assumptions": { "items": { "type": "string" }, "type": "array", "title": "Assumptions" } }, "type": "object", "required": [ "scenarioId", "projectedReadiness", "confidenceBand", "assumptions" ], "title": "ScenarioSimResponse" }, "ScheduleCreateRequest": { "properties": { "scenarioId": { "type": "string", "title": "Scenarioid", "default": "production-baseline" }, "target": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target" }, "cadenceHours": { "type": "integer", "maximum": 8760.0, "minimum": 1.0, "title": "Cadencehours", "default": 168 }, "notifyEmail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Notifyemail" }, "cloudImportPayload": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cloudimportpayload" }, "jobType": { "type": "string", "pattern": "^(scan|cloud_pull|host_fleet_scan|code_scan|binary_scan)$", "title": "Jobtype", "default": "scan" }, "integrationProvider": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Integrationprovider" } }, "type": "object", "title": "ScheduleCreateRequest" }, "SchedulePatchRequest": { "properties": { "cadenceHours": { "anyOf": [ { "type": "integer", "maximum": 8760.0, "minimum": 1.0 }, { "type": "null" } ], "title": "Cadencehours" }, "notifyEmail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Notifyemail" }, "active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Active" } }, "type": "object", "title": "SchedulePatchRequest" }, "ScheduleTaskInput": { "properties": { "id": { "type": "string", "title": "Id" }, "duration": { "type": "integer", "exclusiveMinimum": 0.0, "title": "Duration" }, "crew": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Crew" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" } }, "type": "object", "required": [ "id", "duration" ], "title": "ScheduleTaskInput" }, "ShareLinkRequest": { "properties": { "expiresHours": { "type": "integer", "maximum": 720.0, "minimum": 1.0, "title": "Expireshours", "default": 168 }, "label": { "type": "string", "maxLength": 255, "title": "Label", "default": "" }, "scope": { "type": "string", "pattern": "^(report|bundle|passport)$", "title": "Scope", "default": "report" } }, "type": "object", "title": "ShareLinkRequest" }, "ShiftInput": { "properties": { "id": { "type": "string", "title": "Id" }, "requiredSkill": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Requiredskill" } }, "type": "object", "required": [ "id" ], "title": "ShiftInput" }, "SsoPortalRequest": { "properties": { "returnUrl": { "type": "string", "maxLength": 2048, "minLength": 8, "title": "Returnurl" } }, "type": "object", "required": [ "returnUrl" ], "title": "SsoPortalRequest" }, "StaffInput": { "properties": { "name": { "type": "string", "title": "Name" }, "skills": { "items": { "type": "string" }, "type": "array", "title": "Skills" }, "maxHours": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Maxhours" } }, "type": "object", "required": [ "name" ], "title": "StaffInput" }, "TeamInviteRequest": { "properties": { "email": { "type": "string", "maxLength": 320, "minLength": 3, "title": "Email" }, "role": { "type": "string", "pattern": "^(admin|operator|executive|viewer)$", "title": "Role", "default": "operator" } }, "type": "object", "required": [ "email" ], "title": "TeamInviteRequest" }, "TenantSettingsAdminRequest": { "properties": { "settings": { "additionalProperties": true, "type": "object", "title": "Settings" } }, "type": "object", "title": "TenantSettingsAdminRequest" }, "TenantSettingsRequest": { "properties": { "readinessDropThreshold": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Readinessdropthreshold" }, "alertOnNewQuantumVulnerable": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Alertonnewquantumvulnerable" }, "certExpiryDays": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Certexpirydays" }, "webhookSigningSecret": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Webhooksigningsecret" }, "autoRetainScans": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Autoretainscans" }, "evidenceRetentionMonths": { "anyOf": [ { "type": "integer", "maximum": 120.0, "minimum": 1.0 }, { "type": "null" } ], "title": "Evidenceretentionmonths" }, "benchmarkOptIn": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Benchmarkoptin" }, "industry": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Industry" } }, "type": "object", "title": "TenantSettingsRequest" }, "TenantWorkspacePatchRequest": { "properties": { "name": { "type": "string", "maxLength": 120, "minLength": 1, "title": "Name" }, "timezone": { "anyOf": [ { "type": "string", "maxLength": 64 }, { "type": "null" } ], "title": "Timezone" } }, "type": "object", "required": [ "name" ], "title": "TenantWorkspacePatchRequest" }, "TrackEventRequest": { "properties": { "event": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Event" }, "properties": { "additionalProperties": true, "type": "object", "title": "Properties" } }, "type": "object", "required": [ "event" ], "title": "TrackEventRequest" }, "TransparencyEntry": { "properties": { "seq": { "type": "integer", "title": "Seq" }, "contentHash": { "type": "string", "title": "Contenthash" }, "entryHash": { "type": "string", "title": "Entryhash" }, "scanId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scanid" }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Createdat" } }, "type": "object", "required": [ "seq", "contentHash", "entryHash" ], "title": "TransparencyEntry" }, "TransparencyLogResponse": { "properties": { "rootHash": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Roothash" }, "entries": { "items": { "$ref": "#/components/schemas/TransparencyEntry" }, "type": "array", "title": "Entries" }, "total": { "type": "integer", "title": "Total" }, "verifyInstructions": { "type": "string", "title": "Verifyinstructions" } }, "type": "object", "required": [ "entries", "total", "verifyInstructions" ], "title": "TransparencyLogResponse" }, "UnsubscribeRequest": { "properties": { "email": { "type": "string", "maxLength": 320, "minLength": 3, "title": "Email" } }, "type": "object", "required": [ "email" ], "title": "UnsubscribeRequest" }, "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" }, "VehicleInput": { "properties": { "id": { "type": "string", "title": "Id" }, "capacity": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Capacity" } }, "type": "object", "required": [ "id" ], "title": "VehicleInput" }, "VerifyReportRequest": { "properties": { "reportJson": { "additionalProperties": true, "type": "object", "title": "Reportjson" } }, "type": "object", "required": [ "reportJson" ], "title": "VerifyReportRequest" }, "WarRoom": { "properties": { "id": { "type": "string", "title": "Id" }, "title": { "type": "string", "title": "Title" }, "status": { "type": "string", "enum": [ "active", "resolved" ], "title": "Status" }, "alertIds": { "items": { "type": "string" }, "type": "array", "title": "Alertids" }, "assignees": { "items": { "type": "string" }, "type": "array", "title": "Assignees" }, "shareToken": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sharetoken" }, "createdAt": { "type": "string", "title": "Createdat" }, "updatedAt": { "type": "string", "title": "Updatedat" } }, "type": "object", "required": [ "id", "title", "status", "alertIds", "assignees", "createdAt", "updatedAt" ], "title": "WarRoom" }, "WarRoomCreate": { "properties": { "title": { "type": "string", "maxLength": 200, "minLength": 1, "title": "Title" }, "alertIds": { "items": { "type": "string" }, "type": "array", "maxItems": 50, "title": "Alertids" }, "assignees": { "items": { "type": "string" }, "type": "array", "maxItems": 20, "title": "Assignees" } }, "type": "object", "required": [ "title" ], "title": "WarRoomCreate" }, "WebhookRequest": { "properties": { "url": { "type": "string", "title": "Url" }, "events": { "type": "string", "title": "Events", "default": "scan.complete" } }, "type": "object", "required": [ "url" ], "title": "WebhookRequest" }, "WitnessSubmitRequest": { "properties": { "witnessId": { "type": "string", "title": "Witnessid" }, "rootHash": { "type": "string", "title": "Roothash" }, "seq": { "type": "integer", "title": "Seq" }, "alg": { "type": "string", "title": "Alg" }, "signatureB64": { "type": "string", "title": "Signatureb64" }, "publicKeyB64": { "type": "string", "title": "Publickeyb64" } }, "type": "object", "required": [ "witnessId", "rootHash", "seq", "alg", "signatureB64", "publicKeyB64" ], "title": "WitnessSubmitRequest" } } }, "tags": [ { "name": "pqc", "description": "Scan, report, verify, transparency, and CBOM lifecycle." }, { "name": "tenant", "description": "Authenticated tenant APIs \u2014 scans, schedules, webhooks, integrations." }, { "name": "admin", "description": "Platform admin key \u2014 tenant provisioning and API key lifecycle." }, { "name": "public", "description": "Unauthenticated signup, billing webhooks, and lead capture." }, { "name": "health", "description": "Liveness, readiness, and metrics." } ] }