{ "components": { "schemas": { "AuditList": { "properties": { "items": { "items": { "$ref": "#/components/schemas/AuditSummary" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "AuditList", "type": "object" }, "AuditSummary": { "properties": { "action": { "title": "Action", "type": "string" }, "created_at": { "title": "Created At", "type": "string" }, "details": { "additionalProperties": true, "title": "Details", "type": "object" }, "id": { "title": "Id", "type": "string" }, "outcome": { "title": "Outcome", "type": "string" }, "request_id": { "title": "Request Id", "type": "string" }, "resource_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Resource Id" }, "resource_type": { "title": "Resource Type", "type": "string" } }, "required": [ "id", "action", "resource_type", "resource_id", "outcome", "request_id", "created_at", "details" ], "title": "AuditSummary", "type": "object" }, "AuthenticatedUser": { "properties": { "id": { "title": "Id", "type": "string" }, "username": { "title": "Username", "type": "string" } }, "required": [ "id", "username" ], "title": "AuthenticatedUser", "type": "object" }, "BackupDeletePreview": { "properties": { "backup_id": { "title": "Backup Id", "type": "string" }, "destructive_action": { "title": "Destructive Action", "type": "string" }, "eligible": { "title": "Eligible", "type": "boolean" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reason" } }, "required": [ "backup_id", "eligible", "reason", "destructive_action" ], "title": "BackupDeletePreview", "type": "object" }, "BackupList": { "properties": { "items": { "items": { "$ref": "#/components/schemas/BackupSummary" }, "title": "Items", "type": "array" } }, "required": [ "items" ], "title": "BackupList", "type": "object" }, "BackupSummary": { "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "execution_id": { "title": "Execution Id", "type": "string" }, "id": { "title": "Id", "type": "string" }, "integrity": { "title": "Integrity", "type": "string" }, "logical_bytes": { "title": "Logical Bytes", "type": "integer" }, "manifest_id": { "title": "Manifest Id", "type": "string" }, "pinned": { "title": "Pinned", "type": "boolean" }, "stored_bytes": { "title": "Stored Bytes", "type": "integer" }, "tombstoned_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Tombstoned At" } }, "required": [ "id", "execution_id", "manifest_id", "logical_bytes", "stored_bytes", "integrity", "pinned", "tombstoned_at", "created_at" ], "title": "BackupSummary", "type": "object" }, "EmailSettingsInput": { "properties": { "host": { "maxLength": 255, "minLength": 1, "title": "Host", "type": "string" }, "max_attempts": { "default": 5, "maximum": 20.0, "minimum": 1.0, "title": "Max Attempts", "type": "integer" }, "password": { "maxLength": 65536, "minLength": 1, "title": "Password", "type": "string" }, "port": { "default": 587, "maximum": 65535.0, "minimum": 1.0, "title": "Port", "type": "integer" }, "rate_limit_per_minute": { "default": 60, "maximum": 10000.0, "minimum": 1.0, "title": "Rate Limit Per Minute", "type": "integer" }, "sender": { "maxLength": 320, "minLength": 3, "title": "Sender", "type": "string" }, "username": { "maxLength": 255, "minLength": 1, "title": "Username", "type": "string" } }, "required": [ "host", "username", "password", "sender" ], "title": "EmailSettingsInput", "type": "object" }, "ExecutionList": { "properties": { "items": { "items": { "$ref": "#/components/schemas/ExecutionSummary" }, "title": "Items", "type": "array" } }, "required": [ "items" ], "title": "ExecutionList", "type": "object" }, "ExecutionSummary": { "properties": { "attempt": { "title": "Attempt", "type": "integer" }, "id": { "title": "Id", "type": "string" }, "progress": { "additionalProperties": true, "title": "Progress", "type": "object" }, "reason_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reason Code" }, "revision": { "title": "Revision", "type": "integer" }, "state": { "title": "State", "type": "string" } }, "required": [ "id", "state", "attempt", "revision", "reason_code", "progress" ], "title": "ExecutionSummary", "type": "object" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "title": "Detail", "type": "array" } }, "title": "HTTPValidationError", "type": "object" }, "JobInput": { "properties": { "allow_empty": { "default": false, "title": "Allow Empty", "type": "boolean" }, "enabled": { "default": true, "title": "Enabled", "type": "boolean" }, "exclusions": { "items": { "type": "string" }, "title": "Exclusions", "type": "array" }, "name": { "maxLength": 255, "minLength": 1, "title": "Name", "type": "string" }, "repository_id": { "title": "Repository Id", "type": "string" }, "requested_mode": { "default": "incremental", "title": "Requested Mode", "type": "string" }, "retention": { "additionalProperties": true, "title": "Retention", "type": "object" }, "source_id": { "title": "Source Id", "type": "string" } }, "required": [ "name", "source_id", "repository_id" ], "title": "JobInput", "type": "object" }, "JobList": { "properties": { "items": { "items": { "$ref": "#/components/schemas/JobSummary" }, "title": "Items", "type": "array" } }, "required": [ "items" ], "title": "JobList", "type": "object" }, "JobSummary": { "properties": { "enabled": { "title": "Enabled", "type": "boolean" }, "id": { "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "repository_id": { "title": "Repository Id", "type": "string" }, "requested_mode": { "title": "Requested Mode", "type": "string" }, "schedule": { "anyOf": [ { "$ref": "#/components/schemas/ScheduleSummary" }, { "type": "null" } ] }, "source_id": { "title": "Source Id", "type": "string" }, "state": { "title": "State", "type": "string" } }, "required": [ "id", "name", "source_id", "repository_id", "requested_mode", "enabled", "state", "schedule" ], "title": "JobSummary", "type": "object" }, "LocalSourceInput": { "additionalProperties": false, "properties": { "kind": { "const": "local", "title": "Kind", "type": "string" }, "name": { "maxLength": 255, "minLength": 1, "title": "Name", "type": "string" }, "public_config": { "additionalProperties": true, "title": "Public Config", "type": "object" } }, "required": [ "name", "kind", "public_config" ], "title": "LocalSourceInput", "type": "object" }, "LoginInput": { "properties": { "password": { "maxLength": 1024, "minLength": 1, "title": "Password", "type": "string" }, "username": { "maxLength": 255, "minLength": 1, "title": "Username", "type": "string" } }, "required": [ "username", "password" ], "title": "LoginInput", "type": "object" }, "NotificationAttemptList": { "properties": { "items": { "items": { "$ref": "#/components/schemas/NotificationAttemptSummary" }, "title": "Items", "type": "array" } }, "required": [ "items" ], "title": "NotificationAttemptList", "type": "object" }, "NotificationAttemptSummary": { "properties": { "completed_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Completed At" }, "diagnostic": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Diagnostic" }, "number": { "title": "Number", "type": "integer" }, "outcome": { "title": "Outcome", "type": "string" }, "response_class": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Response Class" }, "started_at": { "title": "Started At", "type": "string" } }, "required": [ "number", "outcome", "response_class", "diagnostic", "started_at", "completed_at" ], "title": "NotificationAttemptSummary", "type": "object" }, "NotificationDeliveryList": { "properties": { "items": { "items": { "$ref": "#/components/schemas/NotificationDeliverySummary" }, "title": "Items", "type": "array" } }, "required": [ "items" ], "title": "NotificationDeliveryList", "type": "object" }, "NotificationDeliverySummary": { "properties": { "attempt_count": { "title": "Attempt Count", "type": "integer" }, "due_at": { "title": "Due At", "type": "string" }, "event_id": { "title": "Event Id", "type": "string" }, "id": { "title": "Id", "type": "string" }, "response_class": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Response Class" }, "response_summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Response Summary" }, "state": { "title": "State", "type": "string" }, "subscription_id": { "title": "Subscription Id", "type": "string" }, "terminal_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Terminal Reason" } }, "required": [ "id", "event_id", "subscription_id", "state", "attempt_count", "response_class", "response_summary", "terminal_reason", "due_at" ], "title": "NotificationDeliverySummary", "type": "object" }, "NotificationSubscriptionInput": { "properties": { "channel": { "enum": [ "webhook", "email" ], "title": "Channel", "type": "string" }, "destination": { "additionalProperties": true, "title": "Destination", "type": "object" }, "event_filters": { "items": { "type": "string" }, "maxItems": 48, "minItems": 1, "title": "Event Filters", "type": "array" }, "rate_limit_per_minute": { "default": 60, "maximum": 10000.0, "minimum": 1.0, "title": "Rate Limit Per Minute", "type": "integer" }, "signing_secret": { "anyOf": [ { "maxLength": 65536, "minLength": 16, "type": "string" }, { "type": "null" } ], "title": "Signing Secret" } }, "required": [ "channel", "event_filters", "destination" ], "title": "NotificationSubscriptionInput", "type": "object" }, "NotificationSubscriptionList": { "properties": { "items": { "items": { "$ref": "#/components/schemas/NotificationSubscriptionSummary" }, "title": "Items", "type": "array" } }, "required": [ "items" ], "title": "NotificationSubscriptionList", "type": "object" }, "NotificationSubscriptionPatch": { "properties": { "destination": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Destination" }, "event_filters": { "anyOf": [ { "items": { "type": "string" }, "maxItems": 48, "minItems": 1, "type": "array" }, { "type": "null" } ], "title": "Event Filters" }, "rate_limit_per_minute": { "anyOf": [ { "maximum": 10000.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "title": "Rate Limit Per Minute" }, "state": { "anyOf": [ { "enum": [ "active", "disabled", "archived" ], "type": "string" }, { "type": "null" } ], "title": "State" } }, "title": "NotificationSubscriptionPatch", "type": "object" }, "NotificationSubscriptionSummary": { "properties": { "channel": { "title": "Channel", "type": "string" }, "created_at": { "title": "Created At", "type": "string" }, "destination": { "additionalProperties": true, "title": "Destination", "type": "object" }, "event_filters": { "items": { "type": "string" }, "title": "Event Filters", "type": "array" }, "id": { "title": "Id", "type": "string" }, "rate_limit_per_minute": { "title": "Rate Limit Per Minute", "type": "integer" }, "revision": { "title": "Revision", "type": "integer" }, "state": { "title": "State", "type": "string" }, "updated_at": { "title": "Updated At", "type": "string" } }, "required": [ "id", "channel", "event_filters", "destination", "state", "rate_limit_per_minute", "revision", "created_at", "updated_at" ], "title": "NotificationSubscriptionSummary", "type": "object" }, "RecoveryStatus": { "properties": { "encrypted_repository_count": { "title": "Encrypted Repository Count", "type": "integer" }, "recovery_mode": { "const": "cli_only", "title": "Recovery Mode", "type": "string" }, "runbook": { "title": "Runbook", "type": "string" } }, "required": [ "recovery_mode", "runbook", "encrypted_repository_count" ], "title": "RecoveryStatus", "type": "object" }, "RepositoryInput": { "properties": { "compression": { "default": "none", "title": "Compression", "type": "string" }, "encryption": { "default": "none", "title": "Encryption", "type": "string" }, "name": { "maxLength": 255, "minLength": 1, "title": "Name", "type": "string" }, "relative_path": { "maxLength": 1024, "minLength": 1, "title": "Relative Path", "type": "string" } }, "required": [ "name", "relative_path" ], "title": "RepositoryInput", "type": "object" }, "RepositoryList": { "properties": { "items": { "items": { "$ref": "#/components/schemas/RepositorySummary" }, "title": "Items", "type": "array" } }, "required": [ "items" ], "title": "RepositoryList", "type": "object" }, "RepositoryPatch": { "properties": { "compression": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Compression" }, "encryption": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Encryption" } }, "title": "RepositoryPatch", "type": "object" }, "RepositorySummary": { "properties": { "compression": { "title": "Compression", "type": "string" }, "encryption": { "title": "Encryption", "type": "string" }, "format_version": { "title": "Format Version", "type": "integer" }, "id": { "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "state": { "title": "State", "type": "string" } }, "required": [ "id", "name", "format_version", "compression", "encryption", "state" ], "title": "RepositorySummary", "type": "object" }, "RestoreInput": { "properties": { "destination": { "maxLength": 4096, "minLength": 1, "title": "Destination", "type": "string" }, "dry_run": { "default": false, "title": "Dry Run", "type": "boolean" }, "overwrite_policy": { "default": "fail", "title": "Overwrite Policy", "type": "string" }, "selection": { "items": { "type": "string" }, "title": "Selection", "type": "array" } }, "required": [ "destination" ], "title": "RestoreInput", "type": "object" }, "SSHSourceInput": { "additionalProperties": false, "properties": { "kind": { "const": "ssh", "title": "Kind", "type": "string" }, "name": { "maxLength": 255, "minLength": 1, "title": "Name", "type": "string" }, "private_key_secret_id": { "maxLength": 36, "minLength": 1, "title": "Private Key Secret Id", "type": "string" }, "public_config": { "$ref": "#/components/schemas/SSHSourcePublicConfig" } }, "required": [ "name", "kind", "public_config", "private_key_secret_id" ], "title": "SSHSourceInput", "type": "object" }, "SSHSourcePublicConfig": { "additionalProperties": false, "description": "The public, SFTP-chroot-only portion of an SSH source definition.", "properties": { "host_key": { "maxLength": 16384, "minLength": 1, "title": "Host Key", "type": "string" }, "hostname": { "maxLength": 253, "minLength": 1, "title": "Hostname", "type": "string" }, "port": { "maximum": 65535.0, "minimum": 1.0, "title": "Port", "type": "integer" }, "root": { "const": "/", "title": "Root", "type": "string" }, "username": { "maxLength": 255, "minLength": 1, "title": "Username", "type": "string" } }, "required": [ "hostname", "port", "username", "host_key", "root" ], "title": "SSHSourcePublicConfig", "type": "object" }, "ScheduleInput": { "properties": { "cron": { "maxLength": 255, "minLength": 1, "title": "Cron", "type": "string" }, "enabled": { "default": true, "title": "Enabled", "type": "boolean" }, "misfire_grace_seconds": { "default": 900, "minimum": 0.0, "title": "Misfire Grace Seconds", "type": "integer" }, "timezone": { "maxLength": 255, "minLength": 1, "title": "Timezone", "type": "string" } }, "required": [ "cron", "timezone" ], "title": "ScheduleInput", "type": "object" }, "ScheduleSummary": { "properties": { "cron": { "title": "Cron", "type": "string" }, "enabled": { "title": "Enabled", "type": "boolean" }, "id": { "title": "Id", "type": "string" }, "last_enqueue_outcome": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Enqueue Outcome" }, "next_nominal_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Next Nominal At" }, "timezone": { "title": "Timezone", "type": "string" } }, "required": [ "id", "cron", "timezone", "enabled", "next_nominal_at", "last_enqueue_outcome" ], "title": "ScheduleSummary", "type": "object" }, "SecretInput": { "properties": { "purpose": { "maxLength": 64, "minLength": 1, "title": "Purpose", "type": "string" }, "value": { "maxLength": 65536, "minLength": 1, "title": "Value", "type": "string" } }, "required": [ "purpose", "value" ], "title": "SecretInput", "type": "object" }, "SessionUser": { "properties": { "id": { "title": "Id", "type": "string" }, "state": { "title": "State", "type": "string" }, "username": { "title": "Username", "type": "string" } }, "required": [ "id", "username", "state" ], "title": "SessionUser", "type": "object" }, "SetupInput": { "properties": { "bootstrap_secret": { "anyOf": [ { "maxLength": 1024, "type": "string" }, { "type": "null" } ], "title": "Bootstrap Secret" }, "password": { "maxLength": 1024, "minLength": 12, "title": "Password", "type": "string" }, "username": { "maxLength": 255, "minLength": 1, "title": "Username", "type": "string" } }, "required": [ "username", "password" ], "title": "SetupInput", "type": "object" }, "SigningKeyRotateInput": { "properties": { "overlap_seconds": { "default": 3600, "maximum": 86400.0, "minimum": 60.0, "title": "Overlap Seconds", "type": "integer" }, "secret": { "maxLength": 65536, "minLength": 16, "title": "Secret", "type": "string" } }, "required": [ "secret" ], "title": "SigningKeyRotateInput", "type": "object" }, "SourceList": { "properties": { "items": { "items": { "$ref": "#/components/schemas/SourceSummary" }, "title": "Items", "type": "array" } }, "required": [ "items" ], "title": "SourceList", "type": "object" }, "SourceSummary": { "properties": { "id": { "title": "Id", "type": "string" }, "kind": { "title": "Kind", "type": "string" }, "name": { "title": "Name", "type": "string" }, "public_config": { "additionalProperties": true, "title": "Public Config", "type": "object" }, "state": { "title": "State", "type": "string" } }, "required": [ "id", "name", "kind", "state", "public_config" ], "title": "SourceSummary", "type": "object" }, "TokenInput": { "properties": { "expires_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Expires At" }, "scopes": { "items": { "type": "string" }, "minItems": 1, "title": "Scopes", "type": "array" } }, "required": [ "scopes" ], "title": "TokenInput", "type": "object" }, "UserPatch": { "properties": { "state": { "title": "State", "type": "string" } }, "required": [ "state" ], "title": "UserPatch", "type": "object" }, "ValidationError": { "properties": { "ctx": { "title": "Context", "type": "object" }, "input": { "title": "Input" }, "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "title": "Location", "type": "array" }, "msg": { "title": "Message", "type": "string" }, "type": { "title": "Error Type", "type": "string" } }, "required": [ "loc", "msg", "type" ], "title": "ValidationError", "type": "object" } } }, "info": { "title": "Backup Tool API", "version": "2.0.0" }, "openapi": "3.1.0", "paths": { "/api/v2/admin/secrets": { "get": { "operationId": "list_secrets_api_v2_admin_secrets_get", "parameters": [ { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "additionalProperties": true, "type": "object" }, "title": "Response List Secrets Api V2 Admin Secrets Get", "type": "array" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Secrets" }, "post": { "operationId": "create_secret_api_v2_admin_secrets_post", "parameters": [ { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "in": "header", "name": "X-CSRF-Token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretInput" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Create Secret Api V2 Admin Secrets Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Create Secret" } }, "/api/v2/admin/users/{user_id}": { "get": { "operationId": "get_user_api_v2_admin_users__user_id__get", "parameters": [ { "in": "path", "name": "user_id", "required": true, "schema": { "title": "User Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "title": "Response Get User Api V2 Admin Users User Id Get", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get User" }, "patch": { "operationId": "patch_user_api_v2_admin_users__user_id__patch", "parameters": [ { "in": "path", "name": "user_id", "required": true, "schema": { "title": "User Id", "type": "string" } }, { "in": "header", "name": "If-Match", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "If-Match" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "in": "header", "name": "X-CSRF-Token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserPatch" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "title": "Response Patch User Api V2 Admin Users User Id Patch", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Patch User" } }, "/api/v2/audit": { "get": { "operationId": "list_audit_api_v2_audit_get", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuditList" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Audit" } }, "/api/v2/auth/login": { "post": { "operationId": "login_api_v2_auth_login_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticatedUser" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Login" } }, "/api/v2/auth/logout": { "post": { "operationId": "logout_api_v2_auth_logout_post", "parameters": [ { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "in": "header", "name": "X-CSRF-Token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Csrf-Token" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Logout" } }, "/api/v2/auth/session": { "get": { "operationId": "get_session_api_v2_auth_session_get", "parameters": [ { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionUser" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Session" } }, "/api/v2/auth/tokens": { "post": { "operationId": "create_token_api_v2_auth_tokens_post", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "in": "header", "name": "X-CSRF-Token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Create Token" } }, "/api/v2/auth/tokens/{token_id}": { "delete": { "operationId": "revoke_token_api_v2_auth_tokens__token_id__delete", "parameters": [ { "in": "path", "name": "token_id", "required": true, "schema": { "title": "Token Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "in": "header", "name": "X-CSRF-Token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Csrf-Token" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Revoke Token" } }, "/api/v2/backups": { "get": { "operationId": "list_backups_api_v2_backups_get", "parameters": [ { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupList" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Backups" } }, "/api/v2/backups/{backup_id}": { "get": { "operationId": "get_backup_api_v2_backups__backup_id__get", "parameters": [ { "in": "path", "name": "backup_id", "required": true, "schema": { "title": "Backup Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupSummary" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Backup" } }, "/api/v2/backups/{backup_id}/delete-preview": { "get": { "operationId": "backup_delete_preview_api_v2_backups__backup_id__delete_preview_get", "parameters": [ { "in": "path", "name": "backup_id", "required": true, "schema": { "title": "Backup Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupDeletePreview" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Backup Delete Preview" } }, "/api/v2/backups/{backup_id}/restores": { "post": { "operationId": "create_restore_api_v2_backups__backup_id__restores_post", "parameters": [ { "in": "path", "name": "backup_id", "required": true, "schema": { "title": "Backup Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "in": "header", "name": "X-CSRF-Token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestoreInput" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Create Restore Api V2 Backups Backup Id Restores Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Create Restore" } }, "/api/v2/backups/{backup_id}/verify": { "post": { "operationId": "verify_backup_api_v2_backups__backup_id__verify_post", "parameters": [ { "in": "path", "name": "backup_id", "required": true, "schema": { "title": "Backup Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "in": "header", "name": "X-CSRF-Token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupSummary" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Verify Backup" } }, "/api/v2/executions": { "get": { "operationId": "list_executions_api_v2_executions_get", "parameters": [ { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExecutionList" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Executions" } }, "/api/v2/executions/{execution_id}": { "get": { "operationId": "get_execution_api_v2_executions__execution_id__get", "parameters": [ { "in": "path", "name": "execution_id", "required": true, "schema": { "title": "Execution Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExecutionSummary" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Execution" } }, "/api/v2/executions/{execution_id}/cancel": { "post": { "operationId": "cancel_execution_api_v2_executions__execution_id__cancel_post", "parameters": [ { "in": "path", "name": "execution_id", "required": true, "schema": { "title": "Execution Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "in": "header", "name": "X-CSRF-Token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Csrf-Token" } } ], "responses": { "202": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Cancel Execution Api V2 Executions Execution Id Cancel Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Cancel Execution" } }, "/api/v2/executions/{execution_id}/events": { "get": { "operationId": "execution_events_api_v2_executions__execution_id__events_get", "parameters": [ { "in": "path", "name": "execution_id", "required": true, "schema": { "title": "Execution Id", "type": "string" } }, { "in": "header", "name": "Last-Event-ID", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last-Event-Id" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} }, "text/event-stream": {} }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Execution Events" } }, "/api/v2/executions/{execution_id}/retry": { "post": { "operationId": "retry_execution_api_v2_executions__execution_id__retry_post", "parameters": [ { "in": "path", "name": "execution_id", "required": true, "schema": { "title": "Execution Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "in": "header", "name": "X-CSRF-Token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Csrf-Token" } } ], "responses": { "202": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Retry Execution Api V2 Executions Execution Id Retry Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Retry Execution" } }, "/api/v2/jobs": { "get": { "operationId": "list_jobs_api_v2_jobs_get", "parameters": [ { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobList" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Jobs" }, "post": { "operationId": "create_job_api_v2_jobs_post", "parameters": [ { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "in": "header", "name": "X-CSRF-Token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobInput" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Create Job Api V2 Jobs Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Create Job" } }, "/api/v2/jobs/{job_id}/executions": { "post": { "operationId": "enqueue_execution_api_v2_jobs__job_id__executions_post", "parameters": [ { "in": "path", "name": "job_id", "required": true, "schema": { "title": "Job Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "in": "header", "name": "X-CSRF-Token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Csrf-Token" } } ], "responses": { "202": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Enqueue Execution Api V2 Jobs Job Id Executions Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Enqueue Execution" } }, "/api/v2/jobs/{job_id}/schedule": { "delete": { "operationId": "delete_schedule_api_v2_jobs__job_id__schedule_delete", "parameters": [ { "in": "path", "name": "job_id", "required": true, "schema": { "title": "Job Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "in": "header", "name": "X-CSRF-Token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Csrf-Token" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Delete Schedule" }, "get": { "operationId": "get_schedule_api_v2_jobs__job_id__schedule_get", "parameters": [ { "in": "path", "name": "job_id", "required": true, "schema": { "title": "Job Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Get Schedule Api V2 Jobs Job Id Schedule Get", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Schedule" }, "patch": { "operationId": "patch_schedule_api_v2_jobs__job_id__schedule_patch", "parameters": [ { "in": "path", "name": "job_id", "required": true, "schema": { "title": "Job Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "in": "header", "name": "X-CSRF-Token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Patch Schedule Api V2 Jobs Job Id Schedule Patch", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Patch Schedule" }, "post": { "operationId": "create_schedule_api_v2_jobs__job_id__schedule_post", "parameters": [ { "in": "path", "name": "job_id", "required": true, "schema": { "title": "Job Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "in": "header", "name": "X-CSRF-Token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleInput" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Create Schedule Api V2 Jobs Job Id Schedule Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Create Schedule" } }, "/api/v2/notifications/deliveries": { "get": { "operationId": "list_notification_deliveries_api_v2_notifications_deliveries_get", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "title": "Limit", "type": "integer" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationDeliveryList" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Notification Deliveries" } }, "/api/v2/notifications/deliveries/{delivery_id}/attempts": { "get": { "operationId": "list_notification_attempts_api_v2_notifications_deliveries__delivery_id__attempts_get", "parameters": [ { "in": "path", "name": "delivery_id", "required": true, "schema": { "title": "Delivery Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationAttemptList" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Notification Attempts" } }, "/api/v2/notifications/deliveries/{delivery_id}/retry": { "post": { "operationId": "retry_notification_delivery_api_v2_notifications_deliveries__delivery_id__retry_post", "parameters": [ { "in": "path", "name": "delivery_id", "required": true, "schema": { "title": "Delivery Id", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "in": "header", "name": "X-CSRF-Token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Csrf-Token" } } ], "responses": { "202": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "title": "Response Retry Notification Delivery Api V2 Notifications Deliveries Delivery Id Retry Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Retry Notification Delivery" } }, "/api/v2/notifications/email-settings": { "get": { "operationId": "get_notification_email_settings_api_v2_notifications_email_settings_get", "parameters": [ { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Get Notification Email Settings Api V2 Notifications Email Settings Get", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Notification Email Settings" }, "put": { "operationId": "put_notification_email_settings_api_v2_notifications_email_settings_put", "parameters": [ { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "in": "header", "name": "X-CSRF-Token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailSettingsInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Put Notification Email Settings Api V2 Notifications Email Settings Put", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Put Notification Email Settings" } }, "/api/v2/notifications/event-catalog": { "get": { "operationId": "notification_catalog_api_v2_notifications_event_catalog_get", "parameters": [ { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Notification Catalog Api V2 Notifications Event Catalog Get", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Notification Catalog" } }, "/api/v2/notifications/subscriptions": { "get": { "operationId": "list_notification_subscriptions_api_v2_notifications_subscriptions_get", "parameters": [ { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationSubscriptionList" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Notification Subscriptions" }, "post": { "operationId": "create_notification_subscription_api_v2_notifications_subscriptions_post", "parameters": [ { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "in": "header", "name": "X-CSRF-Token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationSubscriptionInput" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Create Notification Subscription Api V2 Notifications Subscriptions Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Create Notification Subscription" } }, "/api/v2/notifications/subscriptions/{subscription_id}": { "get": { "operationId": "get_notification_subscription_api_v2_notifications_subscriptions__subscription_id__get", "parameters": [ { "in": "path", "name": "subscription_id", "required": true, "schema": { "title": "Subscription Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Get Notification Subscription Api V2 Notifications Subscriptions Subscription Id Get", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Notification Subscription" }, "patch": { "operationId": "patch_notification_subscription_api_v2_notifications_subscriptions__subscription_id__patch", "parameters": [ { "in": "path", "name": "subscription_id", "required": true, "schema": { "title": "Subscription Id", "type": "string" } }, { "in": "header", "name": "If-Match", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "If-Match" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "in": "header", "name": "X-CSRF-Token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationSubscriptionPatch" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Patch Notification Subscription Api V2 Notifications Subscriptions Subscription Id Patch", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Patch Notification Subscription" } }, "/api/v2/notifications/subscriptions/{subscription_id}/signing-keys/rotate": { "post": { "operationId": "rotate_notification_signing_key_api_v2_notifications_subscriptions__subscription_id__signing_keys_rotate_post", "parameters": [ { "in": "path", "name": "subscription_id", "required": true, "schema": { "title": "Subscription Id", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "in": "header", "name": "X-CSRF-Token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SigningKeyRotateInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Rotate Notification Signing Key Api V2 Notifications Subscriptions Subscription Id Signing Keys Rotate Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Rotate Notification Signing Key" } }, "/api/v2/notifications/subscriptions/{subscription_id}/test": { "post": { "operationId": "test_notification_subscription_api_v2_notifications_subscriptions__subscription_id__test_post", "parameters": [ { "in": "path", "name": "subscription_id", "required": true, "schema": { "title": "Subscription Id", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "in": "header", "name": "X-CSRF-Token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Csrf-Token" } } ], "responses": { "202": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "title": "Response Test Notification Subscription Api V2 Notifications Subscriptions Subscription Id Test Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Test Notification Subscription" } }, "/api/v2/repositories": { "get": { "operationId": "list_repositories_api_v2_repositories_get", "parameters": [ { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepositoryList" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Repositories" }, "post": { "operationId": "create_repository_api_v2_repositories_post", "parameters": [ { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "in": "header", "name": "X-CSRF-Token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepositoryInput" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Create Repository Api V2 Repositories Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Create Repository" } }, "/api/v2/repositories/{repository_id}": { "get": { "operationId": "get_repository_api_v2_repositories__repository_id__get", "parameters": [ { "in": "path", "name": "repository_id", "required": true, "schema": { "title": "Repository Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Get Repository Api V2 Repositories Repository Id Get", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Repository" }, "patch": { "operationId": "patch_repository_api_v2_repositories__repository_id__patch", "parameters": [ { "in": "path", "name": "repository_id", "required": true, "schema": { "title": "Repository Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "in": "header", "name": "X-CSRF-Token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepositoryPatch" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Patch Repository" } }, "/api/v2/repositories/{repository_id}/inspection": { "get": { "operationId": "inspect_repository_endpoint_api_v2_repositories__repository_id__inspection_get", "parameters": [ { "in": "path", "name": "repository_id", "required": true, "schema": { "title": "Repository Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Inspect Repository Endpoint Api V2 Repositories Repository Id Inspection Get", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Inspect Repository Endpoint" } }, "/api/v2/restores/{restore_id}": { "get": { "operationId": "get_restore_api_v2_restores__restore_id__get", "parameters": [ { "in": "path", "name": "restore_id", "required": true, "schema": { "title": "Restore Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Get Restore Api V2 Restores Restore Id Get", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Restore" } }, "/api/v2/security/recovery/status": { "get": { "operationId": "recovery_status_api_v2_security_recovery_status_get", "parameters": [ { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecoveryStatus" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Recovery Status" } }, "/api/v2/setup": { "post": { "operationId": "setup_api_v2_setup_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetupInput" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticatedUser" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Setup" } }, "/api/v2/sources": { "get": { "operationId": "list_sources_api_v2_sources_get", "parameters": [ { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceList" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Sources" }, "post": { "operationId": "create_source_api_v2_sources_post", "parameters": [ { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "in": "header", "name": "X-CSRF-Token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Csrf-Token" } } ], "requestBody": { "content": { "application/json": { "schema": { "discriminator": { "mapping": { "local": "#/components/schemas/LocalSourceInput", "ssh": "#/components/schemas/SSHSourceInput" }, "propertyName": "kind" }, "oneOf": [ { "$ref": "#/components/schemas/LocalSourceInput" }, { "$ref": "#/components/schemas/SSHSourceInput" } ], "title": "Input " } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Create Source Api V2 Sources Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Create Source" } }, "/api/v2/sources/{source_id}": { "delete": { "operationId": "archive_source_api_v2_sources__source_id__delete", "parameters": [ { "in": "path", "name": "source_id", "required": true, "schema": { "title": "Source Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "in": "header", "name": "X-CSRF-Token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Csrf-Token" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Archive Source" } }, "/api/v2/sources/{source_id}/probe": { "post": { "operationId": "probe_source_api_v2_sources__source_id__probe_post", "parameters": [ { "in": "path", "name": "source_id", "required": true, "schema": { "title": "Source Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "in": "header", "name": "X-CSRF-Token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Csrf-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Probe Source Api V2 Sources Source Id Probe Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Probe Source" } }, "/livez": { "get": { "operationId": "livez_livez_get", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "title": "Response Livez Livez Get", "type": "object" } } }, "description": "Successful Response" } }, "summary": "Livez" } }, "/readyz": { "get": { "operationId": "readyz_readyz_get", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "title": "Response Readyz Readyz Get", "type": "object" } } }, "description": "Successful Response" } }, "summary": "Readyz" } } } }