{ "components": { "schemas": { "ActionList": { "properties": { "actions": { "items": { "$ref": "#/components/schemas/AuthorizedAction" }, "type": "array" }, "capabilities": { "$ref": "#/components/schemas/ResourceCapabilitiesView" } }, "required": [ "actions", "capabilities" ], "type": "object" }, "ActivitiesView": { "properties": { "pagedResult": { "$ref": "#/components/schemas/PagedActivityView" } }, "required": [ "pagedResult" ], "type": "object" }, "ActivityChangedField": { "properties": { "name": { "type": "string" }, "newValue": { "type": [ "string", "null" ] }, "oldValue": { "type": [ "string", "null" ] } }, "required": [ "name" ], "type": "object" }, "ActivityEventType": { "enum": [ "DeploymentCreated", "DeploymentDuplicated", "DeploymentUpdated", "DeploymentRenamed", "DeploymentDeleted", "DeploymentStarted", "DeploymentStopped", "DeploymentPaused", "DeploymentApplied", "DeploymentDegraded", "DeploymentAdopted", "PlatformCreated", "PlatformDeleted", "PlatformConnected", "PlatformDisconnected", "PlatformRenamed", "PlatformNodeAgentLifecycle", "RegistryCreated", "RegistryRenamed", "RegistryUpdated", "RegistryDeleted", "AlertRuleCreated", "AlertRuleUpdated", "AlertRuleDeleted", "AlertRuleRenamed", "GitRepoCreated", "GitRepoUpdated", "GitRepoDeleted", "GitRepoRenamed", "GitRepoPulled", "GitRepoCloned", "GitRepoWebhookReceived", "OidcProviderCreated", "OidcProviderUpdated", "OidcProviderRenamed", "OidcProviderDeleted", "ActionCreated", "ActionUpdated", "ActionRenamed", "ActionDeleted", "ActionRunQueued", "ActionRunStarted", "ActionRunSucceeded", "ActionRunFailed", "ActionRunTimedOut", "ActionRunCancelled", "ActionRunRejected", "ActionWebhookReceived", "StackCreated", "StackDuplicated", "StackUpdated", "StackRenamed", "StackDeleted", "StackStarted", "StackStopped", "StackPaused", "StackApplied", "StackRollback", "StackDegraded", "StackDriftDetected", "StackDriftResolved", "StackReconciliationAttempted", "StackGitUpdateAvailable", "StackGitAutoUpdated", "StackGitAutoDeployFailed", "StackImported", "StackWebhookReceived", "InitialAdministratorCreated", "UserProfileUpdated", "UserPreferencesUpdated", "UserPasswordChanged", "UserSessionRevoked", "UserOtherSessionsRevoked", "UserMfaEnabled", "UserMfaDisabled", "UserMfaVerificationFailed", "UserMfaRecoveryCodeUsed", "UserMfaRecoveryCodesRegenerated", "UserMfaResetByAdministrator", "UserCreated", "UserUpdated", "UserRenamed", "UserDeleted", "TeamCreated", "TeamUpdated", "TeamRenamed", "TeamDeleted", "RoleCreated", "RoleUpdated", "RoleRenamed", "RoleDeleted", "LicenseInstalled", "LicenseReplaced", "LicenseRemoved", "LicenseEnteredGracePeriod", "LicenseExpired", "LicenseValidationFailed", "VolumeContentDownloaded", "BuildCreated", "BuildUpdated", "BuildRenamed", "BuildDeleted", "BuildRunQueued", "BuildRunStarted", "BuildRunSucceeded", "BuildRunFailed", "BuildRunTimedOut", "BuildRunCancelled", "BuildWebhookReceived", "BuildAgentPoolCreated", "BuildAgentPoolUpdated", "BuildAgentPoolRenamed", "BuildAgentPoolDeleted", "BuildAgentPoolTested", "BuildAgentPoolConnected", "BuildAgentPoolDisconnected", "BackupPolicyCreated", "BackupPolicyUpdated", "BackupPolicyRenamed", "BackupPolicyArchived", "BackupRunQueued", "BackupRunStarted", "BackupRunCompleted", "BackupPolicyWebhookReceived", "SwarmServiceCreated", "SwarmServiceAdopted", "SwarmServiceUpdated", "SwarmServiceRenamed", "SwarmServiceDeleted", "SwarmServiceApplied", "SwarmServiceScaled", "SwarmServiceForceUpdated", "SwarmServiceOperationFailed", "SwarmServiceDuplicated", "SwarmServiceWebhookReceived", "ServiceAccountCreated", "ServiceAccountUpdated", "ServiceAccountRenamed", "ServiceAccountEnabled", "ServiceAccountDisabled", "ServiceAccountArchived", "ServiceAccountTokenCreated", "ServiceAccountTokenRevoked" ], "type": "string" }, "ActivityResourceType": { "enum": [ "Platform", "Registry", "Deployment", "Stack", "AlertRule", "GitRepository", "OidcProvider", "AutomationAction", "User", "Team", "Role", "License", "Build", "BuildAgentPool", "Volume", "BackupPolicy", "SwarmService", "ServiceAccount" ], "type": "string" }, "ActivitySourceResource": { "properties": { "resourceId": { "format": "uuid", "type": "string" }, "resourceName": { "type": "string" }, "resourceType": { "$ref": "#/components/schemas/ActivityResourceType" } }, "required": [ "resourceType", "resourceId", "resourceName" ], "type": "object" }, "ActivityStatus": { "enum": [ "Success", "Failure", "Warning", "Information" ], "type": "string" }, "ActivityView": { "properties": { "actorId": { "format": "uuid", "type": "string" }, "actorName": { "type": "string" }, "actorType": { "$ref": "#/components/schemas/ActorType" }, "createdAt": { "format": "date-time", "type": "string" }, "eventType": { "$ref": "#/components/schemas/ActivityEventType" }, "id": { "format": "uuid", "type": "string" }, "info": { "$ref": "#/components/schemas/PublicActivityEventInfo" }, "platformId": { "format": "uuid", "type": [ "string", "null" ] }, "platformName": { "type": "string" }, "platformStatus": { "$ref": "#/components/schemas/PlatformStatus" }, "resourceId": { "format": "uuid", "type": [ "string", "null" ] }, "resourceName": { "type": "string" }, "resourceType": { "$ref": "#/components/schemas/ActivityResourceType" }, "status": { "$ref": "#/components/schemas/ActivityStatus" } }, "required": [ "id", "platformId", "resourceId", "platformName", "resourceName", "platformStatus", "resourceType", "eventType", "status", "createdAt", "info", "actorId", "actorName", "actorType" ], "type": "object" }, "ActorType": { "enum": [ "User", "System", "Agent", "ServiceAccount", "Team" ], "type": "string" }, "AdoptContainerInput": { "properties": { "description": { "type": [ "string", "null" ] }, "importSensitiveEnvironmentAsSecrets": { "type": "boolean" }, "name": { "type": "string" }, "previewFingerprint": { "type": "string" }, "spec": { "$ref": "#/components/schemas/DeploymentSpec" }, "tagIds": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "required": [ "name", "spec", "previewFingerprint" ], "type": "object" }, "AdoptSwarmServiceInput": { "additionalProperties": false, "properties": { "description": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "previewFingerprint": { "type": "string" }, "spec": { "$ref": "#/components/schemas/SwarmServiceSpec" }, "tagIds": { "items": { "format": "uuid", "type": "string" }, "type": [ "array", "null" ] } }, "required": [ "name", "spec", "previewFingerprint" ], "type": "object" }, "AdoptionDeploymentDraft": { "properties": { "description": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "platformId": { "format": "uuid", "type": "string" }, "spec": { "$ref": "#/components/schemas/DeploymentSpec" }, "tagIds": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "required": [ "name", "platformId", "description", "spec", "tagIds" ], "type": "object" }, "AdoptionIssue": { "properties": { "code": { "type": "string" }, "fieldPath": { "type": [ "string", "null" ] }, "message": { "type": "string" }, "severity": { "$ref": "#/components/schemas/AdoptionIssueSeverity" } }, "required": [ "code", "message", "severity", "fieldPath" ], "type": "object" }, "AdoptionIssueSeverity": { "enum": [ "Warning", "Blocker" ], "type": "string" }, "AdoptionSource": { "properties": { "dockerContainerId": { "type": "string" }, "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "platformId": { "format": "uuid", "type": "string" }, "platformName": { "type": "string" }, "state": { "type": "string" } }, "required": [ "id", "dockerContainerId", "name", "platformId", "platformName", "state" ], "type": "object" }, "AgentSetupView": { "description": "Public installation instructions. The signing private key never enters this model.", "properties": { "agentImage": { "type": "string" }, "dockerRunCommand": { "type": "string" }, "environment": { "additionalProperties": { "type": "string" }, "propertyNames": { "type": "string" }, "type": "object" }, "hubPublicKey": { "type": "string" }, "requiresTls": { "type": "boolean" } }, "required": [ "hubPublicKey", "environment", "agentImage", "dockerRunCommand", "requiresTls" ], "type": "object" }, "AlertChannelInput": { "properties": { "alertDestination": { "$ref": "#/components/schemas/AlertDestination" }, "isActive": { "type": "boolean" }, "name": { "type": [ "string", "null" ] }, "url": { "type": "string" } }, "required": [ "alertDestination", "url", "isActive" ], "type": "object" }, "AlertChannelView": { "properties": { "alertDestination": { "$ref": "#/components/schemas/AlertDestination" }, "capabilities": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ResourceCapabilitiesView" } ] }, "createdAt": { "format": "date-time", "type": "string" }, "createdByActorId": { "format": "uuid", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "isActive": { "type": "boolean" }, "name": { "type": "string" }, "url": { "type": "string" } }, "required": [ "capabilities", "id", "name", "alertDestination", "url", "isActive", "createdByActorId", "createdAt" ], "type": "object" }, "AlertDestination": { "enum": [ "Generic", "Bark", "Discord", "Email", "Gotify", "Google_Chat", "IFTTT", "Join", "Lark", "Mattermost", "Matrix", "Ntfy", "OpsGenie", "Pushbullet", "Pushover", "Rocketchat", "Signal", "Slack", "Teams", "Telegram", "WeCom", "Zulip_Chat" ], "type": "string" }, "AlertEventPage": { "properties": { "items": { "items": { "$ref": "#/components/schemas/AlertEventView" }, "type": "array" }, "page": { "format": "int32", "type": "integer" }, "pageSize": { "format": "int32", "type": "integer" }, "totalCount": { "format": "int64", "type": "integer" } }, "required": [ "items", "totalCount", "page", "pageSize" ], "type": "object" }, "AlertEventStatus": { "enum": [ "Active", "Acknowledged", "Resolved" ], "type": "string" }, "AlertEventView": { "properties": { "acknowledgedAt": { "format": "date-time", "type": [ "string", "null" ] }, "acknowledgedByActorId": { "format": "uuid", "type": [ "string", "null" ] }, "actorId": { "format": "uuid", "type": [ "string", "null" ] }, "actorName": { "type": [ "string", "null" ] }, "actorType": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ActorType" } ] }, "alertRuleId": { "format": "uuid", "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "info": { "description": "Event-specific details supplied by the alert emitter." }, "message": { "type": "string" }, "resolutionNote": { "type": [ "string", "null" ] }, "resolvedAt": { "format": "date-time", "type": [ "string", "null" ] }, "resolvedByActorId": { "format": "uuid", "type": [ "string", "null" ] }, "resourceId": { "format": "uuid", "type": [ "string", "null" ] }, "resourceName": { "type": "string" }, "resourcePath": { "type": [ "string", "null" ] }, "resourceType": { "$ref": "#/components/schemas/AlertResourceType" }, "severity": { "$ref": "#/components/schemas/AlertSeverity" }, "status": { "$ref": "#/components/schemas/AlertEventStatus" }, "type": { "$ref": "#/components/schemas/AlertType" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "alertRuleId", "type", "severity", "status", "message", "info", "resourceId", "resourceName", "resourcePath", "resourceType", "acknowledgedByActorId", "acknowledgedAt", "resolvedByActorId", "resolvedAt", "actorId", "actorName", "actorType", "resolutionNote", "createdAt", "updatedAt" ], "type": "object" }, "AlertQuietHour": { "oneOf": [ { "properties": { "$type": { "enum": [ "Daily" ], "type": "string" }, "description": { "type": [ "string", "null" ] }, "endTime": { "type": "string" }, "name": { "type": "string" }, "startTime": { "type": "string" }, "timezone": { "type": "string" } }, "required": [ "name", "startTime", "endTime", "timezone", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "Weekly" ], "type": "string" }, "dayOfWeek": { "$ref": "#/components/schemas/DayOfWeek" }, "description": { "type": [ "string", "null" ] }, "endTime": { "type": "string" }, "name": { "type": "string" }, "startTime": { "type": "string" }, "timezone": { "type": "string" } }, "required": [ "name", "startTime", "endTime", "timezone", "dayOfWeek", "$type" ], "type": "object" } ] }, "AlertResourceScope": { "properties": { "resourceId": { "format": "uuid", "type": "string" }, "resourceType": { "$ref": "#/components/schemas/AlertResourceType" } }, "required": [ "resourceId", "resourceType" ], "type": "object" }, "AlertResourceType": { "enum": [ "Platform", "Deployment", "Stack", "GitRepository", "Webhook", "AutomationAction", "Build", "BuildAgentPool", "License", "SwarmService" ], "type": "string" }, "AlertRuleActivitySnapshot": { "properties": { "channelIds": { "items": { "format": "uuid", "type": "string" }, "type": "array" }, "cooldownSeconds": { "format": "int32", "type": [ "integer", "null" ] }, "description": { "type": [ "string", "null" ] }, "id": { "format": "uuid", "type": "string" }, "limitedTo": { "items": {}, "type": "array" }, "name": { "type": "string" }, "quietHours": { "items": {}, "type": "array" }, "requiredMatches": { "format": "int32", "type": [ "integer", "null" ] }, "severity": { "type": "string" }, "status": { "type": "string" }, "threshold": { "format": "double", "type": [ "number", "null" ] }, "type": { "type": "string" } }, "required": [ "id", "name", "type", "severity", "status", "channelIds", "limitedTo", "quietHours" ], "type": "object" }, "AlertRuleConfig": { "allOf": [ { "$ref": "#/components/schemas/AlertRuleInput" }, { "properties": { "id": { "format": "uuid", "type": "string" }, "isSystem": { "type": "boolean" } }, "required": [ "id", "isSystem" ], "type": "object" } ] }, "AlertRuleInput": { "properties": { "channelIds": { "items": { "format": "uuid", "type": "string" }, "type": "array" }, "cooldownSeconds": { "format": "int32", "type": [ "integer", "null" ] }, "description": { "type": [ "string", "null" ] }, "limitedTo": { "items": { "$ref": "#/components/schemas/AlertResourceScope" }, "type": "array" }, "name": { "type": [ "string", "null" ] }, "quietHours": { "items": { "$ref": "#/components/schemas/AlertQuietHour" }, "type": "array" }, "requiredMatches": { "format": "int32", "type": [ "integer", "null" ] }, "severity": { "$ref": "#/components/schemas/AlertSeverity" }, "status": { "$ref": "#/components/schemas/AlertRuleStatus" }, "threshold": { "format": "double", "type": [ "number", "null" ] }, "type": { "$ref": "#/components/schemas/AlertType" } }, "required": [ "type", "severity" ], "type": "object" }, "AlertRuleListItem": { "allOf": [ { "$ref": "#/components/schemas/AlertRuleView" }, { "properties": { "channels": { "items": { "$ref": "#/components/schemas/AlertChannelView" }, "type": "array" } }, "required": [ "channels" ], "type": "object" } ] }, "AlertRuleStatus": { "enum": [ "Enabled", "Disabled" ], "type": "string" }, "AlertRuleView": { "properties": { "capabilities": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ResourceCapabilitiesView" } ] }, "channelIds": { "items": { "format": "uuid", "type": "string" }, "type": "array" }, "cooldownSeconds": { "format": "int32", "type": [ "integer", "null" ] }, "createdAt": { "format": "date-time", "type": "string" }, "createdByActorId": { "format": "uuid", "type": "string" }, "description": { "type": [ "string", "null" ] }, "id": { "format": "uuid", "type": "string" }, "limitedTo": { "items": { "$ref": "#/components/schemas/AlertResourceScope" }, "type": "array" }, "name": { "type": "string" }, "quietHours": { "items": { "$ref": "#/components/schemas/AlertQuietHour" }, "type": "array" }, "requiredMatches": { "format": "int32", "type": [ "integer", "null" ] }, "severity": { "$ref": "#/components/schemas/AlertSeverity" }, "status": { "$ref": "#/components/schemas/AlertRuleStatus" }, "threshold": { "format": "double", "type": [ "number", "null" ] }, "type": { "$ref": "#/components/schemas/AlertType" } }, "required": [ "capabilities", "id", "name", "description", "type", "severity", "cooldownSeconds", "requiredMatches", "threshold", "status", "channelIds", "limitedTo", "quietHours", "createdByActorId", "createdAt" ], "type": "object" }, "AlertSeverity": { "enum": [ "Info", "Warning", "Critical" ], "type": "string" }, "AlertType": { "enum": [ "PlatformCpuHigh", "PlatformRamHigh", "PlatformDiskHigh", "PlatformUnreachable", "PlatformVersionMismatch", "UnmanagedContainerCreated", "DeploymentImageUpdateAvailable", "DeploymentAutoDeployFailed", "DeploymentAutoUpdated", "SwarmServiceOperationFailed", "StackImageUpdateAvailable", "StackAutoDeployFailed", "StackAutoUpdated", "StackServiceAutoDeployFailed", "StackServiceAutoUpdated", "StackDriftDetected", "StackDriftAutoReconciled", "StackGitUpdateAvailable", "StackGitAutoUpdated", "StackGitAutoDeployFailed", "StackConfigurationResolutionFailed", "DeploymentConfigurationResolutionFailed", "WebhookAuthenticationFailed", "WebhookDispatchFailed", "WebhookGitRepoSyncFailed", "WebhookStackGitDeployFailed", "AutomationActionRunFailed", "BuildRunFailed", "BuildAgentPoolUnavailable", "LicenseEnteredGracePeriod", "LicenseExpired" ], "type": "string" }, "ApplyDeploymentInput": { "additionalProperties": false, "properties": { "id": { "format": "uuid", "type": "string" }, "recreate": { "type": [ "boolean", "null" ] } }, "required": [ "id" ], "type": "object" }, "ApplyStackInput": { "additionalProperties": false, "properties": { "id": { "format": "uuid", "type": "string" }, "recreate": { "type": [ "boolean", "null" ] } }, "required": [ "id" ], "type": "object" }, "AuthorizedAction": { "allOf": [ { "$ref": "#/components/schemas/AutomationActionView" }, { "properties": { "capabilities": { "$ref": "#/components/schemas/ResourceCapabilitiesView" } }, "required": [ "capabilities" ], "type": "object" } ] }, "AuthorizedGitRepositoryView": { "allOf": [ { "$ref": "#/components/schemas/GitRepositoryView" }, { "properties": { "capabilities": { "$ref": "#/components/schemas/ResourceCapabilitiesView" } }, "required": [ "capabilities" ], "type": "object" } ] }, "AuthorizedPool": { "allOf": [ { "$ref": "#/components/schemas/BuildAgentPoolView" }, { "properties": { "capabilities": { "$ref": "#/components/schemas/ResourceCapabilitiesView" } }, "required": [ "capabilities" ], "type": "object" } ] }, "AuthorizedProject": { "allOf": [ { "$ref": "#/components/schemas/BuildProjectView" }, { "properties": { "capabilities": { "$ref": "#/components/schemas/ResourceCapabilitiesView" } }, "required": [ "capabilities" ], "type": "object" } ] }, "AuthorizedRegistryView": { "allOf": [ { "$ref": "#/components/schemas/RegistryView" }, { "properties": { "capabilities": { "$ref": "#/components/schemas/ResourceCapabilitiesView" }, "isDefault": { "type": "boolean" } }, "required": [ "capabilities", "isDefault" ], "type": "object" } ] }, "AuthorizedTagView": { "allOf": [ { "$ref": "#/components/schemas/TagView" }, { "properties": { "capabilities": { "$ref": "#/components/schemas/ResourceCapabilitiesView" } }, "required": [ "capabilities" ], "type": "object" } ] }, "AutoUpdateState": { "properties": { "currentDigest": { "type": [ "string", "null" ] }, "lastCheckedAt": { "format": "date-time", "type": "string" }, "lastError": { "type": [ "string", "null" ] }, "remoteDigest": { "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/AutoUpdateStatus" } }, "required": [ "lastCheckedAt", "status" ], "type": "object" }, "AutoUpdateStatus": { "enum": [ "Unknown", "UpToDate", "UpdateAvailable", "Updating", "Failed" ], "type": "string" }, "AutomationActionActivitySnapshot": { "properties": { "alertOnFailure": { "type": "boolean" }, "code": { "type": "string" }, "defaultArgsJson": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "enabled": { "type": "boolean" }, "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "runAsActorId": { "format": "uuid", "type": "string" }, "scheduleCron": { "type": [ "string", "null" ] }, "scheduleEnabled": { "type": "boolean" }, "scheduleTimeZone": { "type": "string" }, "timeoutSeconds": { "format": "int32", "type": "integer" }, "webhook": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/WebhookConfig" } ] } }, "required": [ "id", "name", "code", "defaultArgsJson", "enabled", "scheduleEnabled", "scheduleTimeZone", "timeoutSeconds", "alertOnFailure", "runAsActorId" ], "type": "object" }, "AutomationActionInput": { "properties": { "alertOnFailure": { "type": "boolean" }, "code": { "type": "string" }, "defaultArgsJson": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "enabled": { "type": "boolean" }, "name": { "type": "string" }, "runAsActorId": { "format": "uuid", "type": [ "string", "null" ] }, "scheduleCron": { "type": [ "string", "null" ] }, "scheduleEnabled": { "type": "boolean" }, "scheduleTimeZone": { "type": [ "string", "null" ] }, "tagIds": { "items": { "format": "uuid", "type": "string" }, "type": "array" }, "timeoutSeconds": { "format": "int32", "type": [ "integer", "null" ] }, "webhook": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/WebhookConfig" } ] } }, "required": [ "name", "code", "enabled", "scheduleEnabled", "alertOnFailure" ], "type": "object" }, "AutomationActionRunLogsView": { "properties": { "logs": { "type": "string" }, "runId": { "format": "uuid", "type": "string" } }, "required": [ "runId", "logs" ], "type": "object" }, "AutomationActionView": { "properties": { "alertOnFailure": { "type": "boolean" }, "code": { "type": "string" }, "controlState": { "$ref": "#/components/schemas/ResourceControlState" }, "createdAt": { "format": "date-time", "type": "string" }, "createdByActorId": { "format": "uuid", "type": "string" }, "currentRunId": { "format": "uuid", "type": [ "string", "null" ] }, "defaultArgsJson": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "enabled": { "type": "boolean" }, "id": { "format": "uuid", "type": "string" }, "lastScheduledRunAt": { "format": "date-time", "type": [ "string", "null" ] }, "latestRun": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/AutomationRunView" } ] }, "name": { "type": "string" }, "rowVersion": { "format": "int64", "type": "integer" }, "runAsActorId": { "format": "uuid", "type": "string" }, "scheduleCron": { "type": [ "string", "null" ] }, "scheduleEnabled": { "type": "boolean" }, "scheduleTimeZone": { "type": "string" }, "tags": { "items": { "$ref": "#/components/schemas/resources.tags.TagSummary" }, "type": "array" }, "timeoutSeconds": { "format": "int32", "type": "integer" }, "updatedAt": { "format": "date-time", "type": "string" }, "webhook": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/WebhookConfig" } ] } }, "required": [ "id", "name", "description", "code", "defaultArgsJson", "enabled", "scheduleEnabled", "scheduleCron", "scheduleTimeZone", "webhook", "timeoutSeconds", "alertOnFailure", "runAsActorId", "controlState", "currentRunId", "rowVersion", "createdByActorId", "createdAt", "updatedAt", "lastScheduledRunAt", "tags", "latestRun" ], "type": "object" }, "AutomationProgress": { "properties": { "error": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/AutomationProgressError" } ] }, "errorMessage": { "type": [ "string", "null" ] }, "progressMessage": { "type": [ "string", "null" ] }, "runId": { "format": "uuid", "type": [ "string", "null" ] }, "status": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/AutomationRunStatus" } ] }, "stream": { "type": [ "string", "null" ] } }, "required": [ "runId", "status", "stream", "progressMessage", "errorMessage", "error" ], "type": "object" }, "AutomationProgressError": { "properties": { "code": { "format": "int32", "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" }, "AutomationRunStatus": { "enum": [ "Queued", "Running", "Succeeded", "Failed", "TimedOut", "Cancelled", "Rejected" ], "type": "string" }, "AutomationRunTrigger": { "enum": [ "Manual", "Test", "Schedule", "Webhook" ], "type": "string" }, "AutomationRunView": { "properties": { "actionId": { "format": "uuid", "type": "string" }, "actionName": { "type": "string" }, "argsJson": { "type": "string" }, "codeHash": { "type": "string" }, "codeSnapshot": { "type": [ "string", "null" ] }, "durationMs": { "format": "int64", "type": [ "integer", "null" ] }, "errorMessage": { "type": [ "string", "null" ] }, "exitCode": { "format": "int32", "type": [ "integer", "null" ] }, "finishedAt": { "format": "date-time", "type": [ "string", "null" ] }, "id": { "format": "uuid", "type": "string" }, "logs": { "type": [ "string", "null" ] }, "queuedAt": { "format": "date-time", "type": "string" }, "runAsActorId": { "format": "uuid", "type": "string" }, "startedAt": { "format": "date-time", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/AutomationRunStatus" }, "timeoutSeconds": { "format": "int32", "type": "integer" }, "trigger": { "$ref": "#/components/schemas/AutomationRunTrigger" }, "triggeredByActorId": { "format": "uuid", "type": [ "string", "null" ] } }, "required": [ "id", "actionId", "actionName", "trigger", "status", "runAsActorId", "triggeredByActorId", "argsJson", "codeSnapshot", "codeHash", "timeoutSeconds", "queuedAt", "startedAt", "finishedAt", "durationMs", "exitCode", "logs", "errorMessage" ], "type": "object" }, "AwsEc2BuildAgentPoolProviderSpec": { "properties": { "amiId": { "default": "", "type": "string" }, "architecture": { "default": "Amd64", "oneOf": [ { "$ref": "#/components/schemas/CpuArchitecture" } ] }, "assignPublicIp": { "default": false, "type": "boolean" }, "assumeRoleArn": { "default": null, "type": [ "string", "null" ] }, "awsCredentialSecretId": { "default": null, "format": "uuid", "type": [ "string", "null" ] }, "instanceProfileName": { "default": null, "type": [ "string", "null" ] }, "instanceType": { "default": "", "type": "string" }, "keyPairName": { "default": null, "type": [ "string", "null" ] }, "region": { "default": "", "type": "string" }, "rootVolumeSizeGb": { "default": 0, "format": "int32", "type": "integer" }, "securityGroupIds": { "default": [], "items": { "type": "string" }, "type": "array" }, "subnetId": { "default": "", "type": "string" }, "tags": { "additionalProperties": { "type": "string" }, "default": null, "propertyNames": { "type": "string" }, "type": [ "object", "null" ] } }, "type": "object" }, "BackupCoverageStatus": { "enum": [ "NotApplicable", "Unprotected", "Protected", "Warning", "Failed" ], "type": "string" }, "BackupCoverageView": { "properties": { "lastRunAt": { "format": "date-time", "type": [ "string", "null" ] }, "lastRunId": { "format": "uuid", "type": [ "string", "null" ] }, "lastRunStatus": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/BackupRunStatus" } ] }, "lastSuccessfulRunAt": { "format": "date-time", "type": [ "string", "null" ] }, "nextRunAt": { "format": "date-time", "type": [ "string", "null" ] }, "policyCount": { "format": "int32", "type": "integer" }, "status": { "$ref": "#/components/schemas/BackupCoverageStatus" } }, "required": [ "status", "policyCount" ], "type": "object" }, "BackupExecutionLocation": { "enum": [ "Core", "Platform" ], "type": "string" }, "BackupMetadataPatch": { "properties": { "description": { "type": [ "string", "null" ] } }, "type": "object" }, "BackupPolicyActivitySnapshot": { "properties": { "alertOnFailure": { "type": "boolean" }, "backupRepositoryId": { "format": "uuid", "type": "string" }, "cron": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "enabled": { "type": "boolean" }, "id": { "format": "uuid", "type": "string" }, "keepLastSuccessful": { "format": "int32", "type": "integer" }, "name": { "type": "string" }, "runAsActorId": { "format": "uuid", "type": "string" }, "sourceKey": { "type": "string" }, "sourceType": { "type": "string" }, "timeZone": { "type": [ "string", "null" ] }, "timeoutSeconds": { "format": "int32", "type": "integer" }, "webhookEnabled": { "type": "boolean" } }, "required": [ "id", "name", "sourceType", "sourceKey", "backupRepositoryId", "enabled", "webhookEnabled", "keepLastSuccessful", "timeoutSeconds", "alertOnFailure", "runAsActorId" ], "type": "object" }, "BackupPolicyInput": { "properties": { "alertOnFailure": { "type": "boolean" }, "backupRepositoryId": { "format": "uuid", "type": "string" }, "cron": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "enabled": { "type": "boolean" }, "keepLastSuccessful": { "format": "int32", "type": [ "integer", "null" ] }, "name": { "type": "string" }, "runAsActorId": { "format": "uuid", "type": [ "string", "null" ] }, "source": { "$ref": "#/components/schemas/BackupSourceSpec" }, "tagIds": { "items": { "format": "uuid", "type": "string" }, "type": "array" }, "timeZone": { "type": [ "string", "null" ] }, "timeoutSeconds": { "format": "int32", "type": [ "integer", "null" ] }, "webhook": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/WebhookConfig" } ] } }, "required": [ "name", "source", "backupRepositoryId", "enabled", "alertOnFailure" ], "type": "object" }, "BackupPolicyView": { "properties": { "alertOnFailure": { "type": "boolean" }, "archivedAt": { "format": "date-time", "type": [ "string", "null" ] }, "backupRepositoryId": { "format": "uuid", "type": "string" }, "capabilities": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ResourceCapabilitiesView" } ] }, "controlState": { "$ref": "#/components/schemas/ResourceControlState" }, "createdAt": { "format": "date-time", "type": "string" }, "createdByActorId": { "format": "uuid", "type": "string" }, "cron": { "type": [ "string", "null" ] }, "currentRunId": { "format": "uuid", "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "enabled": { "type": "boolean" }, "firstSuccessfulRunAt": { "format": "date-time", "type": [ "string", "null" ] }, "id": { "format": "uuid", "type": "string" }, "keepLastSuccessful": { "format": "int32", "type": "integer" }, "lastScheduledRunAt": { "format": "date-time", "type": [ "string", "null" ] }, "latestRun": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/BackupRunView" } ] }, "name": { "type": "string" }, "normalizedName": { "type": "string" }, "rowVersion": { "format": "int64", "type": "integer" }, "runAsActorId": { "format": "uuid", "type": "string" }, "source": { "$ref": "#/components/schemas/BackupSourceSpec" }, "tags": { "items": { "$ref": "#/components/schemas/resources.tags.TagSummary" }, "type": "array" }, "timeZone": { "type": [ "string", "null" ] }, "timeoutSeconds": { "format": "int32", "type": "integer" }, "updatedAt": { "format": "date-time", "type": "string" }, "webhook": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/WebhookConfig" } ] } }, "required": [ "tags", "latestRun", "capabilities", "id", "name", "normalizedName", "description", "source", "backupRepositoryId", "enabled", "cron", "timeZone", "webhook", "keepLastSuccessful", "timeoutSeconds", "alertOnFailure", "runAsActorId", "controlState", "currentRunId", "lastScheduledRunAt", "firstSuccessfulRunAt", "createdByActorId", "createdAt", "updatedAt", "archivedAt", "rowVersion" ], "type": "object" }, "BackupPreviewResource": { "oneOf": [ { "properties": { "deploymentId": { "format": "uuid", "type": "string" }, "deploymentName": { "type": "string" } }, "required": [ "deploymentId", "deploymentName" ], "type": "object" }, { "properties": { "stackId": { "format": "uuid", "type": "string" }, "stackName": { "type": "string" } }, "required": [ "stackId", "stackName" ], "type": "object" }, { "properties": { "swarmServiceId": { "format": "uuid", "type": "string" }, "swarmServiceName": { "type": "string" } }, "required": [ "swarmServiceId", "swarmServiceName" ], "type": "object" } ] }, "BackupQueueTrigger": { "enum": [ "Manual", "Schedule", "Webhook" ], "type": "string" }, "BackupRepositoryInput": { "properties": { "description": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "passwordSecretId": { "format": "uuid", "type": "string" }, "spec": { "$ref": "#/components/schemas/BackupRepositorySpec" } }, "required": [ "name", "spec", "passwordSecretId" ], "type": "object" }, "BackupRepositorySpec": { "oneOf": [ { "properties": { "$type": { "enum": [ "FileSystem" ], "type": "string" }, "location": { "$ref": "#/components/schemas/BackupExecutionLocation" }, "path": { "type": "string" }, "platformId": { "format": "uuid", "type": [ "string", "null" ] } }, "required": [ "location", "path", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "S3Compatible" ], "type": "string" }, "accessKeySecretId": { "format": "uuid", "type": "string" }, "allowInsecureHttp": { "type": "boolean" }, "bucket": { "type": "string" }, "bucketLookup": { "$ref": "#/components/schemas/S3BucketLookup" }, "endpoint": { "type": "string" }, "prefix": { "type": [ "string", "null" ] }, "region": { "type": [ "string", "null" ] }, "secretKeySecretId": { "format": "uuid", "type": "string" }, "sessionTokenSecretId": { "format": "uuid", "type": [ "string", "null" ] } }, "required": [ "endpoint", "bucket", "accessKeySecretId", "secretKeySecretId", "$type" ], "type": "object" } ] }, "BackupRepositoryStatus": { "enum": [ "Unavailable", "Unknown", "Uninitialized", "Ready" ], "type": "string" }, "BackupRepositoryType": { "enum": [ "FileSystem", "S3Compatible" ], "type": "string" }, "BackupRepositoryValidationStatus": { "enum": [ "Unknown", "Ready", "Uninitialized", "Unavailable", "InvalidPassword", "InvalidConfiguration" ], "type": "string" }, "BackupRepositoryValidationView": { "properties": { "backupRepositoryId": { "format": "uuid", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "lastErrorCode": { "type": [ "string", "null" ] }, "lastErrorMessage": { "type": [ "string", "null" ] }, "lastValidatedAt": { "format": "date-time", "type": "string" }, "location": { "$ref": "#/components/schemas/BackupExecutionLocation" }, "platformId": { "format": "uuid", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/BackupRepositoryValidationStatus" } }, "required": [ "id", "backupRepositoryId", "location", "platformId", "status", "lastValidatedAt", "lastErrorCode", "lastErrorMessage" ], "type": "object" }, "BackupRepositoryView": { "properties": { "archivedAt": { "format": "date-time", "type": [ "string", "null" ] }, "capabilities": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ResourceCapabilitiesView" } ] }, "controlStartedAt": { "format": "int64", "type": [ "integer", "null" ] }, "controlState": { "$ref": "#/components/schemas/ResourceControlState" }, "createdAt": { "format": "date-time", "type": "string" }, "createdByActorId": { "format": "uuid", "type": "string" }, "currentRunId": { "format": "uuid", "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "id": { "format": "uuid", "type": "string" }, "lastCheckedAt": { "format": "date-time", "type": [ "string", "null" ] }, "lastPrunedAt": { "format": "date-time", "type": [ "string", "null" ] }, "name": { "type": "string" }, "normalizedName": { "type": "string" }, "passwordSecretId": { "format": "uuid", "type": "string" }, "rowVersion": { "format": "int64", "type": "integer" }, "spec": { "$ref": "#/components/schemas/BackupRepositorySpec" }, "status": { "$ref": "#/components/schemas/BackupRepositoryStatus" }, "type": { "$ref": "#/components/schemas/BackupRepositoryType" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "capabilities", "id", "name", "normalizedName", "description", "type", "spec", "passwordSecretId", "status", "controlState", "currentRunId", "controlStartedAt", "lastPrunedAt", "lastCheckedAt", "createdByActorId", "createdAt", "updatedAt", "archivedAt", "rowVersion" ], "type": "object" }, "BackupRestoreRunStreamItem": { "properties": { "exitCode": { "format": "int32", "type": [ "integer", "null" ] }, "message": { "type": [ "string", "null" ] }, "restoreRunId": { "format": "uuid", "type": "string" }, "status": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/BackupRestoreStatus" } ] }, "stream": { "type": [ "string", "null" ] } }, "required": [ "restoreRunId" ], "type": "object" }, "BackupRestoreRunView": { "properties": { "backupRepositoryId": { "format": "uuid", "type": "string" }, "backupRunId": { "format": "uuid", "type": "string" }, "completedAt": { "format": "date-time", "type": [ "string", "null" ] }, "errorCode": { "type": [ "string", "null" ] }, "errorMessage": { "type": [ "string", "null" ] }, "exitCode": { "format": "int32", "type": [ "integer", "null" ] }, "id": { "format": "uuid", "type": "string" }, "overwriteExisting": { "type": "boolean" }, "queuedAt": { "format": "date-time", "type": "string" }, "sourceBackupRunItemId": { "format": "uuid", "type": [ "string", "null" ] }, "startedAt": { "format": "date-time", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/BackupRestoreStatus" }, "targetDockerNodeId": { "type": [ "string", "null" ] }, "targetPlatformId": { "format": "uuid", "type": "string" }, "targetVolumeName": { "type": "string" }, "triggeredByActorId": { "format": "uuid", "type": "string" } }, "required": [ "id", "backupRunId", "backupRepositoryId", "sourceBackupRunItemId", "targetPlatformId", "targetDockerNodeId", "targetVolumeName", "overwriteExisting", "status", "queuedAt", "startedAt", "completedAt", "exitCode", "errorCode", "errorMessage", "triggeredByActorId" ], "type": "object" }, "BackupRestoreStatus": { "enum": [ "Queued", "Preparing", "Running", "Succeeded", "SucceededWithWarnings", "Failed", "TimedOut", "Cancelled", "Rejected", "Interrupted", "Processing" ], "type": "string" }, "BackupRunItemStatus": { "enum": [ "Queued", "Pending", "Running", "Succeeded", "Failed", "Cancelled" ], "type": "string" }, "BackupRunItemView": { "properties": { "backupRunId": { "format": "uuid", "type": "string" }, "bytesAdded": { "format": "int64", "type": [ "integer", "null" ] }, "bytesProcessed": { "format": "int64", "type": [ "integer", "null" ] }, "completedAt": { "format": "date-time", "type": [ "string", "null" ] }, "dockerNodeId": { "type": [ "string", "null" ] }, "errorCode": { "type": [ "string", "null" ] }, "errorMessage": { "type": [ "string", "null" ] }, "exitCode": { "format": "int32", "type": [ "integer", "null" ] }, "filesProcessed": { "format": "int64", "type": [ "integer", "null" ] }, "id": { "format": "uuid", "type": "string" }, "nodeHostname": { "type": [ "string", "null" ] }, "parentSnapshotId": { "type": [ "string", "null" ] }, "platformId": { "format": "uuid", "type": "string" }, "resticSnapshotId": { "type": [ "string", "null" ] }, "startedAt": { "format": "date-time", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/BackupRunItemStatus" }, "volumeName": { "type": "string" } }, "required": [ "id", "backupRunId", "platformId", "volumeName", "dockerNodeId", "nodeHostname", "status", "resticSnapshotId", "parentSnapshotId", "filesProcessed", "bytesProcessed", "bytesAdded", "startedAt", "completedAt", "exitCode", "errorCode", "errorMessage" ], "type": "object" }, "BackupRunStatus": { "enum": [ "Queued", "Preparing", "Running", "ApplyingRetention", "Succeeded", "SucceededWithWarnings", "Failed", "TimedOut", "Cancelled", "Rejected", "Interrupted", "Processing" ], "type": "string" }, "BackupRunStreamItem": { "properties": { "exitCode": { "format": "int32", "type": [ "integer", "null" ] }, "message": { "type": [ "string", "null" ] }, "runId": { "format": "uuid", "type": "string" }, "status": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/BackupRunStatus" } ] }, "stream": { "type": [ "string", "null" ] } }, "required": [ "runId" ], "type": "object" }, "BackupRunTrigger": { "enum": [ "Manual", "Schedule", "Automation", "Webhook" ], "type": "string" }, "BackupRunView": { "properties": { "backupPolicyId": { "format": "uuid", "type": "string" }, "backupRepositoryId": { "format": "uuid", "type": "string" }, "bytesAdded": { "format": "int64", "type": [ "integer", "null" ] }, "bytesProcessed": { "format": "int64", "type": [ "integer", "null" ] }, "completedAt": { "format": "date-time", "type": [ "string", "null" ] }, "errorCode": { "type": [ "string", "null" ] }, "errorMessage": { "type": [ "string", "null" ] }, "exitCode": { "format": "int32", "type": [ "integer", "null" ] }, "filesProcessed": { "format": "int64", "type": [ "integer", "null" ] }, "id": { "format": "uuid", "type": "string" }, "items": { "items": { "$ref": "#/components/schemas/BackupRunItemView" }, "type": "array" }, "parentSnapshotId": { "type": [ "string", "null" ] }, "policyNameSnapshot": { "type": "string" }, "queuedAt": { "format": "date-time", "type": "string" }, "repositoryTypeSnapshot": { "$ref": "#/components/schemas/BackupRepositoryType" }, "resticSnapshotId": { "type": [ "string", "null" ] }, "snapshotAvailability": { "$ref": "#/components/schemas/BackupSnapshotAvailability" }, "sourceSnapshot": { "$ref": "#/components/schemas/BackupSourceSpec" }, "startedAt": { "format": "date-time", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/BackupRunStatus" }, "trigger": { "$ref": "#/components/schemas/BackupRunTrigger" }, "triggeredByActorId": { "format": "uuid", "type": "string" }, "warnings": { "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "backupPolicyId", "policyNameSnapshot", "backupRepositoryId", "repositoryTypeSnapshot", "sourceSnapshot", "trigger", "status", "snapshotAvailability", "resticSnapshotId", "parentSnapshotId", "filesProcessed", "bytesProcessed", "bytesAdded", "warnings", "queuedAt", "startedAt", "completedAt", "exitCode", "errorCode", "errorMessage", "triggeredByActorId", "items" ], "type": "object" }, "BackupSnapshotAvailability": { "enum": [ "Pending", "Available", "Expired", "Missing", "NotCreated" ], "type": "string" }, "BackupSourcePreview": { "allOf": [ { "$ref": "#/components/schemas/BackupPreviewResource" }, { "properties": { "platformId": { "format": "uuid", "type": "string" }, "platformName": { "type": "string" }, "platformStatus": { "$ref": "#/components/schemas/PlatformStatus" }, "volumes": { "items": { "$ref": "#/components/schemas/BackupVolumePreview" }, "type": "array" }, "warnings": { "items": { "type": "string" }, "type": "array" } }, "required": [ "platformId", "platformName", "platformStatus", "volumes", "warnings" ], "type": "object" } ] }, "BackupSourceSpec": { "oneOf": [ { "properties": { "$type": { "enum": [ "DockerVolume" ], "type": "string" }, "consistency": { "$ref": "#/components/schemas/VolumeBackupConsistency" }, "dockerNodeId": { "type": [ "string", "null" ] }, "platformId": { "format": "uuid", "type": "string" }, "volumeName": { "type": "string" } }, "required": [ "platformId", "volumeName", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "CitadelSystem" ], "type": "string" } }, "required": [ "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "Stack" ], "type": "string" }, "stackId": { "format": "uuid", "type": "string" } }, "required": [ "stackId", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "Deployment" ], "type": "string" }, "deploymentId": { "format": "uuid", "type": "string" } }, "required": [ "deploymentId", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "SwarmService" ], "type": "string" }, "swarmServiceId": { "format": "uuid", "type": "string" } }, "required": [ "swarmServiceId", "$type" ], "type": "object" } ] }, "BackupVolumePreview": { "properties": { "dockerNodeId": { "type": [ "string", "null" ] }, "hasBackupCoverage": { "type": "boolean" }, "isExternal": { "type": "boolean" }, "isShared": { "type": "boolean" }, "kind": { "type": "string" }, "name": { "type": "string" }, "nodeHostname": { "type": [ "string", "null" ] } }, "required": [ "name", "kind", "isExternal", "isShared", "hasBackupCoverage" ], "type": "object" }, "BuildAgentPoolActivitySnapshot": { "properties": { "architecture": { "type": "string" }, "cleanupTimeoutSeconds": { "format": "int32", "type": "integer" }, "description": { "type": [ "string", "null" ] }, "enabled": { "type": "boolean" }, "failureRetentionMinutes": { "format": "int32", "type": "integer" }, "heartbeatTimeoutSeconds": { "format": "int32", "type": "integer" }, "id": { "format": "uuid", "type": "string" }, "instanceType": { "type": "string" }, "lastValidatedAt": { "format": "date-time", "type": [ "string", "null" ] }, "lastValidationMessage": { "type": [ "string", "null" ] }, "lastValidationStatus": { "type": "string" }, "maxActiveBuilders": { "format": "int32", "type": "integer" }, "maximumInstanceLifetimeSeconds": { "format": "int32", "type": "integer" }, "name": { "type": "string" }, "provider": { "type": "string" }, "providerSpec": {}, "provisioningTimeoutSeconds": { "format": "int32", "type": "integer" }, "queueTimeoutSeconds": { "format": "int32", "type": "integer" }, "region": { "type": "string" }, "registrationTimeoutSeconds": { "format": "int32", "type": "integer" } }, "required": [ "id", "name", "enabled", "provider", "providerSpec", "architecture", "region", "instanceType", "maxActiveBuilders", "queueTimeoutSeconds", "provisioningTimeoutSeconds", "registrationTimeoutSeconds", "heartbeatTimeoutSeconds", "cleanupTimeoutSeconds", "maximumInstanceLifetimeSeconds", "failureRetentionMinutes", "lastValidationStatus" ], "type": "object" }, "BuildAgentPoolConnectionMode": { "enum": [ "InboundAgent", "EdgeAgent" ], "type": "string" }, "BuildAgentPoolInput": { "properties": { "cleanupTimeoutSeconds": { "format": "int32", "type": [ "integer", "null" ] }, "description": { "type": [ "string", "null" ] }, "enabled": { "type": "boolean" }, "failureRetentionMinutes": { "format": "int32", "type": [ "integer", "null" ] }, "heartbeatTimeoutSeconds": { "format": "int32", "type": [ "integer", "null" ] }, "maxActiveBuilders": { "format": "int32", "type": [ "integer", "null" ] }, "maximumInstanceLifetimeSeconds": { "format": "int32", "type": [ "integer", "null" ] }, "name": { "type": "string" }, "providerSpec": { "$ref": "#/components/schemas/BuildAgentPoolProviderSpec" }, "provisioningTimeoutSeconds": { "format": "int32", "type": [ "integer", "null" ] }, "queueTimeoutSeconds": { "format": "int32", "type": [ "integer", "null" ] }, "registrationTimeoutSeconds": { "format": "int32", "type": [ "integer", "null" ] }, "tagIds": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "required": [ "name", "enabled", "providerSpec" ], "type": "object" }, "BuildAgentPoolProvider": { "enum": [ "AwsEc2", "SelfManagedVm" ], "type": "string" }, "BuildAgentPoolProviderSpec": { "oneOf": [ { "allOf": [ { "$ref": "#/components/schemas/AwsEc2BuildAgentPoolProviderSpec" }, { "properties": { "$type": { "enum": [ "AwsEc2" ], "type": "string" } }, "required": [ "$type" ], "type": "object" } ] }, { "allOf": [ { "$ref": "#/components/schemas/SelfManagedVmBuildAgentPoolProviderSpec" }, { "properties": { "$type": { "enum": [ "SelfManagedVm" ], "type": "string" } }, "required": [ "$type" ], "type": "object" } ] } ] }, "BuildAgentPoolValidationStatus": { "enum": [ "NotTested", "Ready", "Invalid", "Degraded" ], "type": "string" }, "BuildAgentPoolView": { "properties": { "archivedAt": { "format": "date-time", "type": [ "string", "null" ] }, "cleanupTimeoutSeconds": { "format": "int32", "type": "integer" }, "connectionStatus": { "description": "Edge transport connection status, independent of build capability validation.", "type": [ "string", "null" ] }, "controlStartedAt": { "format": "int64", "type": [ "integer", "null" ] }, "controlState": { "$ref": "#/components/schemas/ResourceControlState" }, "controlTriggeredBy": { "format": "uuid", "type": [ "string", "null" ] }, "createdAt": { "format": "date-time", "type": "string" }, "createdByActorId": { "format": "uuid", "type": "string" }, "description": { "type": [ "string", "null" ] }, "enabled": { "type": "boolean" }, "failureRetentionMinutes": { "format": "int32", "type": "integer" }, "heartbeatTimeoutSeconds": { "format": "int32", "type": "integer" }, "id": { "format": "uuid", "type": "string" }, "lastValidatedAt": { "format": "date-time", "type": [ "string", "null" ] }, "lastValidationMessage": { "type": [ "string", "null" ] }, "lastValidationStatus": { "$ref": "#/components/schemas/BuildAgentPoolValidationStatus" }, "maxActiveBuilders": { "format": "int32", "type": "integer" }, "maximumInstanceLifetimeSeconds": { "format": "int32", "type": "integer" }, "name": { "type": "string" }, "normalizedName": { "type": "string" }, "provider": { "$ref": "#/components/schemas/BuildAgentPoolProvider" }, "providerSpec": { "$ref": "#/components/schemas/BuildAgentPoolProviderSpec" }, "provisioningTimeoutSeconds": { "format": "int32", "type": "integer" }, "queueTimeoutSeconds": { "format": "int32", "type": "integer" }, "registrationTimeoutSeconds": { "format": "int32", "type": "integer" }, "rowVersion": { "format": "int64", "type": "integer" }, "tags": { "items": { "$ref": "#/components/schemas/resources.tags.TagSummary" }, "type": "array" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "tags", "id", "name", "normalizedName", "description", "enabled", "provider", "providerSpec", "maxActiveBuilders", "queueTimeoutSeconds", "provisioningTimeoutSeconds", "registrationTimeoutSeconds", "heartbeatTimeoutSeconds", "cleanupTimeoutSeconds", "maximumInstanceLifetimeSeconds", "failureRetentionMinutes", "lastValidationStatus", "lastValidationMessage", "lastValidatedAt", "controlState", "controlTriggeredBy", "controlStartedAt", "createdByActorId", "createdAt", "updatedAt", "archivedAt", "rowVersion" ], "type": "object" }, "BuildArgSpec": { "properties": { "name": { "type": "string" }, "value": { "type": [ "string", "null" ] } }, "required": [ "name" ], "type": "object" }, "BuildLogEntry": { "properties": { "buildRunId": { "format": "uuid", "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "message": { "type": "string" }, "stream": { "type": "string" } }, "required": [ "id", "buildRunId", "createdAt", "stream", "message" ], "type": "object" }, "BuildMetadataPatch": { "additionalProperties": false, "properties": { "description": { "type": [ "string", "null" ] } }, "type": "object" }, "BuildPlatformSnapshot": { "properties": { "address": { "type": [ "string", "null" ] }, "buildAgentPoolId": { "format": "uuid", "type": [ "string", "null" ] }, "builderKind": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/BuildProjectBuilderKind" } ] }, "id": { "format": "uuid", "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] } }, "required": [ "id", "name", "address", "builderKind", "buildAgentPoolId" ], "type": "object" }, "BuildProjectActivitySnapshot": { "properties": { "branch": { "type": "string" }, "buildAgentPoolId": { "format": "uuid", "type": [ "string", "null" ] }, "buildSecrets": { "items": { "$ref": "#/components/schemas/BuildSecretActivitySnapshot" }, "type": "array" }, "builderKind": { "type": "string" }, "contextPath": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "dockerfilePath": { "type": "string" }, "enabled": { "type": "boolean" }, "gitRepositoryId": { "format": "uuid", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "imageRepository": { "type": "string" }, "name": { "type": "string" }, "platformId": { "format": "uuid", "type": [ "string", "null" ] }, "pushToRegistry": { "type": "boolean" }, "registryId": { "format": "uuid", "type": [ "string", "null" ] }, "retentionRunCount": { "format": "int32", "type": "integer" }, "tagTemplates": { "items": { "type": "string" }, "type": "array" }, "target": { "type": [ "string", "null" ] }, "timeoutSeconds": { "format": "int32", "type": "integer" }, "webhook": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/WebhookConfig" } ] } }, "required": [ "id", "name", "enabled", "gitRepositoryId", "branch", "contextPath", "dockerfilePath", "builderKind", "pushToRegistry", "imageRepository", "tagTemplates", "timeoutSeconds", "retentionRunCount", "buildSecrets" ], "type": "object" }, "BuildProjectBuilderKind": { "enum": [ "Platform", "BuildAgentPool" ], "type": "string" }, "BuildProjectInput": { "properties": { "branch": { "type": [ "string", "null" ] }, "buildAgentPoolId": { "format": "uuid", "type": [ "string", "null" ] }, "buildArgs": { "items": { "$ref": "#/components/schemas/BuildArgSpec" }, "type": [ "array", "null" ] }, "buildSecrets": { "items": { "$ref": "#/components/schemas/BuildSecretSpec" }, "type": [ "array", "null" ] }, "builderKind": { "$ref": "#/components/schemas/BuildProjectBuilderKind" }, "contextPath": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "dockerfilePath": { "type": [ "string", "null" ] }, "enabled": { "type": "boolean" }, "gitRepositoryId": { "format": "uuid", "type": "string" }, "imageRepository": { "type": "string" }, "name": { "type": "string" }, "platformId": { "format": "uuid", "type": [ "string", "null" ] }, "pushToRegistry": { "type": "boolean" }, "registryId": { "format": "uuid", "type": [ "string", "null" ] }, "retentionRunCount": { "format": "int32", "type": [ "integer", "null" ] }, "tagIds": { "items": { "format": "uuid", "type": "string" }, "type": "array" }, "tagTemplates": { "items": { "type": "string" }, "type": [ "array", "null" ] }, "target": { "type": [ "string", "null" ] }, "timeoutSeconds": { "format": "int32", "type": [ "integer", "null" ] }, "webhook": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/WebhookConfig" } ] } }, "required": [ "name", "enabled", "gitRepositoryId" ], "type": "object" }, "BuildProjectView": { "properties": { "archivedAt": { "format": "date-time", "type": [ "string", "null" ] }, "branch": { "type": "string" }, "buildAgentPoolId": { "format": "uuid", "type": [ "string", "null" ] }, "buildArgs": { "items": { "$ref": "#/components/schemas/BuildArgSpec" }, "type": "array" }, "buildSecrets": { "items": { "$ref": "#/components/schemas/BuildSecretSpec" }, "type": "array" }, "builderKind": { "$ref": "#/components/schemas/BuildProjectBuilderKind" }, "contextPath": { "type": "string" }, "controlStartedAt": { "format": "int64", "type": [ "integer", "null" ] }, "controlState": { "$ref": "#/components/schemas/ResourceControlState" }, "createdAt": { "format": "date-time", "type": "string" }, "createdByActorId": { "format": "uuid", "type": "string" }, "currentRunId": { "format": "uuid", "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "dockerfilePath": { "type": "string" }, "enabled": { "type": "boolean" }, "gitRepositoryId": { "format": "uuid", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "imageRepository": { "type": "string" }, "latestRun": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/BuildRunView" } ] }, "name": { "type": "string" }, "normalizedName": { "type": "string" }, "platformId": { "format": "uuid", "type": [ "string", "null" ] }, "pushToRegistry": { "type": "boolean" }, "registryId": { "format": "uuid", "type": [ "string", "null" ] }, "retentionRunCount": { "format": "int32", "type": "integer" }, "rowVersion": { "format": "int64", "type": "integer" }, "tagTemplates": { "items": { "type": "string" }, "type": "array" }, "tags": { "items": { "$ref": "#/components/schemas/resources.tags.TagSummary" }, "type": "array" }, "target": { "type": [ "string", "null" ] }, "timeoutSeconds": { "format": "int32", "type": "integer" }, "updatedAt": { "format": "date-time", "type": "string" }, "webhook": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/WebhookConfig" } ] } }, "required": [ "tags", "latestRun", "id", "name", "normalizedName", "description", "enabled", "gitRepositoryId", "branch", "contextPath", "dockerfilePath", "target", "buildArgs", "buildSecrets", "builderKind", "platformId", "buildAgentPoolId", "pushToRegistry", "imageRepository", "tagTemplates", "webhook", "timeoutSeconds", "retentionRunCount", "currentRunId", "controlState", "controlStartedAt", "createdByActorId", "createdAt", "updatedAt", "archivedAt", "rowVersion" ], "type": "object" }, "BuildRunStatus": { "enum": [ "Queued", "Preparing", "Running", "Succeeded", "Failed", "TimedOut", "Cancelled", "Rejected", "Interrupted" ], "type": "string" }, "BuildRunTrigger": { "enum": [ "Manual", "Automation", "Schedule", "Webhook", "Dependency" ], "type": "string" }, "BuildRunView": { "properties": { "branch": { "type": "string" }, "buildProjectId": { "format": "uuid", "type": "string" }, "completedAt": { "format": "date-time", "type": [ "string", "null" ] }, "contextPath": { "type": "string" }, "dockerfilePath": { "type": "string" }, "errorCode": { "type": [ "string", "null" ] }, "errorMessage": { "type": [ "string", "null" ] }, "exitCode": { "format": "int32", "type": [ "integer", "null" ] }, "gitRepositoryId": { "format": "uuid", "type": "string" }, "gitRepositoryNameSnapshot": { "type": "string" }, "id": { "format": "uuid", "type": "string" }, "imageDigest": { "type": [ "string", "null" ] }, "imageReferences": { "items": { "type": "string" }, "type": "array" }, "imageRepository": { "type": "string" }, "platformSnapshot": { "$ref": "#/components/schemas/BuildPlatformSnapshot" }, "projectNameSnapshot": { "type": "string" }, "queuedAt": { "format": "date-time", "type": "string" }, "registryHost": { "type": "string" }, "registryId": { "format": "uuid", "type": [ "string", "null" ] }, "resolvedCommitSha": { "type": [ "string", "null" ] }, "startedAt": { "format": "date-time", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/BuildRunStatus" }, "target": { "type": [ "string", "null" ] }, "timeoutSeconds": { "format": "int32", "type": "integer" }, "trigger": { "$ref": "#/components/schemas/BuildRunTrigger" }, "triggeredByActorId": { "format": "uuid", "type": "string" } }, "required": [ "id", "buildProjectId", "projectNameSnapshot", "gitRepositoryId", "gitRepositoryNameSnapshot", "platformSnapshot", "branch", "resolvedCommitSha", "contextPath", "dockerfilePath", "target", "registryHost", "imageRepository", "imageReferences", "trigger", "status", "imageDigest", "timeoutSeconds", "queuedAt", "startedAt", "completedAt", "exitCode", "errorCode", "errorMessage", "triggeredByActorId" ], "type": "object" }, "BuildSecretActivitySnapshot": { "properties": { "id": { "type": "string" }, "secretId": { "format": "uuid", "type": "string" } }, "required": [ "id", "secretId" ], "type": "object" }, "BuildSecretSpec": { "properties": { "id": { "type": "string" }, "secretId": { "format": "uuid", "type": "string" } }, "required": [ "id", "secretId" ], "type": "object" }, "Channels": { "properties": { "capabilities": { "$ref": "#/components/schemas/ResourceCapabilitiesView" }, "channels": { "items": { "$ref": "#/components/schemas/AlertChannelView" }, "type": "array" } }, "required": [ "capabilities", "channels" ], "type": "object" }, "ComposeProjectImportDraftView": { "properties": { "draft": { "$ref": "#/components/schemas/ComposeProjectStackDraftView" }, "importKind": { "$ref": "#/components/schemas/StackImportKind" }, "issues": { "items": { "$ref": "#/components/schemas/StackAdoptionIssue" }, "type": "array" }, "runtimeFingerprint": { "type": "string" }, "source": { "$ref": "#/components/schemas/ComposeProjectImportSourceView" } }, "required": [ "importKind", "source", "draft", "issues", "runtimeFingerprint" ], "type": "object" }, "ComposeProjectImportSourceView": { "properties": { "containerIds": { "items": { "type": "string" }, "type": "array" }, "containerNames": { "items": { "type": "string" }, "type": "array" }, "platformId": { "format": "uuid", "type": "string" }, "platformName": { "type": "string" }, "projectName": { "type": "string" }, "services": { "items": { "$ref": "#/components/schemas/ComposeProjectRuntimeService" }, "type": "array" } }, "required": [ "platformId", "platformName", "projectName", "containerIds", "containerNames", "services" ], "type": "object" }, "ComposeProjectImportValidation": { "properties": { "canImportSensitiveEnvironmentValues": { "type": "boolean" }, "importableSensitiveEnvironmentNames": { "items": { "type": "string" }, "type": "array" }, "issues": { "items": { "$ref": "#/components/schemas/StackAdoptionIssue" }, "type": "array" }, "previewFingerprint": { "type": "string" }, "services": { "items": { "$ref": "#/components/schemas/ComposeProjectServiceComparison" }, "type": "array" } }, "required": [ "services", "issues", "previewFingerprint", "importableSensitiveEnvironmentNames", "canImportSensitiveEnvironmentValues" ], "type": "object" }, "ComposeProjectRuntimeService": { "properties": { "containerCount": { "minimum": 0, "type": "integer" }, "image": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "states": { "items": { "type": "string" }, "type": "array" } }, "required": [ "name", "image", "containerCount", "states" ], "type": "object" }, "ComposeProjectServiceComparison": { "properties": { "definedInSource": { "type": "boolean" }, "name": { "type": "string" }, "runtimeContainerCount": { "minimum": 0, "type": "integer" }, "runtimeImage": { "type": [ "string", "null" ] }, "sourceImage": { "type": [ "string", "null" ] } }, "required": [ "name", "runtimeContainerCount", "runtimeImage", "definedInSource", "sourceImage" ], "type": "object" }, "ComposeProjectStackDraftView": { "properties": { "description": { "type": [ "string", "null" ] }, "driftPolicy": { "$ref": "#/components/schemas/StackDriftPolicy" }, "name": { "type": "string" }, "platformId": { "format": "uuid", "type": "string" }, "tagIds": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "required": [ "name", "platformId", "description", "driftPolicy", "tagIds" ], "type": "object" }, "ConfigContentView": { "properties": { "content": { "type": "string" } }, "required": [ "content" ], "type": "object" }, "ContainerAdoptionDraft": { "properties": { "canImportSensitiveEnvironmentValues": { "type": "boolean" }, "draft": { "$ref": "#/components/schemas/AdoptionDeploymentDraft" }, "issues": { "items": { "$ref": "#/components/schemas/AdoptionIssue" }, "type": "array" }, "previewFingerprint": { "type": "string" }, "source": { "$ref": "#/components/schemas/AdoptionSource" } }, "required": [ "source", "draft", "issues", "previewFingerprint", "canImportSensitiveEnvironmentValues" ], "type": "object" }, "ContainerDeploymentUpdateState": { "properties": { "lastCheckedAt": { "format": "date-time", "type": "string" }, "status": { "$ref": "#/components/schemas/AutoUpdateStatus" } }, "required": [ "lastCheckedAt", "status" ], "type": "object" }, "ContainerDeploymentView": { "description": "The container contract embeds a summary, never Deployment configuration or\nresource bindings. These are read-model fields, not a cross-feature entity.", "properties": { "autoUpdateState": { "$ref": "#/components/schemas/ContainerDeploymentUpdateState" }, "controlState": { "$ref": "#/components/schemas/ResourceControlState" }, "createdAt": { "format": "date-time", "type": "string" }, "createdByActorId": { "format": "uuid", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "platformId": { "format": "uuid", "type": "string" }, "platformStatus": { "$ref": "#/components/schemas/PlatformStatus" }, "status": { "$ref": "#/components/schemas/DeploymentStatus" } }, "required": [ "id", "name", "platformId", "status", "createdAt", "createdByActorId", "controlState", "platformStatus", "autoUpdateState" ], "type": "object" }, "ContainerHistory": { "properties": { "containerId": { "type": "string" }, "containerName": { "type": "string" }, "stats": { "items": { "$ref": "#/components/schemas/ContainerStatView" }, "type": "array" } }, "required": [ "containerId", "containerName", "stats" ], "type": "object" }, "ContainerInspectionView": { "additionalProperties": {}, "properties": { "appArmorProfile": { "type": [ "string", "null" ] }, "args": { "items": { "type": "string" }, "type": "array" }, "config": { "additionalProperties": {}, "propertyNames": { "type": "string" }, "type": [ "object", "null" ] }, "created": { "type": "string" }, "driver": { "type": [ "string", "null" ] }, "execIDs": { "items": { "type": "string" }, "type": "array" }, "graphDriver": { "additionalProperties": {}, "propertyNames": { "type": "string" }, "type": [ "object", "null" ] }, "hostConfig": { "additionalProperties": {}, "propertyNames": { "type": "string" }, "type": [ "object", "null" ] }, "hostnamePath": { "type": [ "string", "null" ] }, "hostsPath": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "image": { "type": [ "string", "null" ] }, "logPath": { "type": [ "string", "null" ] }, "mountLabel": { "type": [ "string", "null" ] }, "mounts": { "items": { "additionalProperties": {}, "propertyNames": { "type": "string" }, "type": "object" }, "type": "array" }, "name": { "type": [ "string", "null" ] }, "networkSettings": { "additionalProperties": {}, "propertyNames": { "type": "string" }, "type": [ "object", "null" ] }, "path": { "type": [ "string", "null" ] }, "platform": { "type": [ "string", "null" ] }, "processLabel": { "type": [ "string", "null" ] }, "resolvConfPath": { "type": [ "string", "null" ] }, "restartCount": { "format": "int64", "type": [ "integer", "null" ] }, "sizeRootFs": { "format": "int64", "type": [ "integer", "null" ] }, "sizeRw": { "format": "int64", "type": [ "integer", "null" ] }, "state": { "additionalProperties": {}, "propertyNames": { "type": "string" }, "type": [ "object", "null" ] } }, "required": [ "created", "id" ], "type": "object" }, "ContainerRestartPolicy": { "enum": [ "No", "Always", "OnFailure", "UnlessStopped" ], "type": "string" }, "ContainerRuntimeListView": { "properties": { "containers": { "items": { "$ref": "#/components/schemas/ContainerRuntimeView" }, "type": "array" } }, "required": [ "containers" ], "type": "object" }, "ContainerRuntimeView": { "properties": { "capabilities": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PlatformCapabilitiesView" } ] }, "containerStat": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ContainerStatView" } ] }, "controlState": { "$ref": "#/components/schemas/ResourceControlState" }, "created": { "format": "int64", "type": "integer" }, "deploymentId": { "format": "uuid", "type": [ "string", "null" ] }, "dockerNodeId": { "type": [ "string", "null" ] }, "hasCitadelOwnershipLabels": { "type": "boolean" }, "id": { "description": "Docker container ID; the statistics containerId is Citadel's database UUID.", "type": "string" }, "image": { "type": "string" }, "imageId": { "type": "string" }, "isSwarmTask": { "type": "boolean" }, "isSystem": { "type": "boolean" }, "name": { "type": "string" }, "platformId": { "format": "uuid", "type": "string" }, "ports": { "additionalProperties": { "items": { "$ref": "#/components/schemas/HostPortBinding" }, "type": [ "array", "null" ] }, "propertyNames": { "type": "string" }, "type": [ "object", "null" ] }, "stack": { "type": [ "string", "null" ] }, "stackId": { "format": "uuid", "type": [ "string", "null" ] }, "state": { "$ref": "#/components/schemas/ContainerStateStatus" }, "systemRole": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ContainerSystemRole" } ] } }, "required": [ "id", "name", "platformId", "image", "imageId", "state", "controlState", "created", "stack", "ports", "containerStat", "isSystem", "systemRole", "hasCitadelOwnershipLabels", "isSwarmTask", "dockerNodeId", "deploymentId", "stackId", "capabilities" ], "type": "object" }, "ContainerStatSnapshot": { "properties": { "containerId": { "format": "uuid", "type": "string" }, "cpuUsage": { "format": "double", "type": "number" }, "created": { "format": "int64", "type": "integer" }, "memoryActive": { "format": "double", "type": "number" }, "memoryCache": { "format": "double", "type": "number" }, "memoryLimit": { "format": "double", "type": "number" }, "rxBytes": { "format": "double", "type": "number" }, "txBytes": { "format": "double", "type": "number" } }, "required": [ "containerId", "memoryActive", "memoryCache", "cpuUsage", "memoryLimit", "rxBytes", "txBytes", "created" ], "type": "object" }, "ContainerStatView": { "properties": { "containerId": { "format": "uuid", "type": "string" }, "cpuUsage": { "format": "double", "type": "number" }, "created": { "format": "int64", "type": "integer" }, "memoryActive": { "format": "double", "type": "number" }, "memoryCache": { "format": "double", "type": "number" }, "memoryLimit": { "format": "double", "type": "number" }, "rxBytes": { "format": "double", "type": "number" }, "txBytes": { "format": "double", "type": "number" } }, "required": [ "containerId", "memoryActive", "memoryCache", "cpuUsage", "memoryLimit", "rxBytes", "txBytes", "created" ], "type": "object" }, "ContainerStateStatus": { "enum": [ "Unknown", "Created", "Running", "Paused", "Restarting", "Exited", "Removing", "Dead", "Offline" ], "type": "string" }, "ContainerSummaryView": { "properties": { "capabilities": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PlatformCapabilitiesView" } ] }, "containerId": { "type": "string" }, "deploymentView": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ContainerDeploymentView" } ] }, "finishedAt": { "type": "string" }, "imageView": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ImageView" } ] }, "name": { "type": "string" }, "networks": { "additionalProperties": { "type": "string" }, "propertyNames": { "type": "string" }, "type": "object" }, "platformId": { "format": "uuid", "type": "string" }, "platformName": { "type": "string" }, "ports": { "additionalProperties": { "items": { "$ref": "#/components/schemas/HostPortBinding" }, "type": [ "array", "null" ] }, "propertyNames": { "type": "string" }, "type": "object" }, "startedAt": { "type": "string" }, "state": { "$ref": "#/components/schemas/ContainerStateStatus" }, "volumes": { "items": { "type": "string" }, "type": "array" } }, "required": [ "name", "containerId", "platformId", "platformName", "startedAt", "finishedAt", "volumes", "networks", "ports", "state", "imageView", "deploymentView", "capabilities" ], "type": "object" }, "ContainerSystemRole": { "enum": [ "Core", "Database", "Agent", "EdgeAgent" ], "type": "string" }, "ContainerView": { "properties": { "capabilities": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PlatformCapabilitiesView" } ] }, "containerId": { "type": "string" }, "controlState": { "$ref": "#/components/schemas/ResourceControlState" }, "created": { "format": "int64", "type": "integer" }, "deploymentId": { "format": "uuid", "type": [ "string", "null" ] }, "deploymentView": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ContainerDeploymentView" } ] }, "dockerImageId": { "type": "string" }, "dockerNodeId": { "type": [ "string", "null" ] }, "hasCitadelOwnershipLabels": { "type": "boolean" }, "id": { "format": "uuid", "type": "string" }, "imageView": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ImageView" } ] }, "isSwarmTask": { "type": "boolean" }, "isSystem": { "type": "boolean" }, "lastStats": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ContainerStatView" } ] }, "name": { "type": "string" }, "nodeHostname": { "type": [ "string", "null" ] }, "platformId": { "format": "uuid", "type": "string" }, "ports": { "additionalProperties": { "items": { "$ref": "#/components/schemas/HostPortBinding" }, "type": "array" }, "propertyNames": { "type": "string" }, "type": "object" }, "projectionObservedAt": { "format": "int64", "type": [ "integer", "null" ] }, "projectionStaleReason": { "type": [ "string", "null" ] }, "projectionStaleSince": { "format": "int64", "type": [ "integer", "null" ] }, "stack": { "type": [ "string", "null" ] }, "stackId": { "format": "uuid", "type": [ "string", "null" ] }, "state": { "$ref": "#/components/schemas/ContainerStateStatus" }, "systemRole": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ContainerSystemRole" } ] }, "updated": { "format": "int64", "type": "integer" } }, "required": [ "id", "platformId", "containerId", "name", "dockerImageId", "created", "state", "controlState", "updated", "stack", "isSystem", "systemRole", "hasCitadelOwnershipLabels", "isSwarmTask", "dockerNodeId", "nodeHostname", "projectionObservedAt", "projectionStaleSince", "projectionStaleReason", "lastStats", "ports", "deploymentId", "stackId", "capabilities" ], "type": "object" }, "ContainersResponse": { "properties": { "capabilities": { "$ref": "#/components/schemas/PlatformCapabilitiesView" }, "containers": { "items": { "$ref": "#/components/schemas/ContainerView" }, "type": "array" } }, "required": [ "containers", "capabilities" ], "type": "object" }, "Count": { "properties": { "count": { "format": "int64", "type": "integer" } }, "required": [ "count" ], "type": "object" }, "CpuArchitecture": { "enum": [ "Amd64", "Arm64" ], "type": "string" }, "CreateDeploymentInput": { "additionalProperties": false, "properties": { "description": { "type": [ "string", "null" ] }, "duplicateSource": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/DuplicateSourceInput" } ] }, "name": { "type": "string" }, "platformId": { "format": "uuid", "type": "string" }, "spec": { "$ref": "#/components/schemas/DeploymentSpec" }, "tagIds": { "items": { "format": "uuid", "type": "string" }, "type": [ "array", "null" ] } }, "required": [ "name", "platformId", "spec" ], "type": "object" }, "CreateDeploymentInputView": { "properties": { "description": { "type": [ "string", "null" ] }, "duplicateSource": { "$ref": "#/components/schemas/DuplicateSourceInput" }, "name": { "type": "string" }, "platformId": { "format": "uuid", "type": "string" }, "spec": { "$ref": "#/components/schemas/DeploymentSpec" }, "tagIds": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "required": [ "name", "platformId", "spec", "tagIds", "duplicateSource" ], "type": "object" }, "CreateNetworkInput": { "allOf": [ { "$ref": "#/components/schemas/CreateRuntimeNetwork" }, { "properties": { "platformId": { "format": "uuid", "type": "string" } }, "required": [ "platformId" ], "type": "object" } ] }, "CreatePlatformInput": { "additionalProperties": false, "properties": { "address": { "type": [ "string", "null" ] }, "connectorType": { "$ref": "#/components/schemas/PlatformConnectorType" }, "description": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "pruneHistoricalSwarmTaskContainers": { "type": "boolean" }, "tagIds": { "items": { "format": "uuid", "type": "string" }, "type": "array" }, "type": { "$ref": "#/components/schemas/PlatformType" } }, "required": [ "name" ], "type": "object" }, "CreateRuntimeNetwork": { "properties": { "attachable": { "type": [ "boolean", "null" ] }, "configFrom": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/RuntimeConfigFrom" } ] }, "configOnly": { "type": [ "boolean", "null" ] }, "driver": { "type": "string" }, "enableIPv4": { "type": [ "boolean", "null" ] }, "enableIPv6": { "type": [ "boolean", "null" ] }, "ingress": { "type": [ "boolean", "null" ] }, "internal": { "type": [ "boolean", "null" ] }, "ipam": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/RuntimeIpam" } ] }, "labels": { "additionalProperties": { "type": "string" }, "propertyNames": { "type": "string" }, "type": "object" }, "name": { "type": "string" }, "options": { "additionalProperties": { "type": "string" }, "propertyNames": { "type": "string" }, "type": "object" }, "scope": { "type": "string" } }, "required": [ "name", "driver", "scope" ], "type": "object" }, "CreateRuntimeVolume": { "properties": { "driver": { "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, "propertyNames": { "type": "string" }, "type": "object" }, "name": { "type": "string" }, "options": { "additionalProperties": { "type": "string" }, "propertyNames": { "type": "string" }, "type": "object" } }, "required": [ "name", "driver" ], "type": "object" }, "CreateStackInput": { "additionalProperties": false, "properties": { "description": { "type": [ "string", "null" ] }, "driftPolicy": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/StackDriftPolicy" } ] }, "duplicateSource": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/DuplicateSourceInput" } ] }, "name": { "type": "string" }, "platformId": { "format": "uuid", "type": "string" }, "spec": { "$ref": "#/components/schemas/StackSpec" }, "stackSource": { "$ref": "#/components/schemas/StackSource" }, "tagIds": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "required": [ "name", "platformId", "stackSource", "spec" ], "type": "object" }, "CreateSwarmMaterialInput": { "properties": { "data": { "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, "propertyNames": { "type": "string" }, "type": "object" }, "name": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "CreateSwarmServiceInput": { "additionalProperties": false, "properties": { "description": { "type": [ "string", "null" ] }, "duplicateSource": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/DuplicateSourceInput" } ] }, "name": { "type": "string" }, "platformId": { "format": "uuid", "type": "string" }, "spec": { "$ref": "#/components/schemas/SwarmServiceSpec" }, "tagIds": { "items": { "format": "uuid", "type": "string" }, "type": [ "array", "null" ] } }, "required": [ "name", "platformId", "spec" ], "type": "object" }, "CreateVolumeInput": { "allOf": [ { "$ref": "#/components/schemas/CreateRuntimeVolume" }, { "properties": { "platformId": { "format": "uuid", "type": "string" } }, "required": [ "platformId" ], "type": "object" } ] }, "CreatedNetworkView": { "properties": { "id": { "type": "string" } }, "required": [ "id" ], "type": "object" }, "DayOfWeek": { "enum": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ], "type": "string" }, "DeleteContainerOptions": { "properties": { "force": { "type": "boolean" }, "link": { "type": "boolean" }, "v": { "type": "boolean" } }, "type": "object" }, "DeleteImageView": { "properties": { "result": { "additionalProperties": { "type": "string" }, "propertyNames": { "type": "string" }, "type": "object" } }, "required": [ "result" ], "type": "object" }, "DeleteImagesInput": { "properties": { "force": { "type": "boolean" }, "ids": { "items": { "type": "string" }, "type": "array" }, "noPrune": { "type": "boolean" }, "platformId": { "format": "uuid", "type": "string" } }, "required": [ "platformId", "ids" ], "type": "object" }, "DeleteImagesView": { "properties": { "items": { "items": { "$ref": "#/components/schemas/DeleteImageView" }, "type": "array" } }, "required": [ "items" ], "type": "object" }, "DeleteInput": { "allOf": [ { "$ref": "#/components/schemas/DeleteContainerOptions" }, { "properties": { "containerIds": { "items": { "type": "string" }, "type": "array" } }, "required": [ "containerIds" ], "type": "object" } ] }, "DeleteNetworksInput": { "properties": { "ids": { "items": { "type": "string" }, "type": "array" }, "platformId": { "format": "uuid", "type": "string" } }, "required": [ "platformId", "ids" ], "type": "object" }, "DeletePlatformsInput": { "additionalProperties": false, "properties": { "ids": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "required": [ "ids" ], "type": "object" }, "DeleteResourcesInput": { "properties": { "ids": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "required": [ "ids" ], "type": "object" }, "DeleteSwarmResourcesInput": { "properties": { "ids": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "DeleteVolumesInput": { "properties": { "force": { "type": [ "boolean", "null" ] }, "names": { "items": { "type": "string" }, "type": "array" }, "platformId": { "format": "uuid", "type": "string" } }, "required": [ "platformId", "names" ], "type": "object" }, "DeploymentActivitySnapshot": { "properties": { "description": { "type": [ "string", "null" ] }, "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "platformId": { "format": "uuid", "type": "string" }, "spec": {} }, "required": [ "id", "name", "platformId", "spec" ], "type": "object" }, "DeploymentApplyError": { "properties": { "code": { "format": "int64", "type": "integer" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" }, "DeploymentCapabilities": { "properties": { "canApply": { "type": "boolean" }, "canExecute": { "type": "boolean" }, "canInspect": { "type": "boolean" }, "canOpenTerminal": { "type": "boolean" }, "canPull": { "type": "boolean" }, "canRead": { "type": "boolean" }, "canViewLogs": { "type": "boolean" }, "canViewResourceBindings": { "type": "boolean" }, "canWrite": { "type": "boolean" } }, "required": [ "canViewLogs", "canInspect", "canOpenTerminal", "canPull", "canApply", "canViewResourceBindings", "canRead", "canWrite", "canExecute" ], "type": "object" }, "DeploymentConfigView": { "properties": { "description": { "type": [ "string", "null" ] }, "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "platformId": { "format": "uuid", "type": "string" }, "spec": { "$ref": "#/components/schemas/DeploymentSpec" } }, "required": [ "id", "name", "platformId", "spec" ], "type": "object" }, "DeploymentDuplicateDraftView": { "properties": { "draft": { "$ref": "#/components/schemas/CreateDeploymentInputView" }, "warnings": { "items": { "$ref": "#/components/schemas/DuplicateWarning" }, "type": "array" } }, "required": [ "draft", "warnings" ], "type": "object" }, "DeploymentImageInfo": { "oneOf": [ { "properties": { "$type": { "enum": [ "Local" ], "type": "string" }, "imageId": { "type": "string" } }, "required": [ "imageId", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "External" ], "type": "string" }, "imageTag": { "type": "string" }, "registryId": { "format": "uuid", "type": "string" }, "resolvedDigest": { "type": [ "string", "null" ] } }, "required": [ "registryId", "imageTag", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "Build" ], "type": "string" }, "appliedAt": { "format": "date-time", "type": [ "string", "null" ] }, "appliedBuildRunId": { "format": "uuid", "type": [ "string", "null" ] }, "appliedDigest": { "type": [ "string", "null" ] }, "appliedImageReference": { "type": [ "string", "null" ] }, "buildProjectId": { "format": "uuid", "type": "string" }, "redeployOnBuild": { "type": "boolean" }, "resolvedBuildRunId": { "format": "uuid", "type": [ "string", "null" ] }, "resolvedDigest": { "type": [ "string", "null" ] }, "resolvedImageReference": { "type": [ "string", "null" ] } }, "required": [ "buildProjectId", "$type" ], "type": "object" } ] }, "DeploymentResultActivitySnapshot": { "properties": { "containerIds": { "items": { "type": "string" }, "type": [ "array", "null" ] }, "message": { "type": [ "string", "null" ] }, "resourceBindings": {} }, "type": "object" }, "DeploymentSpec": { "properties": { "command": { "items": { "type": "string" }, "type": [ "array", "null" ] }, "environmentVariables": { "items": { "type": "string" }, "type": [ "array", "null" ] }, "image": { "$ref": "#/components/schemas/DeploymentImageInfo" }, "labels": { "additionalProperties": { "type": "string" }, "propertyNames": { "type": "string" }, "type": [ "object", "null" ] }, "lifeCycleSpec": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/LifeCycleSpec" } ] }, "networks": { "items": { "type": "string" }, "type": [ "array", "null" ] }, "ports": { "items": { "type": "string" }, "type": [ "array", "null" ] }, "resourceSpec": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ResourceSpec" } ] }, "updateBehavior": { "default": "Disabled", "oneOf": [ { "$ref": "#/components/schemas/UpdateBehavior" } ] }, "volumes": { "items": { "type": "string" }, "type": [ "array", "null" ] } }, "required": [ "image" ], "type": "object" }, "DeploymentStatus": { "enum": [ "Unknown", "Created", "Pending", "Applying", "Healthy", "Degraded", "Failed", "Stopped" ], "type": "string" }, "DeploymentStreamItem": { "properties": { "error": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/DeploymentApplyError" } ] }, "errorMessage": { "type": [ "string", "null" ] }, "id": { "type": [ "string", "null" ] }, "progress": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/deployments.model.ImagePullProgress" } ] }, "progressMessage": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] }, "stream": { "type": [ "string", "null" ] } }, "type": "object" }, "DeploymentView": { "properties": { "autoUpdateState": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/AutoUpdateState" } ] }, "capabilities": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/DeploymentCapabilities" } ] }, "containerId": { "format": "uuid", "type": [ "string", "null" ] }, "controlState": { "$ref": "#/components/schemas/ResourceControlState" }, "createdAt": { "format": "date-time", "type": "string" }, "createdByActorId": { "format": "uuid", "type": "string" }, "description": { "type": [ "string", "null" ] }, "dockerContainerId": { "type": [ "string", "null" ] }, "dockerImageId": { "type": [ "string", "null" ] }, "id": { "format": "uuid", "type": "string" }, "imageId": { "format": "uuid", "type": [ "string", "null" ] }, "imageName": { "type": [ "string", "null" ] }, "latestActivityView": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/LatestActivityView" } ] }, "name": { "type": "string" }, "platformId": { "format": "uuid", "type": "string" }, "platformName": { "type": [ "string", "null" ] }, "platformStatus": { "$ref": "#/components/schemas/PlatformStatus" }, "spec": { "$ref": "#/components/schemas/DeploymentSpec" }, "status": { "$ref": "#/components/schemas/DeploymentStatus" }, "tags": { "items": { "$ref": "#/components/schemas/resources.tags.TagSummary" }, "type": "array" } }, "required": [ "id", "name", "platformId", "createdAt", "createdByActorId", "status", "controlState", "spec", "platformStatus", "tags" ], "type": "object" }, "DeploymentsView": { "properties": { "capabilities": { "$ref": "#/components/schemas/ResourceCapabilitiesView" }, "deployments": { "items": { "$ref": "#/components/schemas/DeploymentView" }, "type": "array" } }, "required": [ "deployments", "capabilities" ], "type": "object" }, "DockerHubRepositoryInfo": { "properties": { "isAutomated": { "type": "boolean" }, "isPrivate": { "type": "boolean" }, "isTrusted": { "type": "boolean" }, "lastUpdated": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] }, "namespace": { "type": [ "string", "null" ] }, "pullCount": { "format": "int64", "type": "integer" } }, "type": "object" }, "DockerHubTag": { "properties": { "fullSize": { "format": "int64", "type": [ "integer", "null" ] }, "id": { "format": "int64", "type": [ "integer", "null" ] }, "image": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/DockerHubTagImage" } ] }, "lastPulled": { "type": [ "string", "null" ] }, "lastUpdated": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/RegistryTagStatus" } }, "required": [ "status" ], "type": "object" }, "DockerHubTagImage": { "properties": { "architecture": { "type": [ "string", "null" ] }, "digest": { "type": [ "string", "null" ] }, "lastPulled": { "type": [ "string", "null" ] }, "os": { "type": [ "string", "null" ] }, "size": { "format": "int64", "type": [ "integer", "null" ] }, "status": { "$ref": "#/components/schemas/RegistryTagStatus" } }, "required": [ "status" ], "type": "object" }, "DockerPlatformDescriptor": { "properties": { "apiVersion": { "type": [ "string", "null" ] }, "architecture": { "type": [ "string", "null" ] }, "containerCount": { "format": "int64", "type": [ "integer", "null" ] }, "containersPaused": { "format": "int64", "type": [ "integer", "null" ] }, "containersRunning": { "format": "int64", "type": [ "integer", "null" ] }, "containersStopped": { "format": "int64", "type": [ "integer", "null" ] }, "daemonId": { "type": "string" }, "driver": { "type": [ "string", "null" ] }, "imageUsedBytes": { "format": "int64", "type": [ "integer", "null" ] }, "minimumApiVersion": { "type": [ "string", "null" ] }, "operatingSystem": { "type": [ "string", "null" ] }, "osType": { "type": [ "string", "null" ] }, "osVersion": { "type": [ "string", "null" ] }, "volumeUsedBytes": { "format": "int64", "type": [ "integer", "null" ] } }, "type": "object" }, "DockerSwarmPlatformDescriptor": { "allOf": [ { "$ref": "#/components/schemas/DockerPlatformDescriptor" }, { "properties": { "clusterCreatedAt": { "type": [ "string", "null" ] }, "clusterId": { "type": [ "string", "null" ] }, "controlAvailable": { "type": [ "boolean", "null" ] }, "error": { "type": [ "string", "null" ] }, "localNodeState": { "type": [ "string", "null" ] }, "managers": { "format": "int64", "type": [ "integer", "null" ] }, "nodeAddr": { "type": [ "string", "null" ] }, "nodeID": { "type": [ "string", "null" ] }, "nodes": { "format": "int64", "type": [ "integer", "null" ] }, "remoteManagers": { "items": { "$ref": "#/components/schemas/RuntimeSwarmPeer" }, "type": [ "array", "null" ] }, "runningTaskCount": { "format": "int64", "type": [ "integer", "null" ] }, "serviceCount": { "format": "int64", "type": [ "integer", "null" ] } }, "type": "object" } ] }, "DuplicateDraftWarning": { "properties": { "code": { "type": "string" }, "fieldPath": { "type": [ "string", "null" ] }, "message": { "type": "string" } }, "required": [ "code", "message", "fieldPath" ], "type": "object" }, "DuplicateSourceInput": { "properties": { "resourceId": { "format": "uuid", "type": "string" }, "resourceName": { "type": "string" }, "resourceType": { "$ref": "#/components/schemas/ActivityResourceType" } }, "required": [ "resourceType", "resourceId", "resourceName" ], "type": "object" }, "DuplicateWarning": { "properties": { "code": { "type": "string" }, "fieldPath": { "type": [ "string", "null" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" }, "EdgeEnrollmentView": { "properties": { "enrollmentId": { "format": "uuid", "type": "string" }, "expiresAtUtc": { "format": "date-time", "type": "string" }, "instructions": { "$ref": "#/components/schemas/EdgeInstructionsView" }, "platformId": { "format": "uuid", "type": "string" }, "token": { "type": "string" } }, "required": [ "enrollmentId", "platformId", "token", "expiresAtUtc", "instructions" ], "type": "object" }, "EdgeInstructionsView": { "properties": { "agentImage": { "type": "string" }, "coreUrl": { "type": "string" }, "dockerRunCommand": { "type": "string" }, "environment": { "additionalProperties": { "type": "string" }, "propertyNames": { "type": "string" }, "type": "object" } }, "required": [ "coreUrl", "environment", "agentImage", "dockerRunCommand" ], "type": "object" }, "EdgeStatusView": { "properties": { "agentFingerprint": { "type": [ "string", "null" ] }, "connectionStatus": { "type": "string" }, "enrollmentExpiresAtUtc": { "format": "date-time", "type": [ "string", "null" ] }, "lastConnectedAtUtc": { "format": "date-time", "type": [ "string", "null" ] }, "lastDisconnectedAtUtc": { "format": "date-time", "type": [ "string", "null" ] }, "lastHeartbeatAtUtc": { "format": "date-time", "type": [ "string", "null" ] }, "lastSeenHostname": { "type": [ "string", "null" ] }, "lastSeenVersion": { "type": [ "string", "null" ] }, "protocolVersion": { "format": "int32", "type": [ "integer", "null" ] }, "revokedAtUtc": { "format": "date-time", "type": [ "string", "null" ] } }, "required": [ "connectionStatus" ], "type": "object" }, "ExposedPortsView": { "properties": { "ports": { "items": { "type": "string" }, "type": "array" } }, "required": [ "ports" ], "type": "object" }, "ExternalRepository": { "description": "Repository summaries returned by the registry browser, never credentials.", "oneOf": [ { "properties": { "$type": { "enum": [ "DockerHub" ], "type": "string" }, "isPrivate": { "type": "boolean" }, "lastUpdated": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] }, "namespace": { "type": [ "string", "null" ] }, "pullCount": { "format": "int64", "type": "integer" } }, "required": [ "isPrivate", "pullCount", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "GitHub" ], "type": "string" }, "createdAt": { "type": [ "string", "null" ] }, "htmlUrl": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "updatedAt": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] } }, "required": [ "id", "$type" ], "type": "object" } ] }, "ExternalSecretInput": { "properties": { "externalKey": { "type": "string" }, "externalPath": { "type": "string" }, "externalVersion": { "format": "int32", "type": [ "integer", "null" ] }, "name": { "type": "string" }, "providerId": { "format": "uuid", "type": "string" } }, "required": [ "name", "providerId", "externalPath", "externalKey" ], "type": "object" }, "ExternalSecretPatch": { "properties": { "externalKey": { "type": [ "string", "null" ] }, "externalPath": { "type": [ "string", "null" ] }, "externalVersion": { "format": "int32", "type": [ "integer", "null" ] }, "name": { "type": [ "string", "null" ] }, "providerId": { "format": "uuid", "type": [ "string", "null" ] } }, "type": "object" }, "GitChangedPath": { "properties": { "path": { "type": "string" }, "previousPath": { "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/GitChangedPathStatus" } }, "required": [ "status", "path" ], "type": "object" }, "GitChangedPathStatus": { "enum": [ "Added", "Modified", "Deleted", "Renamed", "Copied", "TypeChanged" ], "type": "string" }, "GitCommitComparison": { "properties": { "baseCommitSha": { "type": "string" }, "files": { "items": { "$ref": "#/components/schemas/GitChangedPath" }, "type": "array" }, "headCommitSha": { "type": "string" }, "isTruncated": { "type": "boolean" }, "repositoryId": { "format": "uuid", "type": "string" } }, "required": [ "repositoryId", "baseCommitSha", "headCommitSha", "files", "isTruncated" ], "type": "object" }, "GitComposeDiscovery": { "properties": { "branch": { "type": "string" }, "projects": { "items": { "$ref": "#/components/schemas/GitComposeProjectCandidate" }, "type": "array" }, "repositoryId": { "format": "uuid", "type": "string" }, "resolvedCommitSha": { "type": "string" } }, "required": [ "repositoryId", "branch", "resolvedCommitSha", "projects" ], "type": "object" }, "GitComposeProjectCandidate": { "properties": { "composePaths": { "items": { "type": "string" }, "type": "array" }, "envFilePaths": { "items": { "type": "string" }, "type": "array" }, "suggestedWatchPaths": { "items": { "type": "string" }, "type": "array" }, "workingDirectory": { "type": "string" } }, "required": [ "workingDirectory", "composePaths", "envFilePaths", "suggestedWatchPaths" ], "type": "object" }, "GitDirectoryEntry": { "properties": { "mode": { "type": "string" }, "name": { "type": "string" }, "path": { "type": "string" }, "size": { "format": "int64", "minimum": 0, "type": [ "integer", "null" ] }, "targetCommitSha": { "type": [ "string", "null" ] }, "type": { "$ref": "#/components/schemas/GitEntryTypeView" } }, "required": [ "name", "path", "type", "mode" ], "type": "object" }, "GitDirectoryListing": { "properties": { "commitSha": { "type": "string" }, "entries": { "items": { "$ref": "#/components/schemas/GitDirectoryEntry" }, "type": "array" }, "isTruncated": { "type": "boolean" }, "path": { "type": "string" }, "providerRepositoryUrl": { "type": [ "string", "null" ] }, "repositoryId": { "format": "uuid", "type": "string" } }, "required": [ "repositoryId", "commitSha", "path", "entries", "isTruncated" ], "type": "object" }, "GitEntryTypeView": { "enum": [ "Directory", "File", "Symlink", "Submodule" ], "type": "string" }, "GitFileContent": { "properties": { "commitSha": { "type": "string" }, "content": { "type": [ "string", "null" ] }, "isBinary": { "type": "boolean" }, "isTruncated": { "type": "boolean" }, "path": { "type": "string" }, "previewUnavailableReason": { "type": [ "string", "null" ] }, "providerUrl": { "type": [ "string", "null" ] }, "repositoryId": { "format": "uuid", "type": "string" }, "size": { "format": "int64", "minimum": 0, "type": "integer" }, "type": { "$ref": "#/components/schemas/GitEntryTypeView" } }, "required": [ "repositoryId", "commitSha", "path", "type", "size", "isBinary", "isTruncated" ], "type": "object" }, "GitRepositoriesResponse": { "properties": { "capabilities": { "$ref": "#/components/schemas/ResourceCapabilitiesView" }, "gitRepositories": { "items": { "$ref": "#/components/schemas/AuthorizedGitRepositoryView" }, "type": "array" } }, "required": [ "gitRepositories", "capabilities" ], "type": "object" }, "GitRepositoryActivitySnapshot": { "properties": { "defaultBranch": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "gitAccountId": { "format": "uuid", "type": [ "string", "null" ] }, "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "onClone": {}, "onPull": {}, "resolvedCommitSha": { "type": [ "string", "null" ] }, "syncIntervalMinutes": { "format": "int32", "type": [ "integer", "null" ] }, "syncMode": { "type": "string" }, "url": { "type": "string" }, "webhook": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/WebhookConfig" } ] } }, "required": [ "id", "name", "url", "defaultBranch", "syncMode" ], "type": "object" }, "GitRepositoryBranchResponse": { "properties": { "branch": { "type": "string" }, "commitSha": { "type": "string" } }, "required": [ "branch", "commitSha" ], "type": "object" }, "GitRepositoryBranchesResponse": { "properties": { "branches": { "items": { "$ref": "#/components/schemas/GitRepositoryBranchResponse" }, "type": "array" } }, "required": [ "branches" ], "type": "object" }, "GitRepositoryConfigResponse": { "properties": { "defaultBranch": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "gitAccountId": { "format": "uuid", "type": [ "string", "null" ] }, "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "onClone": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/RepoCommand" } ] }, "onPull": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/RepoCommand" } ] }, "syncIntervalMinutes": { "format": "int32", "type": [ "integer", "null" ] }, "syncMode": { "$ref": "#/components/schemas/GitRepositorySyncMode" }, "tags": { "items": { "$ref": "#/components/schemas/resources.tags.TagSummary" }, "type": "array" }, "url": { "type": "string" }, "webhook": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/WebhookConfig" } ] } }, "required": [ "id", "name", "description", "url", "defaultBranch", "gitAccountId", "syncMode", "syncIntervalMinutes", "webhook", "onClone", "onPull", "tags" ], "type": "object" }, "GitRepositoryPatch": { "properties": { "defaultBranch": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "gitAccountId": { "format": "uuid", "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] }, "onClone": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/RepoCommand" } ] }, "onPull": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/RepoCommand" } ] }, "syncIntervalMinutes": { "format": "int32", "type": [ "integer", "null" ] }, "syncMode": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/GitRepositorySyncMode" } ] }, "tagIds": { "items": { "format": "uuid", "type": "string" }, "type": [ "array", "null" ] }, "url": { "type": [ "string", "null" ] }, "webhook": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/WebhookPatch" } ] } }, "type": "object" }, "GitRepositoryRefStatus": { "enum": [ "Pending", "Syncing", "Healthy", "Degraded" ], "type": "string" }, "GitRepositoryRefView": { "properties": { "branch": { "type": "string" }, "gitRepositoryId": { "format": "uuid", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "lastError": { "type": [ "string", "null" ] }, "lastSyncedAt": { "format": "date-time", "type": "string" }, "resolvedCommitSha": { "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/GitRepositoryRefStatus" } }, "required": [ "id", "gitRepositoryId", "branch", "resolvedCommitSha", "status", "lastError", "lastSyncedAt" ], "type": "object" }, "GitRepositoryRefsResponse": { "properties": { "refs": { "items": { "$ref": "#/components/schemas/GitRepositoryRefView" }, "type": "array" } }, "required": [ "refs" ], "type": "object" }, "GitRepositoryStatus": { "enum": [ "Unknown", "Pending", "Created", "Healthy", "Degraded" ], "type": "string" }, "GitRepositorySyncActivitySnapshot": { "properties": { "commitSha": { "type": [ "string", "null" ] }, "message": { "type": [ "string", "null" ] } }, "type": "object" }, "GitRepositorySyncMode": { "enum": [ "Manual", "PullInterval" ], "type": "string" }, "GitRepositoryView": { "properties": { "controlState": { "$ref": "#/components/schemas/ResourceControlState" }, "createdAt": { "format": "date-time", "type": "string" }, "createdByActorId": { "format": "uuid", "type": "string" }, "defaultBranch": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "gitAccountId": { "format": "uuid", "type": [ "string", "null" ] }, "id": { "format": "uuid", "type": "string" }, "latestActivityView": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/LatestActivityView" } ] }, "name": { "type": "string" }, "onClone": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/RepoCommand" } ] }, "onPull": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/RepoCommand" } ] }, "status": { "$ref": "#/components/schemas/GitRepositoryStatus" }, "syncIntervalMinutes": { "format": "int32", "type": [ "integer", "null" ] }, "syncMode": { "$ref": "#/components/schemas/GitRepositorySyncMode" }, "tags": { "items": { "$ref": "#/components/schemas/resources.tags.TagSummary" }, "type": "array" }, "url": { "type": "string" }, "webhook": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/WebhookConfig" } ] } }, "required": [ "id", "name", "description", "url", "defaultBranch", "gitAccountId", "syncMode", "syncIntervalMinutes", "webhook", "onClone", "onPull", "status", "createdAt", "createdByActorId", "controlState", "latestActivityView", "tags" ], "type": "object" }, "GithubContainerMetadata": { "properties": { "tags": { "items": { "type": "string" }, "type": [ "array", "null" ] } }, "type": "object" }, "GithubPackageMetadata": { "properties": { "container": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/GithubContainerMetadata" } ] } }, "type": "object" }, "GithubPackageVersion": { "properties": { "createdAt": { "type": [ "string", "null" ] }, "htmlUrl": { "type": [ "string", "null" ] }, "id": { "format": "int64", "type": "integer" }, "metadata": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/GithubPackageMetadata" } ] }, "name": { "type": "string" }, "packageHtmlUrl": { "type": [ "string", "null" ] }, "updatedAt": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] } }, "required": [ "id", "name" ], "type": "object" }, "GlobalBindingsResponse": { "allOf": [ { "$ref": "#/components/schemas/ResourceBindingsView" }, { "properties": { "capabilities": { "$ref": "#/components/schemas/ResourceCapabilitiesView" } }, "required": [ "capabilities" ], "type": "object" } ] }, "HealthResponse": { "properties": { "status": { "type": "string" } }, "required": [ "status" ], "type": "object" }, "History_ContainerStatSnapshot": { "properties": { "stats": { "items": { "properties": { "containerId": { "format": "uuid", "type": "string" }, "cpuUsage": { "format": "double", "type": "number" }, "created": { "format": "int64", "type": "integer" }, "memoryActive": { "format": "double", "type": "number" }, "memoryCache": { "format": "double", "type": "number" }, "memoryLimit": { "format": "double", "type": "number" }, "rxBytes": { "format": "double", "type": "number" }, "txBytes": { "format": "double", "type": "number" } }, "required": [ "containerId", "memoryActive", "memoryCache", "cpuUsage", "memoryLimit", "rxBytes", "txBytes", "created" ], "type": "object" }, "type": "array" } }, "required": [ "stats" ], "type": "object" }, "History_PlatformStatSnapshot": { "properties": { "stats": { "items": { "properties": { "cpuUsage": { "format": "double", "type": "number" }, "created": { "format": "int64", "type": "integer" }, "diskTotalBytes": { "format": "int64", "type": [ "integer", "null" ] }, "diskUsage": { "format": "double", "type": [ "number", "null" ] }, "diskUsedBytes": { "format": "int64", "type": [ "integer", "null" ] }, "memoryUsage": { "format": "double", "type": "number" }, "rxBytes": { "format": "double", "type": "number" }, "txBytes": { "format": "double", "type": "number" } }, "required": [ "created", "txBytes", "rxBytes", "cpuUsage", "memoryUsage", "diskUsedBytes", "diskTotalBytes", "diskUsage" ], "type": "object" }, "type": "array" } }, "required": [ "stats" ], "type": "object" }, "HostPortBinding": { "properties": { "hostIP": { "type": [ "string", "null" ] }, "hostPort": { "type": [ "string", "null" ] } }, "type": "object" }, "IdentityResourceAccessSnapshot": { "properties": { "permissionLevel": { "$ref": "#/components/schemas/PermissionLevel" }, "resourceId": { "format": "uuid", "type": "string" }, "resourceType": { "$ref": "#/components/schemas/ResourceType" }, "specificPermissions": { "format": "int32", "type": "integer" } }, "required": [ "resourceType", "resourceId", "permissionLevel", "specificPermissions" ], "type": "object" }, "Ids": { "properties": { "ids": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "required": [ "ids" ], "type": "object" }, "ImageCapabilitiesView": { "properties": { "canExecute": { "type": "boolean" }, "canInspect": { "type": "boolean" }, "canPull": { "type": "boolean" }, "canRead": { "type": "boolean" }, "canWrite": { "type": "boolean" } }, "required": [ "canRead", "canWrite", "canExecute", "canInspect", "canPull" ], "type": "object" }, "ImageContainer": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "networks": { "additionalProperties": { "type": "string" }, "propertyNames": { "type": "string" }, "type": "object" }, "ports": {}, "state": { "type": "string" }, "volumes": { "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "name", "state", "volumes", "networks", "ports" ], "type": "object" }, "ImageInspection": { "properties": { "architecture": { "type": "string" }, "cmd": { "items": { "type": "string" }, "type": "array" }, "containers": { "items": { "$ref": "#/components/schemas/ImageContainer" }, "type": "array" }, "created": { "type": "string" }, "dockerNodeId": { "type": [ "string", "null" ] }, "entryPoint": { "items": { "type": "string" }, "type": "array" }, "env": { "items": { "type": "string" }, "type": "array" }, "exposedPorts": { "items": { "type": "string" }, "type": "array" }, "id": { "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, "propertyNames": { "type": "string" }, "type": "object" }, "layers": { "items": { "$ref": "#/components/schemas/ImageLayer" }, "type": "array" }, "name": { "type": "string" }, "os": { "type": "string" }, "registry": {}, "repoTags": { "items": { "type": "string" }, "type": "array" }, "size": { "format": "int64", "type": "integer" }, "stopSignal": { "type": [ "string", "null" ] }, "tag": { "type": "string" }, "user": { "type": [ "string", "null" ] }, "volumes": { "items": { "type": "string" }, "type": "array" }, "workingDir": { "type": [ "string", "null" ] } }, "required": [ "id", "name", "tag", "size", "os", "created", "architecture", "entryPoint", "env", "cmd", "repoTags", "volumes", "exposedPorts", "layers", "labels", "containers" ], "type": "object" }, "ImageInspectionView": { "allOf": [ { "$ref": "#/components/schemas/ImageInspection" }, { "properties": { "capabilities": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ImageCapabilitiesView" } ] } }, "type": "object" } ] }, "ImageLayer": { "properties": { "comment": { "type": "string" }, "created": { "format": "int64", "type": "integer" }, "createdBy": { "type": "string" }, "id": { "type": "string" }, "size": { "format": "int64", "type": "integer" } }, "required": [ "id", "created", "createdBy", "size", "comment" ], "type": "object" }, "ImagePullError": { "properties": { "code": { "format": "int64", "type": [ "integer", "null" ] }, "message": { "type": [ "string", "null" ] } }, "type": "object" }, "ImageRegistryView": { "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "registryHost": { "type": "string" }, "type": { "$ref": "#/components/schemas/RegistryKind" } }, "required": [ "id", "name", "registryHost", "type" ], "type": "object" }, "ImageUpdateState": { "properties": { "currentDigest": { "type": "string" }, "imageName": { "type": "string" }, "lastCheckedAt": { "format": "date-time", "type": "string" }, "remoteDigest": { "type": [ "string", "null" ] }, "serviceName": { "type": "string" }, "updateAvailable": { "type": "boolean" } }, "required": [ "serviceName", "imageName", "currentDigest", "lastCheckedAt", "updateAvailable" ], "type": "object" }, "ImageView": { "properties": { "capabilities": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ImageCapabilitiesView" } ] }, "contentIdentity": { "type": [ "string", "null" ] }, "controlState": { "$ref": "#/components/schemas/ResourceControlState" }, "createdAt": { "format": "date-time", "type": "string" }, "dockerImageId": { "type": "string" }, "dockerNodeId": { "type": [ "string", "null" ] }, "id": { "format": "uuid", "type": "string" }, "isInUse": { "type": "boolean" }, "isStale": { "type": "boolean" }, "name": { "type": "string" }, "nodeHostname": { "type": [ "string", "null" ] }, "platformId": { "format": "uuid", "type": "string" }, "registry": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ImageRegistryView" } ] }, "registryId": { "format": "uuid", "type": [ "string", "null" ] }, "repoDigests": { "items": { "type": "string" }, "type": [ "array", "null" ] }, "size": { "format": "double", "type": "number" }, "staleReason": { "type": [ "string", "null" ] }, "tags": { "items": { "type": "string" }, "type": "array" }, "updatedAt": { "format": "date-time", "type": [ "string", "null" ] } }, "required": [ "id", "tags", "name", "dockerImageId", "size", "isInUse", "platformId", "createdAt", "controlState", "updatedAt", "registryId", "repoDigests", "contentIdentity", "dockerNodeId", "nodeHostname", "isStale", "staleReason", "capabilities" ], "type": "object" }, "ImagesResponse": { "properties": { "capabilities": { "$ref": "#/components/schemas/ImageCapabilitiesView" }, "images": { "items": { "$ref": "#/components/schemas/ImageView" }, "type": "array" } }, "required": [ "images", "capabilities" ], "type": "object" }, "ImportRequest": { "additionalProperties": false, "properties": { "description": { "type": [ "string", "null" ] }, "importKind": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/StackImportKind" } ] }, "importSensitiveEnvironmentAsSecrets": { "type": "boolean" }, "name": { "type": "string" }, "previewFingerprint": { "type": "string" }, "spec": { "$ref": "#/components/schemas/StackSpec" }, "stackSource": { "$ref": "#/components/schemas/StackSource" }, "tagIds": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "required": [ "name", "stackSource", "spec", "previewFingerprint" ], "type": "object" }, "InternalSecretInput": { "properties": { "name": { "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "KubernetesPlatformDescriptor": { "properties": { "apiServerUrl": { "type": [ "string", "null" ] }, "clusterName": { "type": [ "string", "null" ] }, "clusterVersion": { "type": [ "string", "null" ] }, "namespace": { "type": [ "string", "null" ] } }, "type": "object" }, "LatestActivityView": { "description": "Activity summary embedded in resource HTTP and realtime responses.", "properties": { "createdAt": { "format": "date-time", "type": "string" }, "eventType": { "$ref": "#/components/schemas/ActivityEventType" }, "id": { "format": "uuid", "type": "string" }, "info": { "$ref": "#/components/schemas/PublicActivityEventInfo" }, "resourceType": { "$ref": "#/components/schemas/ActivityResourceType" }, "status": { "$ref": "#/components/schemas/ActivityStatus" } }, "required": [ "id", "resourceType", "eventType", "status", "info", "createdAt" ], "type": "object" }, "LicenseActivitySnapshot": { "properties": { "customerId": { "type": [ "string", "null" ] }, "customerName": { "type": [ "string", "null" ] }, "effectiveCapabilities": { "items": { "$ref": "#/components/schemas/LicenseCapability" }, "type": "array" }, "effectiveEdition": { "type": "string" }, "expiresAt": { "format": "date-time", "type": [ "string", "null" ] }, "fingerprint": { "type": [ "string", "null" ] }, "graceUntil": { "format": "date-time", "type": [ "string", "null" ] }, "licenseId": { "type": [ "string", "null" ] }, "licensedEdition": { "type": [ "string", "null" ] }, "replacedLicenseId": { "type": [ "string", "null" ] }, "schema": { "format": "int32", "minimum": 0, "type": [ "integer", "null" ] }, "status": { "$ref": "#/components/schemas/LicenseStatus" } }, "required": [ "effectiveEdition", "effectiveCapabilities", "status" ], "type": "object" }, "LicenseCapability": { "enum": [ "CustomAccessControl", "AutomatedOperations", "AdvancedAlerting", "OperationalGuardrails", "ElasticBuildExecution" ], "type": "string" }, "LicenseStatus": { "enum": [ "Community", "Valid", "GracePeriod", "NotYetValid", "Expired", "Invalid", "InstanceMismatch", "UnsupportedSchema", "UnknownSigningKey" ], "type": "string" }, "LifeCycleSpec": { "properties": { "restartPolicy": { "$ref": "#/components/schemas/ContainerRestartPolicy" }, "stopSignal": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/StopSignal" } ] }, "stopTimeout": { "format": "int32", "type": [ "integer", "null" ] } }, "type": "object" }, "LogSnapshot": { "properties": { "lines": { "items": { "type": "string" }, "type": "array" }, "truncated": { "type": "boolean" } }, "required": [ "lines", "truncated" ], "type": "object" }, "ManagedSwarmServiceView": { "properties": { "appliedImageDigest": { "type": [ "string", "null" ] }, "autoUpdateState": { "$ref": "#/components/schemas/AutoUpdateState" }, "capabilities": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/SwarmServiceCapabilities" } ] }, "controlState": { "$ref": "#/components/schemas/ResourceControlState" }, "createdAt": { "format": "date-time", "type": "string" }, "currentOperation": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/SwarmServiceOperationView" } ] }, "description": { "type": [ "string", "null" ] }, "desiredTaskCount": { "format": "int32", "type": [ "integer", "null" ] }, "dockerName": { "type": "string" }, "dockerServiceId": { "type": [ "string", "null" ] }, "hasPendingDesiredChanges": { "type": "boolean" }, "hasRuntimeDrift": { "type": "boolean" }, "health": { "$ref": "#/components/schemas/SwarmServiceHealth" }, "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "platformId": { "format": "uuid", "type": "string" }, "platformName": { "type": [ "string", "null" ] }, "platformStatus": { "$ref": "#/components/schemas/PlatformStatus" }, "rowVersion": { "format": "int64", "type": "integer" }, "runningTaskCount": { "format": "int32", "type": [ "integer", "null" ] }, "spec": { "$ref": "#/components/schemas/SwarmServiceSpec" }, "synchronizationState": { "$ref": "#/components/schemas/SwarmServiceSynchronizationState" }, "tags": { "items": { "$ref": "#/components/schemas/resources.tags.TagSummary" }, "type": "array" }, "tasks": { "items": {}, "type": [ "array", "null" ] }, "updateMessage": { "type": [ "string", "null" ] }, "updateState": { "type": [ "string", "null" ] }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "platformId", "name", "description", "dockerName", "dockerServiceId", "spec", "health", "synchronizationState", "controlState", "autoUpdateState", "appliedImageDigest", "hasPendingDesiredChanges", "hasRuntimeDrift", "rowVersion", "createdAt", "updatedAt", "platformName", "platformStatus", "runningTaskCount", "desiredTaskCount", "updateState", "updateMessage", "currentOperation", "tags", "tasks", "capabilities" ], "type": "object" }, "ManagedSwarmServicesView": { "properties": { "capabilities": { "$ref": "#/components/schemas/ResourceCapabilitiesView" }, "swarmServices": { "items": { "$ref": "#/components/schemas/ManagedSwarmServiceView" }, "type": "array" } }, "required": [ "swarmServices", "capabilities" ], "type": "object" }, "MountKind": { "enum": [ "Volume", "Bind", "Tmpfs" ], "type": "string" }, "NetworkAttachmentView": { "properties": { "endpointId": { "type": [ "string", "null" ] }, "ipV4Address": { "type": [ "string", "null" ] }, "ipv6Address": { "type": [ "string", "null" ] }, "macAddress": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] } }, "required": [ "name", "endpointId", "macAddress", "ipV4Address", "ipv6Address" ], "type": "object" }, "NetworkCapabilitiesView": { "properties": { "canExecute": { "type": "boolean" }, "canInspect": { "type": "boolean" }, "canRead": { "type": "boolean" }, "canWrite": { "type": "boolean" } }, "required": [ "canRead", "canWrite", "canExecute", "canInspect" ], "type": "object" }, "NetworkIpamView": { "properties": { "config": { "items": { "$ref": "#/components/schemas/RuntimeIpamConfig" }, "type": "array" }, "driver": { "type": [ "string", "null" ] }, "options": { "additionalProperties": { "type": "string" }, "propertyNames": { "type": "string" }, "type": "object" } }, "required": [ "driver", "config", "options" ], "type": "object" }, "NetworkPeerView": { "properties": { "ip": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] } }, "required": [ "name", "ip" ], "type": "object" }, "NetworkView": { "properties": { "attachable": { "type": "boolean" }, "capabilities": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/NetworkCapabilitiesView" } ] }, "configFrom": { "type": [ "string", "null" ] }, "configOnly": { "type": "boolean" }, "containers": { "additionalProperties": { "$ref": "#/components/schemas/NetworkAttachmentView" }, "propertyNames": { "type": "string" }, "type": "object" }, "created": { "type": "string" }, "dockerNodeId": { "type": [ "string", "null" ] }, "driver": { "type": "string" }, "enableIPv4": { "type": "boolean" }, "enableIPv6": { "type": "boolean" }, "id": { "type": "string" }, "inUse": { "type": "boolean" }, "ingress": { "type": "boolean" }, "internal": { "type": "boolean" }, "ipam": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/NetworkIpamView" } ] }, "isStale": { "type": "boolean" }, "isSystem": { "type": "boolean" }, "labels": { "additionalProperties": { "type": "string" }, "propertyNames": { "type": "string" }, "type": "object" }, "name": { "type": "string" }, "nodeHostname": { "type": [ "string", "null" ] }, "options": { "additionalProperties": { "type": "string" }, "propertyNames": { "type": "string" }, "type": "object" }, "peers": { "items": { "$ref": "#/components/schemas/NetworkPeerView" }, "type": "array" }, "scope": { "type": "string" }, "staleReason": { "type": [ "string", "null" ] } }, "required": [ "name", "id", "created", "driver", "scope", "enableIPv4", "enableIPv6", "internal", "attachable", "ingress", "configOnly", "inUse", "configFrom", "ipam", "options", "labels", "containers", "peers", "isSystem", "dockerNodeId", "nodeHostname", "isStale", "staleReason", "capabilities" ], "type": "object" }, "NetworksResponse": { "properties": { "capabilities": { "$ref": "#/components/schemas/ResourceCapabilitiesView" }, "networks": { "items": { "$ref": "#/components/schemas/NetworkView" }, "type": "array" } }, "required": [ "networks", "capabilities" ], "type": "object" }, "NewGitRepository": { "properties": { "defaultBranch": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "gitAccountId": { "format": "uuid", "type": [ "string", "null" ] }, "name": { "type": "string" }, "onClone": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/RepoCommand" } ] }, "onPull": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/RepoCommand" } ] }, "syncIntervalMinutes": { "format": "int32", "type": [ "integer", "null" ] }, "syncMode": { "$ref": "#/components/schemas/GitRepositorySyncMode" }, "tagIds": { "items": { "format": "uuid", "type": "string" }, "type": "array" }, "url": { "type": "string" }, "webhook": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/WebhookConfig" } ] } }, "required": [ "name", "url", "defaultBranch" ], "type": "object" }, "NewRegistry": { "properties": { "configuration": { "$ref": "#/components/schemas/RegistrySpec" }, "description": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "registryHost": { "description": "Required for custom registry addresses; inferred for Docker Hub and GitHub.", "type": "string" }, "status": { "$ref": "#/components/schemas/RegistryStatus" }, "tagIds": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "required": [ "name", "status", "configuration" ], "type": "object" }, "NewResourceBinding": { "properties": { "kind": { "$ref": "#/components/schemas/ResourceBindingKind" }, "name": { "type": "string" }, "secretDeliveryMode": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/SecretDeliveryMode" } ] }, "secretId": { "format": "uuid", "type": [ "string", "null" ] }, "targetPath": { "type": [ "string", "null" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "name", "kind" ], "type": "object" }, "NewTag": { "properties": { "color": { "type": "string" }, "name": { "type": "string" } }, "required": [ "name", "color" ], "type": "object" }, "NodeAgentCoverage": { "properties": { "agentConnectionState": { "type": "string" }, "architecture": { "type": "string" }, "availability": { "type": "string" }, "compatible": { "type": "boolean" }, "dataSource": { "type": "string" }, "dockerNodeId": { "type": "string" }, "dockerReachable": { "type": "boolean" }, "eligible": { "type": "boolean" }, "hostname": { "type": "string" }, "lastHeartbeatAtUtc": { "format": "date-time", "type": [ "string", "null" ] }, "lastSuccessfulReconciliationAt": { "format": "date-time", "type": [ "string", "null" ] }, "nodeStatus": { "type": "string" }, "projectionStale": { "type": "boolean" }, "reasons": { "items": { "type": "string" }, "type": "array" }, "role": { "type": "string" }, "schedulable": { "type": "boolean" }, "serviceTaskState": { "type": [ "string", "null" ] }, "staleReason": { "type": [ "string", "null" ] }, "staleSince": { "format": "date-time", "type": [ "string", "null" ] }, "supported": { "type": "boolean" } }, "required": [ "dockerNodeId", "hostname", "role", "availability", "nodeStatus", "architecture", "dataSource", "eligible", "supported", "schedulable", "agentConnectionState", "dockerReachable", "compatible", "projectionStale", "reasons" ], "type": "object" }, "NodeAgentOperation": { "properties": { "error": { "type": [ "string", "null" ] }, "kind": { "type": "string" }, "operationId": { "format": "uuid", "type": "string" }, "startedAtUtc": { "format": "date-time", "type": "string" }, "state": { "type": "string" } }, "required": [ "operationId", "kind", "state", "startedAtUtc" ], "type": "object" }, "NodeAgentProgress": { "properties": { "errorMessage": { "type": [ "string", "null" ] }, "isCompleted": { "type": "boolean" }, "isWarning": { "type": "boolean" }, "message": { "type": "string" }, "operationId": { "format": "uuid", "type": "string" }, "platformId": { "format": "uuid", "type": "string" }, "stage": { "type": "string" } }, "required": [ "platformId", "operationId", "stage", "message", "isCompleted", "isWarning" ], "type": "object" }, "NodeInspectionView": { "properties": { "address": { "type": "string" }, "architecture": { "type": "string" }, "availability": { "type": "string" }, "createdAt": { "format": "date-time", "type": [ "string", "null" ] }, "desiredTaskCount": { "format": "int32", "type": "integer" }, "engineVersion": { "type": "string" }, "hostname": { "type": "string" }, "id": { "type": "string" }, "isLeader": { "type": "boolean" }, "labels": { "additionalProperties": { "type": "string" }, "propertyNames": { "type": "string" }, "type": "object" }, "operatingSystem": { "type": "string" }, "reachability": { "type": "string" }, "role": { "type": "string" }, "runningTaskCount": { "format": "int32", "type": "integer" }, "status": { "type": "string" }, "statusMessage": { "type": [ "string", "null" ] }, "updatedAt": { "format": "date-time", "type": [ "string", "null" ] }, "versionIndex": { "format": "int64", "type": "integer" } }, "required": [ "id", "versionIndex", "hostname", "role", "isLeader", "reachability", "status", "availability", "engineVersion", "operatingSystem", "architecture", "address", "labels", "runningTaskCount", "desiredTaskCount" ], "type": "object" }, "OidcProviderActivitySnapshot": { "properties": { "allowEmailAutoLink": { "type": "boolean" }, "allowedEmailDomains": { "type": [ "string", "null" ] }, "autoProvisionUsers": { "type": "boolean" }, "clientId": { "type": "string" }, "defaultRoleId": { "format": "uuid", "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "displayName": { "type": "string" }, "enabled": { "type": "boolean" }, "id": { "format": "uuid", "type": "string" }, "issuer": { "type": "string" }, "name": { "type": "string" }, "requireEmailVerified": { "type": "boolean" }, "requiredClaimName": { "type": [ "string", "null" ] }, "requiredClaimValues": { "type": [ "string", "null" ] }, "scopes": { "type": "string" } }, "required": [ "id", "name", "displayName", "issuer", "clientId", "scopes", "enabled", "autoProvisionUsers", "allowEmailAutoLink", "requireEmailVerified" ], "type": "object" }, "PagedActivityView": { "properties": { "items": { "items": { "$ref": "#/components/schemas/ActivityView" }, "type": "array" }, "page": { "format": "int32", "type": "integer" }, "pageSize": { "format": "int32", "type": "integer" }, "totalCount": { "format": "int64", "type": "integer" } }, "required": [ "items", "totalCount", "page", "pageSize" ], "type": "object" }, "PatchAlertChannelInput": { "properties": { "alertDestination": { "$ref": "#/components/schemas/AlertDestination" }, "isActive": { "type": "boolean" }, "name": { "type": [ "string", "null" ] }, "url": { "type": "string" } }, "type": "object" }, "PatchAlertRuleInput": { "properties": { "channelIds": { "items": { "format": "uuid", "type": "string" }, "type": [ "array", "null" ] }, "cooldownSeconds": { "format": "int32", "type": [ "integer", "null" ] }, "limitedTo": { "items": { "$ref": "#/components/schemas/AlertResourceScope" }, "type": [ "array", "null" ] }, "quietHours": { "items": { "$ref": "#/components/schemas/AlertQuietHour" }, "type": [ "array", "null" ] }, "requiredMatches": { "format": "int32", "type": [ "integer", "null" ] }, "severity": { "$ref": "#/components/schemas/AlertSeverity" }, "status": { "$ref": "#/components/schemas/AlertRuleStatus" }, "threshold": { "format": "double", "type": [ "number", "null" ] }, "type": { "$ref": "#/components/schemas/AlertType" } }, "type": "object" }, "PatchAlertRuleMetadata": { "properties": { "description": { "type": [ "string", "null" ] } }, "type": "object" }, "PatchDeploymentInput": { "additionalProperties": false, "properties": { "description": { "type": [ "string", "null" ] }, "id": { "format": "uuid", "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] }, "platformId": { "format": "uuid", "type": [ "string", "null" ] }, "spec": {} }, "type": "object" }, "PatchDeploymentMetadataInput": { "additionalProperties": false, "properties": { "description": { "type": [ "string", "null" ] }, "tags": { "items": { "type": "string" }, "type": [ "array", "null" ] } }, "type": "object" }, "PatchPlatformMetadataInput": { "properties": { "description": { "type": [ "string", "null" ] }, "tags": { "items": { "type": "string" }, "type": [ "array", "null" ] } }, "type": "object" }, "PatchResourceMetadataInput": { "properties": { "description": { "type": [ "string", "null" ] }, "tags": { "items": { "type": "string" }, "type": [ "array", "null" ] } }, "type": "object" }, "PatchStackInput": { "additionalProperties": false, "properties": { "description": { "type": [ "string", "null" ] }, "driftPolicy": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/StackDriftPolicy" } ] }, "name": { "type": [ "string", "null" ] }, "platformId": { "format": "uuid", "type": [ "string", "null" ] }, "rowVersion": { "format": "int64", "type": [ "integer", "null" ] }, "spec": {}, "stackSource": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/StackSource" } ] } }, "type": "object" }, "PatchStackMetadataInput": { "properties": { "description": { "type": [ "string", "null" ] } }, "type": "object" }, "PermissionLevel": { "enum": [ "None", "Read", "Write", "Execute" ], "type": "string" }, "PlatformActivitySnapshot": { "properties": { "address": { "type": "string" }, "agentVersion": { "type": [ "string", "null" ] }, "connectorType": { "type": "string" }, "cpuCount": { "format": "int64", "type": "integer" }, "description": { "type": [ "string", "null" ] }, "id": { "format": "uuid", "type": "string" }, "imageCount": { "format": "int64", "type": "integer" }, "memTotal": { "format": "int64", "type": "integer" }, "name": { "type": "string" }, "networkCount": { "format": "int32", "type": "integer" }, "platformDescriptor": {}, "serverVersion": { "type": [ "string", "null" ] }, "status": { "type": "string" }, "volumeCount": { "format": "int32", "type": "integer" } }, "required": [ "id", "name", "address", "status", "connectorType", "networkCount", "volumeCount", "imageCount", "cpuCount", "memTotal", "platformDescriptor" ], "type": "object" }, "PlatformBackupSummaries": { "properties": { "platforms": { "items": { "$ref": "#/components/schemas/PlatformBackupSummary" }, "type": "array" } }, "required": [ "platforms" ], "type": "object" }, "PlatformBackupSummary": { "properties": { "attentionPolicyCount": { "format": "int32", "type": "integer" }, "deploymentPolicyCount": { "format": "int32", "type": "integer" }, "dockerVolumePolicyCount": { "format": "int32", "type": "integer" }, "enabledPolicyCount": { "format": "int32", "type": "integer" }, "lastRunAt": { "format": "date-time", "type": [ "string", "null" ] }, "lastRunStatus": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/BackupRunStatus" } ] }, "platformId": { "format": "uuid", "type": "string" }, "policyCount": { "format": "int32", "type": "integer" }, "stackPolicyCount": { "format": "int32", "type": "integer" }, "swarmServicePolicyCount": { "format": "int32", "type": "integer" } }, "required": [ "platformId", "policyCount", "enabledPolicyCount", "dockerVolumePolicyCount", "stackPolicyCount", "deploymentPolicyCount", "swarmServicePolicyCount", "attentionPolicyCount" ], "type": "object" }, "PlatformCapabilitiesView": { "properties": { "canExecute": { "type": "boolean" }, "canInspect": { "type": "boolean" }, "canManageNodeAgents": { "type": "boolean" }, "canOpenTerminal": { "type": "boolean" }, "canPull": { "type": "boolean" }, "canRead": { "type": "boolean" }, "canViewLogs": { "type": "boolean" }, "canWrite": { "type": "boolean" } }, "required": [ "canRead", "canWrite", "canExecute", "canViewLogs", "canInspect", "canOpenTerminal", "canPull", "canManageNodeAgents" ], "type": "object" }, "PlatformConnectorType": { "enum": [ "Unknown", "Local", "Agent", "EdgeAgent" ], "type": "string" }, "PlatformDescriptor": { "oneOf": [ { "allOf": [ { "$ref": "#/components/schemas/DockerPlatformDescriptor" }, { "properties": { "$type": { "enum": [ "Docker" ], "type": "string" } }, "required": [ "$type" ], "type": "object" } ] }, { "allOf": [ { "$ref": "#/components/schemas/DockerSwarmPlatformDescriptor" }, { "properties": { "$type": { "enum": [ "DockerSwarm" ], "type": "string" } }, "required": [ "$type" ], "type": "object" } ] }, { "allOf": [ { "$ref": "#/components/schemas/KubernetesPlatformDescriptor" }, { "properties": { "$type": { "enum": [ "Kubernetes" ], "type": "string" } }, "required": [ "$type" ], "type": "object" } ] } ] }, "PlatformPatch": { "description": "Omitted fields preserve their stored value. Only address and description allow null.", "properties": { "address": { "type": [ "string", "null" ] }, "connectorType": { "$ref": "#/components/schemas/PlatformConnectorType" }, "description": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "pruneHistoricalSwarmTaskContainers": { "type": "boolean" }, "type": { "$ref": "#/components/schemas/PlatformType" } }, "type": "object" }, "PlatformStatView": { "properties": { "cpuUsage": { "format": "double", "type": "number" }, "created": { "format": "int64", "type": "integer" }, "diskTotalBytes": { "format": "int64", "type": [ "integer", "null" ] }, "diskUsage": { "format": "double", "type": [ "number", "null" ] }, "diskUsedBytes": { "format": "int64", "type": [ "integer", "null" ] }, "memoryUsage": { "format": "double", "type": "number" }, "rxBytes": { "format": "double", "type": "number" }, "txBytes": { "format": "double", "type": "number" } }, "required": [ "created", "txBytes", "rxBytes", "cpuUsage", "memoryUsage", "diskUsedBytes", "diskTotalBytes", "diskUsage" ], "type": "object" }, "PlatformStatus": { "enum": [ "Offline", "Online" ], "type": "string" }, "PlatformType": { "enum": [ "Docker", "DockerSwarm", "Kubernetes" ], "type": "string" }, "PlatformView": { "properties": { "address": { "type": "string" }, "agentVersion": { "type": [ "string", "null" ] }, "capabilities": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PlatformCapabilitiesView" } ] }, "clusterId": { "type": [ "string", "null" ] }, "connectorType": { "$ref": "#/components/schemas/PlatformConnectorType" }, "cpuCount": { "format": "int64", "type": "integer" }, "deploymentCount": { "format": "int64", "type": "integer" }, "deploymentStatusCounts": { "$ref": "#/components/schemas/WorkloadStatusCounts" }, "description": { "type": [ "string", "null" ] }, "id": { "format": "uuid", "type": "string" }, "imageCount": { "format": "int64", "type": "integer" }, "memTotal": { "format": "int64", "type": "integer" }, "name": { "type": "string" }, "networkCount": { "format": "int32", "type": "integer" }, "platformDescriptor": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PlatformDescriptor" } ] }, "pruneHistoricalSwarmTaskContainers": { "type": "boolean" }, "serverVersion": { "type": [ "string", "null" ] }, "stackCount": { "format": "int64", "type": "integer" }, "stackStatusCounts": { "$ref": "#/components/schemas/WorkloadStatusCounts" }, "stats": { "items": { "$ref": "#/components/schemas/PlatformStatView" }, "type": [ "array", "null" ] }, "status": { "$ref": "#/components/schemas/PlatformStatus" }, "swarmServiceStatusCounts": { "$ref": "#/components/schemas/WorkloadStatusCounts" }, "tags": { "items": { "$ref": "#/components/schemas/resources.tags.TagSummary" }, "type": "array" }, "type": { "$ref": "#/components/schemas/PlatformType" }, "volumeCount": { "format": "int32", "type": "integer" } }, "required": [ "id", "tags", "name", "description", "address", "networkCount", "volumeCount", "imageCount", "cpuCount", "memTotal", "agentVersion", "serverVersion", "type", "status", "connectorType", "deploymentCount", "stackCount", "deploymentStatusCounts", "stackStatusCounts", "swarmServiceStatusCounts", "stats", "platformDescriptor", "clusterId", "pruneHistoricalSwarmTaskContainers", "capabilities" ], "type": "object" }, "PlatformsResponse": { "properties": { "capabilities": { "$ref": "#/components/schemas/ResourceCapabilitiesView" }, "platforms": { "items": { "$ref": "#/components/schemas/PlatformView" }, "type": "array" } }, "required": [ "platforms", "capabilities" ], "type": "object" }, "Policies": { "properties": { "capabilities": { "$ref": "#/components/schemas/ResourceCapabilitiesView" }, "policies": { "items": { "$ref": "#/components/schemas/BackupPolicyView" }, "type": "array" } }, "required": [ "policies", "capabilities" ], "type": "object" }, "Pools": { "properties": { "capabilities": { "$ref": "#/components/schemas/ResourceCapabilitiesView" }, "pools": { "items": { "$ref": "#/components/schemas/AuthorizedPool" }, "type": "array" } }, "required": [ "pools", "capabilities" ], "type": "object" }, "PortPublishMode": { "enum": [ "Ingress", "Host" ], "type": "string" }, "ProblemDetails": { "properties": { "capability": { "type": [ "string", "null" ] }, "detail": { "type": [ "string", "null" ] }, "effectiveEdition": { "type": [ "string", "null" ] }, "errors": { "additionalProperties": { "items": { "type": "string" }, "type": "array" }, "propertyNames": { "type": "string" }, "type": [ "object", "null" ] }, "licenseStatus": { "type": [ "string", "null" ] }, "requestId": { "type": [ "string", "null" ] }, "status": { "format": "int32", "minimum": 0, "type": "integer" }, "title": { "type": "string" }, "traceId": { "type": [ "string", "null" ] }, "type": { "type": "string" } }, "required": [ "type", "title", "status" ], "type": "object" }, "Projects": { "properties": { "capabilities": { "$ref": "#/components/schemas/ResourceCapabilitiesView" }, "projects": { "items": { "$ref": "#/components/schemas/AuthorizedProject" }, "type": "array" } }, "required": [ "projects", "capabilities" ], "type": "object" }, "PrunePlatformInput": { "properties": { "resource": { "$ref": "#/components/schemas/PruneResource" } }, "required": [ "resource" ], "type": "object" }, "PrunePlatformView": { "properties": { "buildCacheDeleted": { "items": { "type": "string" }, "type": "array" }, "imagesDeleted": { "items": { "type": "string" }, "type": "array" }, "networksDeleted": { "items": { "type": "string" }, "type": "array" }, "resource": { "$ref": "#/components/schemas/PruneResource" }, "spaceReclaimed": { "format": "int64", "type": "integer" }, "volumesDeleted": { "items": { "type": "string" }, "type": "array" } }, "required": [ "resource", "spaceReclaimed", "volumesDeleted", "networksDeleted", "imagesDeleted", "buildCacheDeleted" ], "type": "object" }, "PruneResource": { "enum": [ "All", "Volume", "Network", "Image", "Build" ], "type": "string" }, "PublicActivityEventInfo": { "oneOf": [ { "properties": { "$type": { "enum": [ "InitialAdministratorCreated" ], "type": "string" }, "mode": { "type": "string" }, "userId": { "format": "uuid", "type": "string" }, "userName": { "type": "string" } }, "required": [ "userId", "userName", "mode", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "AlertRuleCreated" ], "type": "string" }, "alertRule": { "$ref": "#/components/schemas/AlertRuleActivitySnapshot" } }, "required": [ "alertRule", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "AlertRuleUpdated" ], "type": "string" }, "newRule": { "$ref": "#/components/schemas/AlertRuleActivitySnapshot" }, "oldRule": { "$ref": "#/components/schemas/AlertRuleActivitySnapshot" } }, "required": [ "oldRule", "newRule", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "BackupPolicyCreated" ], "type": "string" }, "policy": { "$ref": "#/components/schemas/BackupPolicyActivitySnapshot" } }, "required": [ "policy", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "BackupRunQueued" ], "type": "string" }, "runId": { "format": "uuid", "type": "string" }, "trigger": { "type": "string" } }, "required": [ "runId", "trigger", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "BackupRunStarted" ], "type": "string" }, "runId": { "format": "uuid", "type": "string" }, "trigger": { "type": "string" } }, "required": [ "runId", "trigger", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "BackupRunCompleted" ], "type": "string" }, "durationMs": { "format": "int64", "type": [ "integer", "null" ] }, "errorMessage": { "type": [ "string", "null" ] }, "runId": { "format": "uuid", "type": "string" }, "status": { "type": "string" }, "trigger": { "type": "string" } }, "required": [ "runId", "trigger", "status", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "BackupPolicyRenamed" ], "type": "string" }, "newName": { "type": "string" }, "oldName": { "type": "string" } }, "required": [ "oldName", "newName", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "BackupPolicyUpdated" ], "type": "string" }, "newPolicy": { "$ref": "#/components/schemas/BackupPolicyActivitySnapshot" }, "oldPolicy": { "$ref": "#/components/schemas/BackupPolicyActivitySnapshot" } }, "required": [ "oldPolicy", "newPolicy", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "AlertRuleRenamed" ], "type": "string" }, "newName": { "type": "string" }, "oldName": { "type": "string" } }, "required": [ "oldName", "newName", "$type" ], "type": "object" }, { "allOf": [ { "$ref": "#/components/schemas/VolumeContentDownloaded" }, { "properties": { "$type": { "enum": [ "VolumeContentDownloaded" ], "type": "string" } }, "required": [ "$type" ], "type": "object" } ] }, { "allOf": [ { "$ref": "#/components/schemas/WebhookActivityDetails" }, { "properties": { "$type": { "enum": [ "GitRepoWebhookReceived" ], "type": "string" } }, "required": [ "$type" ], "type": "object" } ] }, { "allOf": [ { "$ref": "#/components/schemas/WebhookActivityDetails" }, { "properties": { "$type": { "enum": [ "StackWebhookReceived" ], "type": "string" } }, "required": [ "$type" ], "type": "object" } ] }, { "allOf": [ { "$ref": "#/components/schemas/WebhookActivityDetails" }, { "properties": { "$type": { "enum": [ "BuildWebhookReceived" ], "type": "string" } }, "required": [ "$type" ], "type": "object" } ] }, { "allOf": [ { "$ref": "#/components/schemas/WebhookActivityDetails" }, { "properties": { "$type": { "enum": [ "ActionWebhookReceived" ], "type": "string" } }, "required": [ "$type" ], "type": "object" } ] }, { "allOf": [ { "$ref": "#/components/schemas/WebhookActivityDetails" }, { "properties": { "$type": { "enum": [ "BackupPolicyWebhookReceived" ], "type": "string" } }, "required": [ "$type" ], "type": "object" } ] }, { "allOf": [ { "$ref": "#/components/schemas/WebhookActivityDetails" }, { "properties": { "$type": { "enum": [ "SwarmServiceWebhookReceived" ], "type": "string" } }, "required": [ "$type" ], "type": "object" } ] }, { "properties": { "$type": { "enum": [ "UserProfileUpdated" ], "type": "string" }, "changes": { "items": { "$ref": "#/components/schemas/ActivityChangedField" }, "type": "array" } }, "required": [ "changes", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "UserPreferencesUpdated" ], "type": "string" }, "changes": { "items": { "$ref": "#/components/schemas/ActivityChangedField" }, "type": "array" } }, "required": [ "changes", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "UserPasswordChanged" ], "type": "string" } }, "required": [ "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "UserSessionRevoked" ], "type": "string" }, "sessionId": { "format": "uuid", "type": "string" } }, "required": [ "sessionId", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "UserOtherSessionsRevoked" ], "type": "string" }, "count": { "format": "int32", "type": "integer" } }, "required": [ "count", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "UserMfaEnabled" ], "type": "string" } }, "required": [ "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "UserMfaDisabled" ], "type": "string" } }, "required": [ "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "UserMfaVerificationFailed" ], "type": "string" } }, "required": [ "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "UserMfaRecoveryCodeUsed" ], "type": "string" } }, "required": [ "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "UserMfaRecoveryCodesRegenerated" ], "type": "string" } }, "required": [ "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "UserMfaResetByAdministrator" ], "type": "string" }, "targetUserId": { "format": "uuid", "type": "string" } }, "required": [ "targetUserId", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "UserCreated" ], "type": "string" }, "user": { "$ref": "#/components/schemas/UserActivitySnapshot" } }, "required": [ "user", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "UserUpdated" ], "type": "string" }, "newUser": { "$ref": "#/components/schemas/UserActivitySnapshot" }, "oldUser": { "$ref": "#/components/schemas/UserActivitySnapshot" }, "passwordChanged": { "type": "boolean" } }, "required": [ "oldUser", "newUser", "passwordChanged", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "UserRenamed" ], "type": "string" }, "newName": { "type": "string" }, "oldName": { "type": "string" } }, "required": [ "oldName", "newName", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "UserDeleted" ], "type": "string" }, "user": { "$ref": "#/components/schemas/UserActivitySnapshot" } }, "required": [ "user", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "TeamCreated" ], "type": "string" }, "team": { "$ref": "#/components/schemas/TeamActivitySnapshot" } }, "required": [ "team", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "TeamUpdated" ], "type": "string" }, "newTeam": { "$ref": "#/components/schemas/TeamActivitySnapshot" }, "oldTeam": { "$ref": "#/components/schemas/TeamActivitySnapshot" } }, "required": [ "oldTeam", "newTeam", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "TeamRenamed" ], "type": "string" }, "newName": { "type": "string" }, "oldName": { "type": "string" } }, "required": [ "oldName", "newName", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "TeamDeleted" ], "type": "string" }, "team": { "$ref": "#/components/schemas/TeamActivitySnapshot" } }, "required": [ "team", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "RoleCreated" ], "type": "string" }, "role": { "$ref": "#/components/schemas/RoleActivitySnapshot" } }, "required": [ "role", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "RoleUpdated" ], "type": "string" }, "newRole": { "$ref": "#/components/schemas/RoleActivitySnapshot" }, "oldRole": { "$ref": "#/components/schemas/RoleActivitySnapshot" } }, "required": [ "oldRole", "newRole", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "RoleRenamed" ], "type": "string" }, "newName": { "type": "string" }, "oldName": { "type": "string" } }, "required": [ "oldName", "newName", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "RoleDeleted" ], "type": "string" }, "role": { "$ref": "#/components/schemas/RoleActivitySnapshot" } }, "required": [ "role", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "ServiceAccountCreated" ], "type": "string" }, "account": { "$ref": "#/components/schemas/ServiceAccountActivitySnapshot" } }, "required": [ "account", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "ServiceAccountUpdated" ], "type": "string" }, "newAccount": { "$ref": "#/components/schemas/ServiceAccountActivitySnapshot" }, "oldAccount": { "$ref": "#/components/schemas/ServiceAccountActivitySnapshot" } }, "required": [ "oldAccount", "newAccount", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "ServiceAccountRenamed" ], "type": "string" }, "newName": { "type": "string" }, "oldName": { "type": "string" } }, "required": [ "oldName", "newName", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "ServiceAccountEnabled" ], "type": "string" }, "accountId": { "format": "uuid", "type": "string" } }, "required": [ "accountId", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "ServiceAccountDisabled" ], "type": "string" }, "accountId": { "format": "uuid", "type": "string" } }, "required": [ "accountId", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "ServiceAccountArchived" ], "type": "string" }, "accountId": { "format": "uuid", "type": "string" } }, "required": [ "accountId", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "ServiceAccountTokenCreated" ], "type": "string" }, "accountId": { "format": "uuid", "type": "string" }, "expiresAtUtc": { "format": "date-time", "type": [ "string", "null" ] }, "publicHint": { "type": "string" }, "tokenId": { "format": "uuid", "type": "string" }, "tokenName": { "type": "string" } }, "required": [ "accountId", "tokenId", "tokenName", "publicHint", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "ServiceAccountTokenRevoked" ], "type": "string" }, "accountId": { "format": "uuid", "type": "string" }, "publicHint": { "type": "string" }, "tokenId": { "format": "uuid", "type": "string" } }, "required": [ "accountId", "tokenId", "publicHint", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "LicenseInstalled" ], "type": "string" }, "license": { "$ref": "#/components/schemas/LicenseActivitySnapshot" } }, "required": [ "license", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "LicenseReplaced" ], "type": "string" }, "newLicense": { "$ref": "#/components/schemas/LicenseActivitySnapshot" }, "oldLicense": { "$ref": "#/components/schemas/LicenseActivitySnapshot" } }, "required": [ "oldLicense", "newLicense", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "LicenseRemoved" ], "type": "string" }, "license": { "$ref": "#/components/schemas/LicenseActivitySnapshot" } }, "required": [ "license", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "LicenseEnteredGracePeriod" ], "type": "string" }, "license": { "$ref": "#/components/schemas/LicenseActivitySnapshot" } }, "required": [ "license", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "LicenseExpired" ], "type": "string" }, "license": { "$ref": "#/components/schemas/LicenseActivitySnapshot" } }, "required": [ "license", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "LicenseValidationFailed" ], "type": "string" }, "errorCode": { "type": [ "string", "null" ] }, "fingerprint": { "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/LicenseStatus" } }, "required": [ "status", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "OidcProviderCreated" ], "type": "string" }, "provider": { "$ref": "#/components/schemas/OidcProviderActivitySnapshot" } }, "required": [ "provider", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "OidcProviderUpdated" ], "type": "string" }, "newProvider": { "$ref": "#/components/schemas/OidcProviderActivitySnapshot" }, "oldProvider": { "$ref": "#/components/schemas/OidcProviderActivitySnapshot" } }, "required": [ "oldProvider", "newProvider", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "OidcProviderRenamed" ], "type": "string" }, "newName": { "type": "string" }, "oldName": { "type": "string" } }, "required": [ "oldName", "newName", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "OidcProviderDeleted" ], "type": "string" }, "provider": { "$ref": "#/components/schemas/OidcProviderActivitySnapshot" } }, "required": [ "provider", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "RegistryCreated" ], "type": "string" }, "registry": { "$ref": "#/components/schemas/RegistryActivitySnapshot" } }, "required": [ "registry", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "RegistryUpdated" ], "type": "string" }, "newRegistry": { "$ref": "#/components/schemas/RegistryActivitySnapshot" }, "oldRegistry": { "$ref": "#/components/schemas/RegistryActivitySnapshot" } }, "required": [ "oldRegistry", "newRegistry", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "RegistryRenamed" ], "type": "string" }, "newName": { "type": "string" }, "oldName": { "type": "string" } }, "required": [ "oldName", "newName", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "RegistryDeleted" ], "type": "string" }, "registry": { "$ref": "#/components/schemas/RegistryActivitySnapshot" } }, "required": [ "registry", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "DeploymentCreated" ], "type": "string" }, "deployment": { "$ref": "#/components/schemas/DeploymentActivitySnapshot" } }, "required": [ "deployment", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "DeploymentAdopted" ], "type": "string" }, "containerId": { "type": "string" }, "containerName": { "type": "string" }, "deployment": { "$ref": "#/components/schemas/DeploymentActivitySnapshot" } }, "required": [ "deployment", "containerId", "containerName", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "DeploymentDuplicated" ], "type": "string" }, "deployment": { "$ref": "#/components/schemas/DeploymentActivitySnapshot" }, "source": { "$ref": "#/components/schemas/ActivitySourceResource" } }, "required": [ "deployment", "source", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "DeploymentUpdated" ], "type": "string" }, "newDeployment": { "$ref": "#/components/schemas/DeploymentActivitySnapshot" }, "oldDeployment": { "$ref": "#/components/schemas/DeploymentActivitySnapshot" } }, "required": [ "oldDeployment", "newDeployment", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "DeploymentRenamed" ], "type": "string" }, "newName": { "type": "string" }, "oldName": { "type": "string" } }, "required": [ "oldName", "newName", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "DeploymentDeleted" ], "type": "string" }, "deployment": { "$ref": "#/components/schemas/DeploymentActivitySnapshot" } }, "required": [ "deployment", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "DeploymentStarted" ], "type": "string" }, "containerIds": { "items": { "type": "string" }, "type": "array" } }, "required": [ "containerIds", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "DeploymentStopped" ], "type": "string" }, "containerIds": { "items": { "type": "string" }, "type": "array" } }, "required": [ "containerIds", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "DeploymentPaused" ], "type": "string" }, "containerIds": { "items": { "type": "string" }, "type": "array" } }, "required": [ "containerIds", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "DeploymentDegraded" ], "type": "string" }, "reason": { "type": "string" } }, "required": [ "reason", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "StackDegraded" ], "type": "string" }, "reason": { "type": "string" } }, "required": [ "reason", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "DeploymentApplied" ], "type": "string" }, "deployment": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/DeploymentActivitySnapshot" } ] }, "result": { "$ref": "#/components/schemas/DeploymentResultActivitySnapshot" } }, "required": [ "result", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "StackCreated" ], "type": "string" }, "stack": { "$ref": "#/components/schemas/StackActivitySnapshot" } }, "required": [ "stack", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "StackDuplicated" ], "type": "string" }, "source": { "$ref": "#/components/schemas/ActivitySourceResource" }, "stack": { "$ref": "#/components/schemas/StackActivitySnapshot" } }, "required": [ "stack", "source", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "StackUpdated" ], "type": "string" }, "newStack": { "$ref": "#/components/schemas/StackActivitySnapshot" }, "oldStack": { "$ref": "#/components/schemas/StackActivitySnapshot" } }, "required": [ "oldStack", "newStack", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "StackRenamed" ], "type": "string" }, "newName": { "type": "string" }, "oldName": { "type": "string" } }, "required": [ "oldName", "newName", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "StackDeleted" ], "type": "string" }, "stack": { "$ref": "#/components/schemas/StackActivitySnapshot" } }, "required": [ "stack", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "StackStarted" ], "type": "string" }, "containerIds": { "items": { "type": "string" }, "type": "array" } }, "required": [ "containerIds", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "StackStopped" ], "type": "string" }, "containerIds": { "items": { "type": "string" }, "type": "array" } }, "required": [ "containerIds", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "StackPaused" ], "type": "string" }, "containerIds": { "items": { "type": "string" }, "type": "array" } }, "required": [ "containerIds", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "StackApplied" ], "type": "string" }, "result": { "$ref": "#/components/schemas/StackResultActivitySnapshot" }, "stack": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/StackActivitySnapshot" } ] } }, "required": [ "result", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "StackRollback" ], "type": "string" }, "newStack": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/StackActivitySnapshot" } ] }, "oldStack": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/StackActivitySnapshot" } ] }, "result": { "$ref": "#/components/schemas/StackResultActivitySnapshot" } }, "required": [ "result", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "StackDriftDetected" ], "type": "string" }, "fingerprint": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "reason", "fingerprint", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "StackDriftResolved" ], "type": "string" }, "previousFingerprint": { "type": "string" } }, "required": [ "previousFingerprint", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "StackImported" ], "type": "string" }, "projectName": { "type": "string" }, "serviceNames": { "items": { "type": "string" }, "type": "array" }, "stack": { "$ref": "#/components/schemas/StackActivitySnapshot" } }, "required": [ "stack", "projectName", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "SwarmServiceCreated" ], "type": "string" }, "service": { "$ref": "#/components/schemas/SwarmServiceActivitySnapshot" } }, "required": [ "service", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "SwarmServiceDuplicated" ], "type": "string" }, "service": { "$ref": "#/components/schemas/SwarmServiceActivitySnapshot" }, "source": { "$ref": "#/components/schemas/ActivitySourceResource" } }, "required": [ "service", "source", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "SwarmServiceAdopted" ], "type": "string" }, "dockerServiceId": { "type": "string" }, "service": { "$ref": "#/components/schemas/SwarmServiceActivitySnapshot" } }, "required": [ "service", "dockerServiceId", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "SwarmServiceUpdated" ], "type": "string" }, "newService": { "$ref": "#/components/schemas/SwarmServiceActivitySnapshot" }, "oldService": { "$ref": "#/components/schemas/SwarmServiceActivitySnapshot" } }, "required": [ "oldService", "newService", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "SwarmServiceRenamed" ], "type": "string" }, "newName": { "type": "string" }, "oldName": { "type": "string" } }, "required": [ "oldName", "newName", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "SwarmServiceDeleted" ], "type": "string" }, "service": { "$ref": "#/components/schemas/SwarmServiceActivitySnapshot" } }, "required": [ "service", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "SwarmServiceApplied" ], "type": "string" }, "operationId": { "format": "uuid", "type": "string" }, "warnings": { "items": { "type": "string" }, "type": "array" } }, "required": [ "operationId", "warnings", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "SwarmServiceScaled" ], "type": "string" }, "operationId": { "format": "uuid", "type": "string" }, "replicas": { "format": "int32", "type": "integer" }, "warnings": { "items": { "type": "string" }, "type": "array" } }, "required": [ "operationId", "replicas", "warnings", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "SwarmServiceForceUpdated" ], "type": "string" }, "operationId": { "format": "uuid", "type": "string" }, "warnings": { "items": { "type": "string" }, "type": "array" } }, "required": [ "operationId", "warnings", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "SwarmServiceOperationFailed" ], "type": "string" }, "kind": { "type": "string" }, "operationId": { "format": "uuid", "type": "string" }, "reason": { "type": "string" } }, "required": [ "operationId", "kind", "reason", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "PlatformConnected" ], "type": "string" }, "platform": { "$ref": "#/components/schemas/PlatformActivitySnapshot" }, "previousStatus": { "type": "string" } }, "required": [ "platform", "previousStatus", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "PlatformDisconnected" ], "type": "string" }, "platform": { "$ref": "#/components/schemas/PlatformActivitySnapshot" }, "previousStatus": { "type": "string" } }, "required": [ "platform", "previousStatus", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "PlatformCreated" ], "type": "string" }, "platform": { "$ref": "#/components/schemas/PlatformActivitySnapshot" } }, "required": [ "platform", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "PlatformRenamed" ], "type": "string" }, "newName": { "type": "string" }, "oldName": { "type": "string" } }, "required": [ "oldName", "newName", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "PlatformDeleted" ], "type": "string" }, "platform": { "$ref": "#/components/schemas/PlatformActivitySnapshot" } }, "required": [ "platform", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "PlatformNodeAgentLifecycle" ], "type": "string" }, "kind": { "type": "string" }, "message": { "type": "string" }, "operationId": { "format": "uuid", "type": "string" }, "state": { "type": "string" } }, "required": [ "operationId", "kind", "state", "message", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "GitRepoCreated" ], "type": "string" }, "gitRepo": { "$ref": "#/components/schemas/GitRepositoryActivitySnapshot" } }, "required": [ "gitRepo", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "GitRepoUpdated" ], "type": "string" }, "newGitRepo": { "$ref": "#/components/schemas/GitRepositoryActivitySnapshot" }, "oldGitRepo": { "$ref": "#/components/schemas/GitRepositoryActivitySnapshot" } }, "required": [ "oldGitRepo", "newGitRepo", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "GitRepoRenamed" ], "type": "string" }, "newName": { "type": "string" }, "oldName": { "type": "string" } }, "required": [ "oldName", "newName", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "GitRepoDeleted" ], "type": "string" }, "gitRepo": { "$ref": "#/components/schemas/GitRepositoryActivitySnapshot" } }, "required": [ "gitRepo", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "GitRepoPulled" ], "type": "string" }, "gitRepo": { "$ref": "#/components/schemas/GitRepositoryActivitySnapshot" }, "result": { "$ref": "#/components/schemas/GitRepositorySyncActivitySnapshot" } }, "required": [ "gitRepo", "result", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "GitRepoCloned" ], "type": "string" }, "gitRepo": { "$ref": "#/components/schemas/GitRepositoryActivitySnapshot" }, "result": { "$ref": "#/components/schemas/GitRepositorySyncActivitySnapshot" } }, "required": [ "gitRepo", "result", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "ActionCreated" ], "type": "string" }, "action": { "$ref": "#/components/schemas/AutomationActionActivitySnapshot" } }, "required": [ "action", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "ActionUpdated" ], "type": "string" }, "newAction": { "$ref": "#/components/schemas/AutomationActionActivitySnapshot" }, "oldAction": { "$ref": "#/components/schemas/AutomationActionActivitySnapshot" } }, "required": [ "oldAction", "newAction", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "ActionRenamed" ], "type": "string" }, "newName": { "type": "string" }, "oldName": { "type": "string" } }, "required": [ "oldName", "newName", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "ActionDeleted" ], "type": "string" }, "action": { "$ref": "#/components/schemas/AutomationActionActivitySnapshot" } }, "required": [ "action", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "ActionRunQueued" ], "type": "string" }, "runId": { "format": "uuid", "type": "string" }, "trigger": { "type": "string" } }, "required": [ "runId", "trigger", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "ActionRunStarted" ], "type": "string" }, "runId": { "format": "uuid", "type": "string" }, "trigger": { "type": "string" } }, "required": [ "runId", "trigger", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "ActionRunSucceeded" ], "type": "string" }, "durationMs": { "format": "int64", "type": [ "integer", "null" ] }, "exitCode": { "format": "int32", "type": [ "integer", "null" ] }, "runId": { "format": "uuid", "type": "string" }, "trigger": { "type": "string" } }, "required": [ "runId", "trigger", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "ActionRunFailed" ], "type": "string" }, "durationMs": { "format": "int64", "type": [ "integer", "null" ] }, "errorMessage": { "type": [ "string", "null" ] }, "exitCode": { "format": "int32", "type": [ "integer", "null" ] }, "runId": { "format": "uuid", "type": "string" }, "trigger": { "type": "string" } }, "required": [ "runId", "trigger", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "ActionRunTimedOut" ], "type": "string" }, "durationMs": { "format": "int64", "type": [ "integer", "null" ] }, "errorMessage": { "type": [ "string", "null" ] }, "runId": { "format": "uuid", "type": "string" }, "trigger": { "type": "string" } }, "required": [ "runId", "trigger", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "ActionRunCancelled" ], "type": "string" }, "runId": { "format": "uuid", "type": "string" }, "trigger": { "type": "string" } }, "required": [ "runId", "trigger", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "ActionRunRejected" ], "type": "string" }, "reason": { "type": "string" }, "runId": { "format": "uuid", "type": "string" }, "trigger": { "type": "string" } }, "required": [ "runId", "trigger", "reason", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "BuildRunQueued" ], "type": "string" }, "runId": { "format": "uuid", "type": "string" }, "trigger": { "type": "string" } }, "required": [ "runId", "trigger", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "BuildRunStarted" ], "type": "string" }, "runId": { "format": "uuid", "type": "string" }, "trigger": { "type": "string" } }, "required": [ "runId", "trigger", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "BuildRunSucceeded" ], "type": "string" }, "durationMs": { "format": "int64", "type": [ "integer", "null" ] }, "exitCode": { "format": "int32", "type": [ "integer", "null" ] }, "imageDigest": { "type": [ "string", "null" ] }, "runId": { "format": "uuid", "type": "string" }, "trigger": { "type": "string" } }, "required": [ "runId", "trigger", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "BuildRunFailed" ], "type": "string" }, "durationMs": { "format": "int64", "type": [ "integer", "null" ] }, "errorMessage": { "type": [ "string", "null" ] }, "exitCode": { "format": "int32", "type": [ "integer", "null" ] }, "runId": { "format": "uuid", "type": "string" }, "status": { "type": "string" }, "trigger": { "type": "string" } }, "required": [ "runId", "trigger", "status", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "BuildRunTimedOut" ], "type": "string" }, "durationMs": { "format": "int64", "type": [ "integer", "null" ] }, "errorMessage": { "type": [ "string", "null" ] }, "runId": { "format": "uuid", "type": "string" }, "trigger": { "type": "string" } }, "required": [ "runId", "trigger", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "BuildRunCancelled" ], "type": "string" }, "runId": { "format": "uuid", "type": "string" }, "trigger": { "type": "string" } }, "required": [ "runId", "trigger", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "BuildCreated" ], "type": "string" }, "build": { "$ref": "#/components/schemas/BuildProjectActivitySnapshot" } }, "required": [ "build", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "BuildUpdated" ], "type": "string" }, "newBuild": { "$ref": "#/components/schemas/BuildProjectActivitySnapshot" }, "oldBuild": { "$ref": "#/components/schemas/BuildProjectActivitySnapshot" } }, "required": [ "oldBuild", "newBuild", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "BuildRenamed" ], "type": "string" }, "newName": { "type": "string" }, "oldName": { "type": "string" } }, "required": [ "oldName", "newName", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "BuildDeleted" ], "type": "string" }, "build": { "$ref": "#/components/schemas/BuildProjectActivitySnapshot" } }, "required": [ "build", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "BuildAgentPoolConnected" ], "type": "string" }, "agentId": { "format": "uuid", "type": "string" }, "previousStatus": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "agentId", "previousStatus", "reason", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "BuildAgentPoolDisconnected" ], "type": "string" }, "agentId": { "format": "uuid", "type": "string" }, "previousStatus": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "agentId", "previousStatus", "reason", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "BuildAgentPoolCreated" ], "type": "string" }, "pool": { "$ref": "#/components/schemas/BuildAgentPoolActivitySnapshot" } }, "required": [ "pool", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "BuildAgentPoolUpdated" ], "type": "string" }, "newPool": { "$ref": "#/components/schemas/BuildAgentPoolActivitySnapshot" }, "oldPool": { "$ref": "#/components/schemas/BuildAgentPoolActivitySnapshot" } }, "required": [ "oldPool", "newPool", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "BuildAgentPoolRenamed" ], "type": "string" }, "newName": { "type": "string" }, "oldName": { "type": "string" } }, "required": [ "oldName", "newName", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "BuildAgentPoolDeleted" ], "type": "string" }, "pool": { "$ref": "#/components/schemas/BuildAgentPoolActivitySnapshot" } }, "required": [ "pool", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "BuildAgentPoolTested" ], "type": "string" }, "message": { "type": "string" }, "pool": { "$ref": "#/components/schemas/BuildAgentPoolActivitySnapshot" }, "status": { "type": "string" } }, "required": [ "pool", "status", "message", "$type" ], "type": "object" } ] }, "PullImageInput": { "properties": { "imageTag": { "type": "string" }, "platformId": { "format": "uuid", "type": "string" }, "registryId": { "format": "uuid", "type": "string" } }, "required": [ "platformId", "registryId", "imageTag" ], "type": "object" }, "PullImageStreamItem": { "properties": { "digest": { "type": [ "string", "null" ] }, "dockerImageId": { "type": [ "string", "null" ] }, "error": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ImagePullError" } ] }, "errorMessage": { "type": [ "string", "null" ] }, "from": { "type": [ "string", "null" ] }, "id": { "type": [ "string", "null" ] }, "progress": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/platforms.image_pull.ImagePullProgress" } ] }, "progressMessage": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] }, "stream": { "type": [ "string", "null" ] } }, "type": "object" }, "QueueBuildTrigger": { "enum": [ "Manual", "Webhook", "Dependency" ], "type": "string" }, "RecreateStackOnNewCommitState": { "properties": { "currentCommitSha": { "type": "string" }, "lastCheckedAt": { "format": "date-time", "type": "string" }, "remoteCommitSha": { "type": [ "string", "null" ] } }, "required": [ "currentCommitSha", "lastCheckedAt" ], "type": "object" }, "RecreateStackOnNewImageState": { "properties": { "autoUpdateStates": { "items": { "$ref": "#/components/schemas/ImageUpdateState" }, "type": "array" } }, "type": "object" }, "RegistriesResponse": { "properties": { "capabilities": { "$ref": "#/components/schemas/ResourceCapabilitiesView" }, "registries": { "items": { "$ref": "#/components/schemas/AuthorizedRegistryView" }, "type": "array" } }, "required": [ "registries", "capabilities" ], "type": "object" }, "RegistryActivitySnapshot": { "properties": { "configuration": {}, "description": { "type": "string" }, "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "registryHost": { "type": "string" }, "status": { "type": "string" } }, "required": [ "id", "name", "description", "registryHost", "status", "configuration" ], "type": "object" }, "RegistryConfigResponse": { "properties": { "configuration": { "$ref": "#/components/schemas/RegistryConfigurationView" }, "description": { "type": "string" }, "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "registryHost": { "type": "string" }, "status": { "$ref": "#/components/schemas/RegistryStatus" }, "tags": { "items": { "$ref": "#/components/schemas/resources.tags.TagSummary" }, "type": "array" } }, "required": [ "id", "name", "registryHost", "status", "description", "configuration", "tags" ], "type": "object" }, "RegistryConfigurationPatch": { "additionalProperties": false, "description": "Partial provider settings; omission preserves a value and null removes it.", "properties": { "$type": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/RegistryKind" } ] }, "accessKey": { "type": [ "string", "null" ] }, "authEnabled": { "type": [ "boolean", "null" ] }, "authenticationRequired": { "type": [ "boolean", "null" ] }, "ghcrAuthEnabled": { "type": [ "boolean", "null" ] }, "instanceUrl": { "type": [ "string", "null" ] }, "nameSpace": { "type": [ "string", "null" ] }, "password": { "type": [ "string", "null" ] }, "pat": { "type": [ "string", "null" ] }, "region": { "type": [ "string", "null" ] }, "secretAccessKey": { "type": [ "string", "null" ] }, "userName": { "type": [ "string", "null" ] } }, "type": "object" }, "RegistryConfigurationView": { "description": "Public settings and credential presence; secret values are write-only.", "oneOf": [ { "properties": { "$type": { "enum": [ "Custom" ], "type": "string" }, "authEnabled": { "type": [ "boolean", "null" ] }, "hasPassword": { "type": "boolean" }, "userName": { "type": [ "string", "null" ] } }, "required": [ "hasPassword", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "DockerHub" ], "type": "string" }, "hasPat": { "type": "boolean" }, "userName": { "type": [ "string", "null" ] } }, "required": [ "hasPat", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "Azure" ], "type": "string" }, "hasPassword": { "type": "boolean" }, "userName": { "type": "string" } }, "required": [ "userName", "hasPassword", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "AWS" ], "type": "string" }, "accessKey": { "type": "string" }, "authenticationRequired": { "type": [ "boolean", "null" ] }, "hasSecretAccessKey": { "type": "boolean" }, "region": { "type": "string" } }, "required": [ "accessKey", "hasSecretAccessKey", "region", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "Gitlab" ], "type": "string" }, "hasPat": { "type": "boolean" }, "instanceUrl": { "type": "string" }, "userName": { "type": "string" } }, "required": [ "userName", "hasPat", "instanceUrl", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "GitHub" ], "type": "string" }, "ghcrAuthEnabled": { "type": [ "boolean", "null" ] }, "hasPat": { "type": "boolean" }, "nameSpace": { "type": [ "string", "null" ] } }, "required": [ "hasPat", "$type" ], "type": "object" } ] }, "RegistryKind": { "enum": [ "Custom", "DockerHub", "Azure", "AWS", "Gitlab", "GitHub" ], "type": "string" }, "RegistryPatch": { "properties": { "configuration": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/RegistryConfigurationPatch" } ] }, "description": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] }, "registryHost": { "type": [ "string", "null" ] }, "status": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/RegistryStatus" } ] }, "tagIds": { "items": { "format": "uuid", "type": "string" }, "type": [ "array", "null" ] } }, "type": "object" }, "RegistrySpec": { "oneOf": [ { "properties": { "$type": { "enum": [ "Custom" ], "type": "string" }, "authEnabled": { "type": [ "boolean", "null" ] }, "password": { "type": [ "string", "null" ] }, "userName": { "type": [ "string", "null" ] } }, "required": [ "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "DockerHub" ], "type": "string" }, "pat": { "type": [ "string", "null" ] }, "userName": { "type": [ "string", "null" ] } }, "required": [ "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "Azure" ], "type": "string" }, "password": { "type": "string" }, "userName": { "type": "string" } }, "required": [ "userName", "password", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "AWS" ], "type": "string" }, "accessKey": { "type": "string" }, "authenticationRequired": { "type": [ "boolean", "null" ] }, "region": { "type": "string" }, "secretAccessKey": { "type": "string" } }, "required": [ "accessKey", "secretAccessKey", "region", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "Gitlab" ], "type": "string" }, "instanceUrl": { "type": "string" }, "pat": { "type": "string" }, "userName": { "type": "string" } }, "required": [ "userName", "pat", "instanceUrl", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "GitHub" ], "type": "string" }, "ghcrAuthEnabled": { "type": [ "boolean", "null" ] }, "nameSpace": { "type": [ "string", "null" ] }, "pat": { "type": [ "string", "null" ] } }, "required": [ "$type" ], "type": "object" } ] }, "RegistryStatus": { "enum": [ "Active", "Disabled", "Deprecated" ], "type": "string" }, "RegistryTagStatus": { "enum": [ "Active", "Inactive" ], "type": "string" }, "RegistryView": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "createdByActorId": { "format": "uuid", "type": "string" }, "description": { "type": [ "string", "null" ] }, "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "registryHost": { "type": "string" }, "status": { "$ref": "#/components/schemas/RegistryStatus" }, "tags": { "items": { "$ref": "#/components/schemas/resources.tags.TagSummary" }, "type": "array" }, "type": { "$ref": "#/components/schemas/RegistryKind" } }, "required": [ "id", "createdByActorId", "name", "status", "description", "registryHost", "type", "createdAt", "tags" ], "type": "object" }, "RenameAlertRuleInput": { "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "RenameBackupPolicyInput": { "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "RenameDeploymentInput": { "additionalProperties": false, "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "RenameInput": { "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "RenamePlatformInput": { "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "RenamePool": { "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "RenameResourceInput": { "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "RenameStackInput": { "additionalProperties": false, "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "RenameSwarmServiceInput": { "additionalProperties": false, "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "ReplaceResourceTagsInput": { "properties": { "tagIds": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "type": "object" }, "RepoCommand": { "properties": { "commands": { "items": { "type": "string" }, "type": "array" }, "path": { "type": "string" } }, "type": "object" }, "Repositories": { "properties": { "capabilities": { "$ref": "#/components/schemas/ResourceCapabilitiesView" }, "repositories": { "items": { "$ref": "#/components/schemas/BackupRepositoryView" }, "type": "array" } }, "required": [ "repositories", "capabilities" ], "type": "object" }, "RepositoryLocationInput": { "properties": { "location": { "$ref": "#/components/schemas/BackupExecutionLocation" }, "platformId": { "format": "uuid", "type": [ "string", "null" ] } }, "required": [ "location" ], "type": "object" }, "ResolveInput": { "properties": { "ids": { "items": { "format": "uuid", "type": "string" }, "type": "array" }, "resolutionNote": { "type": [ "string", "null" ] } }, "required": [ "ids" ], "type": "object" }, "ResourceBindingInput": { "properties": { "id": { "format": "uuid", "type": "string" }, "kind": { "$ref": "#/components/schemas/ResourceBindingKind" }, "name": { "type": "string" }, "secretDeliveryMode": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/SecretDeliveryMode" } ] }, "secretId": { "format": "uuid", "type": [ "string", "null" ] }, "targetPath": { "type": [ "string", "null" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "id", "name", "kind" ], "type": "object" }, "ResourceBindingKind": { "enum": [ "Variable", "Secret" ], "type": "string" }, "ResourceBindingScope": { "enum": [ "Global", "Stack", "Deployment", "SwarmService" ], "type": "string" }, "ResourceBindingSnapshot": { "properties": { "kind": { "$ref": "#/components/schemas/ResourceBindingKind" }, "name": { "type": "string" }, "scope": { "$ref": "#/components/schemas/ResourceBindingScope" }, "secretDeliveryMode": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/SecretDeliveryMode" } ] }, "secretId": { "format": "uuid", "type": [ "string", "null" ] }, "targetPath": { "type": [ "string", "null" ] }, "value": { "type": "string" } }, "required": [ "name", "kind", "scope", "value" ], "type": "object" }, "ResourceBindingView": { "properties": { "id": { "format": "uuid", "type": "string" }, "isInherited": { "type": "boolean" }, "kind": { "$ref": "#/components/schemas/ResourceBindingKind" }, "name": { "type": "string" }, "resourceId": { "format": "uuid", "type": [ "string", "null" ] }, "scope": { "$ref": "#/components/schemas/ResourceBindingScope" }, "secretDeliveryMode": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/SecretDeliveryMode" } ] }, "secretId": { "format": "uuid", "type": [ "string", "null" ] }, "targetPath": { "type": [ "string", "null" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "id", "name", "kind", "scope", "resourceId", "value", "secretId", "secretDeliveryMode", "targetPath", "isInherited" ], "type": "object" }, "ResourceBindingsView": { "properties": { "effectiveEntries": { "items": { "$ref": "#/components/schemas/ResourceBindingView" }, "type": "array" }, "entries": { "items": { "$ref": "#/components/schemas/ResourceBindingView" }, "type": "array" } }, "required": [ "entries", "effectiveEntries" ], "type": "object" }, "ResourceCapabilitiesView": { "properties": { "canExecute": { "type": "boolean" }, "canRead": { "type": "boolean" }, "canWrite": { "type": "boolean" } }, "required": [ "canRead", "canWrite", "canExecute" ], "type": "object" }, "ResourceControlState": { "enum": [ "Idle", "Queued", "Processing" ], "type": "string" }, "ResourceSpec": { "properties": { "memoryLimit": { "format": "float", "type": [ "number", "null" ] }, "nanoCpus": { "format": "float", "type": [ "number", "null" ] } }, "type": "object" }, "ResourceTagsResponse": { "properties": { "tags": { "items": { "$ref": "#/components/schemas/resources.tags.TagSummary" }, "type": "array" } }, "required": [ "tags" ], "type": "object" }, "ResourceType": { "enum": [ "Platform", "Deployment", "Stack", "Registry", "GitRepository", "GitAccount", "Alert", "AlertChannel", "User", "Team", "Role", "Binding", "Tag", "AutomationAction", "License", "BackupRepository", "BackupPolicy", "Volume", "Build", "BuildAgentPool", "SwarmService", "ServiceAccount" ], "type": "string" }, "RestartCondition": { "enum": [ "None", "OnFailure", "Any" ], "type": "string" }, "RestoreInput": { "properties": { "overwriteExisting": { "type": "boolean" }, "sourceBackupRunItemId": { "format": "uuid", "type": [ "string", "null" ] }, "targetDockerNodeId": { "type": [ "string", "null" ] }, "targetPlatformId": { "format": "uuid", "type": "string" }, "targetVolumeName": { "type": "string" } }, "required": [ "targetPlatformId", "targetVolumeName", "overwriteExisting" ], "type": "object" }, "Restores": { "properties": { "runs": { "items": { "$ref": "#/components/schemas/BackupRestoreRunView" }, "type": "array" } }, "required": [ "runs" ], "type": "object" }, "RoleActivitySnapshot": { "properties": { "permissions": { "items": { "$ref": "#/components/schemas/RolePermissionActivitySnapshot" }, "type": "array" }, "roleType": { "type": "string" } }, "required": [ "roleType", "permissions" ], "type": "object" }, "RolePermissionActivitySnapshot": { "properties": { "permissionLevel": { "$ref": "#/components/schemas/PermissionLevel" }, "resourceType": { "$ref": "#/components/schemas/ResourceType" }, "specificPermissions": { "format": "int32", "type": "integer" } }, "required": [ "resourceType", "permissionLevel", "specificPermissions" ], "type": "object" }, "RollbackStackInput": { "additionalProperties": false, "properties": { "releaseId": { "format": "uuid", "type": "string" }, "stackId": { "format": "uuid", "type": "string" } }, "required": [ "stackId", "releaseId" ], "type": "object" }, "Rules": { "properties": { "alertRules": { "items": { "$ref": "#/components/schemas/AlertRuleListItem" }, "type": "array" }, "capabilities": { "$ref": "#/components/schemas/ResourceCapabilitiesView" } }, "required": [ "capabilities", "alertRules" ], "type": "object" }, "RunInput": { "properties": { "argsJson": {}, "code": { "type": [ "string", "null" ] }, "timeoutSeconds": { "format": "int32", "type": [ "integer", "null" ] } }, "type": "object" }, "RunList": { "properties": { "runs": { "items": { "$ref": "#/components/schemas/AutomationRunView" }, "type": "array" } }, "required": [ "runs" ], "type": "object" }, "RuntimeConfigFrom": { "properties": { "network": { "type": "string" } }, "required": [ "network" ], "type": "object" }, "RuntimeIpam": { "properties": { "config": { "items": { "$ref": "#/components/schemas/RuntimeIpamConfig" }, "type": "array" }, "driver": { "type": "string" }, "options": { "additionalProperties": { "type": "string" }, "propertyNames": { "type": "string" }, "type": "object" } }, "required": [ "driver" ], "type": "object" }, "RuntimeIpamConfig": { "properties": { "gateway": { "type": [ "string", "null" ] }, "ipRange": { "type": [ "string", "null" ] }, "subnet": { "type": [ "string", "null" ] } }, "type": "object" }, "RuntimeSwarmPeer": { "properties": { "address": { "type": "string" }, "nodeId": { "type": "string" } }, "required": [ "nodeId", "address" ], "type": "object" }, "S3BucketLookup": { "enum": [ "Auto", "Path", "Dns" ], "type": "string" }, "ScaleSwarmServiceInput": { "additionalProperties": false, "properties": { "replicas": { "format": "int32", "type": "integer" } }, "required": [ "replicas" ], "type": "object" }, "SchedulingMode": { "enum": [ "Replicated", "Global" ], "type": "string" }, "SecretDefinitionView": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "externalKey": { "type": [ "string", "null" ] }, "externalPath": { "type": [ "string", "null" ] }, "externalVersion": { "format": "int32", "type": [ "integer", "null" ] }, "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "providerId": { "format": "uuid", "type": [ "string", "null" ] }, "providerType": { "$ref": "#/components/schemas/SecretProviderType" } }, "required": [ "id", "name", "providerType", "providerId", "externalPath", "externalKey", "externalVersion", "createdAt" ], "type": "object" }, "SecretDefinitionsResponse": { "properties": { "capabilities": { "$ref": "#/components/schemas/ResourceCapabilitiesView" }, "secrets": { "items": { "$ref": "#/components/schemas/SecretDefinitionView" }, "type": "array" } }, "required": [ "secrets", "capabilities" ], "type": "object" }, "SecretDeliveryMode": { "enum": [ "EnvironmentVariable", "MountedFile", "NativePlatformSecret" ], "type": "string" }, "SecretProviderInput": { "properties": { "address": { "type": "string" }, "mountPath": { "type": "string" }, "name": { "type": "string" }, "token": { "type": "string" } }, "required": [ "name", "address", "mountPath", "token" ], "type": "object" }, "SecretProviderPatch": { "properties": { "address": { "type": [ "string", "null" ] }, "mountPath": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] }, "token": { "type": [ "string", "null" ] } }, "type": "object" }, "SecretProviderType": { "enum": [ "InternalEncrypted", "VaultCompatibleKvV2" ], "type": "string" }, "SecretProviderView": { "properties": { "address": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "mountPath": { "type": "string" }, "name": { "type": "string" }, "providerType": { "$ref": "#/components/schemas/SecretProviderType" } }, "required": [ "id", "name", "providerType", "address", "mountPath", "createdAt" ], "type": "object" }, "SecretProvidersResponse": { "properties": { "providers": { "items": { "$ref": "#/components/schemas/SecretProviderView" }, "type": "array" } }, "required": [ "providers" ], "type": "object" }, "SecretTestResult": { "properties": { "message": { "type": "string" }, "success": { "type": "boolean" } }, "required": [ "success", "message" ], "type": "object" }, "SelfManagedVmBuildAgentPoolProviderSpec": { "properties": { "architecture": { "$ref": "#/components/schemas/CpuArchitecture" }, "connectionMode": { "$ref": "#/components/schemas/BuildAgentPoolConnectionMode" }, "endpoint": { "type": [ "string", "null" ] }, "labels": { "items": { "type": "string" }, "type": [ "array", "null" ] }, "maxWorkers": { "format": "int32", "type": "integer" }, "registrationSecretId": { "format": "uuid", "type": [ "string", "null" ] } }, "type": "object" }, "ServiceAccountActivitySnapshot": { "properties": { "description": { "type": [ "string", "null" ] }, "id": { "format": "uuid", "type": "string" }, "isEnabled": { "type": "boolean" }, "name": { "type": "string" }, "resourceAccesses": { "items": { "$ref": "#/components/schemas/ServiceAccountResourceAccessSnapshot" }, "type": "array" }, "roleIds": { "items": { "format": "uuid", "type": "string" }, "type": "array" }, "teamIds": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "required": [ "id", "name", "isEnabled", "teamIds", "roleIds", "resourceAccesses" ], "type": "object" }, "ServiceAccountResourceAccessSnapshot": { "properties": { "permissionLevel": { "$ref": "#/components/schemas/PermissionLevel" }, "resourceId": { "format": "uuid", "type": "string" }, "resourceType": { "$ref": "#/components/schemas/ResourceType" }, "specificPermissions": { "format": "int32", "type": "integer" } }, "required": [ "resourceType", "resourceId", "permissionLevel", "specificPermissions" ], "type": "object" }, "ServiceInspectionView": { "properties": { "configIds": { "items": { "type": "string" }, "type": "array" }, "createdAt": { "format": "date-time", "type": [ "string", "null" ] }, "desiredTaskCount": { "format": "int32", "type": "integer" }, "id": { "type": "string" }, "image": { "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, "propertyNames": { "type": "string" }, "type": "object" }, "mode": { "type": "string" }, "name": { "type": "string" }, "networkIds": { "items": { "type": "string" }, "type": "array" }, "ports": { "items": { "type": "string" }, "type": "array" }, "runningTaskCount": { "format": "int32", "type": "integer" }, "secretIds": { "items": { "type": "string" }, "type": "array" }, "updateMessage": { "type": [ "string", "null" ] }, "updateState": { "type": "string" }, "updatedAt": { "format": "date-time", "type": [ "string", "null" ] }, "versionIndex": { "format": "int64", "minimum": 0, "type": "integer" } }, "required": [ "id", "versionIndex", "name", "mode", "image", "runningTaskCount", "desiredTaskCount", "updateState", "ports", "networkIds", "secretIds", "configIds", "labels" ], "type": "object" }, "ServiceMetadataInput": { "properties": { "description": { "type": [ "string", "null" ] } }, "type": "object" }, "ServiceStatistics": { "properties": { "complete": { "type": "boolean" }, "dockerServiceId": { "type": "string" }, "expectedTasks": { "minimum": 0, "type": "integer" }, "missingDockerNodeIds": { "items": { "type": "string" }, "type": "array" }, "newestSampleAt": { "format": "date-time", "type": [ "string", "null" ] }, "observedContainerProjectionIds": { "items": { "format": "uuid", "type": "string" }, "type": "array" }, "observedTasks": { "minimum": 0, "type": "integer" }, "oldestSampleAt": { "format": "date-time", "type": [ "string", "null" ] }, "stats": { "items": { "$ref": "#/components/schemas/ContainerStatSnapshot" }, "type": "array" } }, "required": [ "dockerServiceId", "observedTasks", "expectedTasks", "complete", "observedContainerProjectionIds", "missingDockerNodeIds", "stats" ], "type": "object" }, "StackActivitySnapshot": { "properties": { "description": { "type": [ "string", "null" ] }, "driftPolicy": {}, "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "stackRelease": {}, "stackSource": { "type": "string" } }, "required": [ "id", "name", "stackSource", "driftPolicy" ], "type": "object" }, "StackAdoptionIssue": { "properties": { "code": { "type": "string" }, "fieldPath": { "type": [ "string", "null" ] }, "message": { "type": "string" }, "severity": { "type": "string" } }, "required": [ "code", "message", "severity", "fieldPath" ], "type": "object" }, "StackApplyEventType": { "enum": [ "Unknown", "StdOut", "StdErr", "SystemMessage", "CommandCompleted" ], "type": "string" }, "StackBuildImageBinding": { "additionalProperties": false, "properties": { "appliedAt": { "format": "date-time", "type": [ "string", "null" ] }, "appliedBuildRunId": { "format": "uuid", "type": [ "string", "null" ] }, "appliedDigest": { "type": [ "string", "null" ] }, "appliedImageReference": { "type": [ "string", "null" ] }, "buildProjectId": { "format": "uuid", "type": "string" }, "redeployOnBuild": { "type": "boolean" }, "resolvedBuildRunId": { "format": "uuid", "type": [ "string", "null" ] }, "resolvedDigest": { "type": [ "string", "null" ] }, "resolvedImageReference": { "type": [ "string", "null" ] }, "serviceName": { "type": "string" } }, "required": [ "serviceName", "buildProjectId" ], "type": "object" }, "StackCapabilities": { "properties": { "canApply": { "type": "boolean" }, "canDelete": { "type": "boolean" }, "canExecute": { "type": "boolean" }, "canInspect": { "type": "boolean" }, "canOpenTerminal": { "type": "boolean" }, "canPull": { "type": "boolean" }, "canRead": { "type": "boolean" }, "canViewLogs": { "type": "boolean" }, "canViewReleases": { "type": "boolean" }, "canViewResourceBindings": { "type": "boolean" }, "canWrite": { "type": "boolean" } }, "required": [ "canRead", "canWrite", "canExecute", "canDelete", "canViewLogs", "canInspect", "canOpenTerminal", "canPull", "canApply", "canViewResourceBindings", "canViewReleases" ], "type": "object" }, "StackCommand": { "additionalProperties": false, "properties": { "commands": { "items": { "type": "string" }, "type": "array" }, "path": { "type": "string" } }, "type": "object" }, "StackConfigView": { "properties": { "description": { "type": [ "string", "null" ] }, "driftPolicy": { "$ref": "#/components/schemas/StackDriftPolicy" }, "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "platformId": { "format": "uuid", "type": "string" }, "platformType": { "$ref": "#/components/schemas/PlatformType" }, "rowVersion": { "format": "int64", "type": "integer" }, "spec": { "$ref": "#/components/schemas/StackSpec" }, "stackSource": { "$ref": "#/components/schemas/StackSource" }, "stackUpdateState": { "$ref": "#/components/schemas/StackUpdateState" } }, "required": [ "id", "name", "platformId", "platformType", "description", "stackSource", "spec", "stackUpdateState", "driftPolicy", "rowVersion" ], "type": "object" }, "StackDrift": { "oneOf": [ { "properties": { "$type": { "enum": [ "MissingContainer" ], "type": "string" }, "serviceName": { "type": "string" } }, "required": [ "serviceName", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "ExtraContainer" ], "type": "string" }, "containerId": { "type": "string" }, "serviceName": { "type": "string" } }, "required": [ "containerId", "serviceName", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "ContainerStopped" ], "type": "string" }, "containerId": { "type": "string" }, "serviceName": { "type": "string" } }, "required": [ "containerId", "serviceName", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "ContainerPaused" ], "type": "string" }, "containerId": { "type": "string" }, "serviceName": { "type": "string" } }, "required": [ "containerId", "serviceName", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "ContainerUnhealthy" ], "type": "string" }, "containerId": { "type": "string" }, "healthStatus": { "type": [ "string", "null" ] }, "serviceName": { "type": "string" } }, "required": [ "containerId", "serviceName", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "ImageMismatch" ], "type": "string" }, "actualImage": { "type": "string" }, "expectedImage": { "type": "string" }, "serviceName": { "type": "string" } }, "required": [ "serviceName", "expectedImage", "actualImage", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "ConfigHashMismatch" ], "type": "string" }, "actualHash": { "type": [ "string", "null" ] }, "expectedHash": { "type": [ "string", "null" ] }, "serviceName": { "type": "string" } }, "required": [ "serviceName", "$type" ], "type": "object" } ] }, "StackDriftMode": { "enum": [ "Disabled", "DetectOnly", "AutoFix" ], "type": "string" }, "StackDriftPolicy": { "properties": { "alertOnDrift": { "type": "boolean" }, "autoResumePausedContainers": { "type": "boolean" }, "autoStartStoppedContainers": { "type": "boolean" }, "markDegraded": { "type": "boolean" }, "mode": { "$ref": "#/components/schemas/StackDriftMode" }, "removeExtraContainers": { "type": "boolean" } }, "required": [ "mode", "alertOnDrift", "markDegraded", "autoStartStoppedContainers", "autoResumePausedContainers", "removeExtraContainers" ], "type": "object" }, "StackDriftPolicyInput": { "additionalProperties": false, "properties": { "alertOnDrift": { "type": [ "boolean", "null" ] }, "autoResumePausedContainers": { "type": [ "boolean", "null" ] }, "autoStartStoppedContainers": { "type": [ "boolean", "null" ] }, "markDegraded": { "type": [ "boolean", "null" ] }, "mode": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/StackDriftMode" } ] }, "removeExtraContainers": { "type": [ "boolean", "null" ] } }, "type": "object" }, "StackDriftReport": { "properties": { "drifts": { "items": { "$ref": "#/components/schemas/StackDrift" }, "type": "array" }, "hasAutoFixableDrift": { "type": "boolean" }, "hasDrift": { "type": "boolean" }, "hasStructuralDrift": { "type": "boolean" }, "platformId": { "format": "uuid", "type": "string" }, "stackId": { "format": "uuid", "type": "string" } }, "required": [ "stackId", "platformId", "hasDrift", "hasAutoFixableDrift", "hasStructuralDrift", "drifts" ], "type": "object" }, "StackDuplicateDraftView": { "properties": { "draft": { "$ref": "#/components/schemas/CreateStackInput" }, "warnings": { "items": { "$ref": "#/components/schemas/DuplicateDraftWarning" }, "type": "array" } }, "required": [ "draft", "warnings" ], "type": "object" }, "StackHistory": { "properties": { "containers": { "items": { "$ref": "#/components/schemas/ContainerHistory" }, "type": "array" } }, "required": [ "containers" ], "type": "object" }, "StackImportKind": { "enum": [ "ComposeProject", "SwarmStack" ], "type": "string" }, "StackReconciliationAction": { "properties": { "action": { "$ref": "#/components/schemas/StackReconciliationActionType" }, "containerId": { "type": "string" }, "errorMessage": { "type": [ "string", "null" ] }, "serviceName": { "type": "string" }, "succeeded": { "type": "boolean" } }, "required": [ "containerId", "serviceName", "action", "succeeded", "errorMessage" ], "type": "object" }, "StackReconciliationActionType": { "enum": [ "StartContainer", "ResumeContainer", "RemoveContainer" ], "type": "string" }, "StackReconciliationResult": { "properties": { "actions": { "items": { "$ref": "#/components/schemas/StackReconciliationAction" }, "type": "array" }, "afterReport": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/StackDriftReport" } ] }, "beforeReport": { "$ref": "#/components/schemas/StackDriftReport" }, "stackId": { "format": "uuid", "type": "string" }, "status": { "$ref": "#/components/schemas/StackReconciliationStatus" } }, "required": [ "stackId", "status", "beforeReport", "afterReport", "actions" ], "type": "object" }, "StackReconciliationStatus": { "enum": [ "NoDrift", "Reconciled", "Partial", "RequiresReapply", "Disabled", "Failed" ], "type": "string" }, "StackReleaseSource": { "properties": { "branch": { "type": [ "string", "null" ] }, "composeDigest": { "type": [ "string", "null" ] }, "composeEnvFilesFromRepo": { "items": { "type": "string" }, "type": [ "array", "null" ] }, "composePaths": { "items": { "type": "string" }, "type": "array" }, "envFilePaths": { "items": { "type": "string" }, "type": "array" }, "gitRepositoryId": { "format": "uuid", "type": [ "string", "null" ] }, "gitRepositoryName": { "type": [ "string", "null" ] }, "gitRepositoryUrl": { "type": [ "string", "null" ] }, "requestedCommitSha": { "type": [ "string", "null" ] }, "resolvedCommitSha": { "type": "string" }, "sourceType": { "$ref": "#/components/schemas/StackSource" }, "watchPaths": { "items": { "type": "string" }, "type": [ "array", "null" ] }, "workingDirectory": { "type": [ "string", "null" ] } }, "required": [ "sourceType", "resolvedCommitSha" ], "type": "object" }, "StackReleaseStatus": { "enum": [ "Unknown", "Created", "Applying", "Healthy", "Pending", "Paused", "Degraded", "Failed", "Stopped", "TimedOut" ], "type": "string" }, "StackReleaseView": { "properties": { "actorName": { "type": "string" }, "actorType": { "$ref": "#/components/schemas/ActorType" }, "createdAt": { "format": "date-time", "type": "string" }, "createdByActorId": { "format": "uuid", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "platformId": { "format": "uuid", "type": "string" }, "platformName": { "type": [ "string", "null" ] }, "platformStatus": { "$ref": "#/components/schemas/PlatformStatus" }, "resourceBindings": { "items": { "$ref": "#/components/schemas/ResourceBindingSnapshot" }, "type": [ "array", "null" ] }, "source": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/StackReleaseSource" } ] }, "spec": { "$ref": "#/components/schemas/StackSpec" }, "stackId": { "format": "uuid", "type": "string" }, "status": { "$ref": "#/components/schemas/StackReleaseStatus" }, "version": { "type": "string" } }, "required": [ "id", "stackId", "platformId", "status", "version", "spec", "createdAt", "createdByActorId", "actorName", "actorType", "platformStatus" ], "type": "object" }, "StackReleasesView": { "properties": { "releases": { "items": { "$ref": "#/components/schemas/StackReleaseView" }, "type": "array" } }, "required": [ "releases" ], "type": "object" }, "StackResultActivitySnapshot": { "properties": { "containerIds": { "items": { "type": "string" }, "type": [ "array", "null" ] }, "message": { "type": [ "string", "null" ] }, "resourceBindings": {} }, "type": "object" }, "StackSource": { "enum": [ "WebEditor", "Git" ], "type": "string" }, "StackSpec": { "oneOf": [ { "allOf": [ { "$ref": "#/components/schemas/StackSpecCommon" }, { "properties": { "composeFile": { "type": "string" }, "updateBehavior": { "$ref": "#/components/schemas/StackUpdateBehavior" } }, "required": [ "composeFile" ], "type": "object" }, { "properties": { "$type": { "enum": [ "WebEditor" ], "type": "string" } }, "required": [ "$type" ], "type": "object" } ] }, { "allOf": [ { "$ref": "#/components/schemas/StackSpecCommon" }, { "properties": { "additionalEnvFileFromRepo": { "items": { "type": "string" }, "type": "array" }, "branch": { "type": "string" }, "commitSha": { "type": [ "string", "null" ] }, "composeEnvFilesFromRepo": { "items": { "type": "string" }, "type": "array" }, "composePaths": { "items": { "type": "string" }, "type": "array" }, "gitRepoId": { "format": "uuid", "type": "string" }, "updateBehavior": { "$ref": "#/components/schemas/StackUpdateBehavior" }, "watchPaths": { "items": { "type": "string" }, "type": "array" }, "webhook": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/StackWebhookConfig" } ] }, "workingDirectory": { "type": [ "string", "null" ] } }, "required": [ "gitRepoId", "branch" ], "type": "object" }, { "properties": { "$type": { "enum": [ "Git" ], "type": "string" } }, "required": [ "$type" ], "type": "object" } ] } ] }, "StackSpecCommon": { "additionalProperties": false, "properties": { "buildImageBindings": { "items": { "$ref": "#/components/schemas/StackBuildImageBinding" }, "type": "array" }, "destroyBeforeDeploy": { "type": "boolean" }, "envFilePath": { "type": [ "string", "null" ] }, "postDeploy": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/StackCommand" } ] }, "preDeploy": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/StackCommand" } ] }, "projectName": { "type": [ "string", "null" ] }, "registryId": { "format": "uuid", "type": [ "string", "null" ] } }, "type": "object" }, "StackStreamItem": { "properties": { "exitCode": { "format": "int32", "type": [ "integer", "null" ] }, "message": { "type": [ "string", "null" ] }, "progressMessage": { "type": [ "string", "null" ] }, "severity": { "type": [ "string", "null" ] }, "stackStatus": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/StackReleaseStatus" } ] }, "type": { "$ref": "#/components/schemas/StackApplyEventType" } }, "required": [ "type" ], "type": "object" }, "StackUpdateBehavior": { "enum": [ "Disabled", "Notify", "ServiceAutoDeploy", "StackAutoDeploy" ], "type": "string" }, "StackUpdateState": { "oneOf": [ { "properties": { "$type": { "enum": [ "WebEditor" ], "type": "string" }, "recreateStackOnNewImageState": { "$ref": "#/components/schemas/RecreateStackOnNewImageState" } }, "required": [ "recreateStackOnNewImageState", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "Git" ], "type": "string" }, "recreateStackOnNewCommitState": { "$ref": "#/components/schemas/RecreateStackOnNewCommitState" }, "recreateStackOnNewImageState": { "$ref": "#/components/schemas/RecreateStackOnNewImageState" } }, "required": [ "recreateStackOnNewImageState", "recreateStackOnNewCommitState", "$type" ], "type": "object" } ] }, "StackView": { "properties": { "capabilities": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/StackCapabilities" } ] }, "controlState": { "$ref": "#/components/schemas/ResourceControlState" }, "createdAt": { "format": "date-time", "type": "string" }, "createdByActorId": { "format": "uuid", "type": "string" }, "currentStackReleaseId": { "format": "uuid", "type": "string" }, "description": { "type": [ "string", "null" ] }, "driftPolicy": { "$ref": "#/components/schemas/StackDriftPolicy" }, "id": { "format": "uuid", "type": "string" }, "latestActivityView": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/LatestActivityView" } ] }, "name": { "type": "string" }, "platformId": { "format": "uuid", "type": [ "string", "null" ] }, "platformName": { "type": [ "string", "null" ] }, "platformStatus": { "$ref": "#/components/schemas/PlatformStatus" }, "platformType": { "$ref": "#/components/schemas/PlatformType" }, "resourceBindings": { "items": { "$ref": "#/components/schemas/ResourceBindingSnapshot" }, "type": [ "array", "null" ] }, "rowVersion": { "format": "int64", "type": "integer" }, "source": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/StackReleaseSource" } ] }, "spec": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/StackSpec" } ] }, "stackSource": { "$ref": "#/components/schemas/StackSource" }, "stackUpdateState": { "$ref": "#/components/schemas/StackUpdateState" }, "status": { "$ref": "#/components/schemas/StackReleaseStatus" }, "tags": { "items": { "$ref": "#/components/schemas/resources.tags.TagSummary" }, "type": "array" }, "version": { "type": [ "string", "null" ] } }, "required": [ "id", "name", "description", "stackSource", "stackUpdateState", "driftPolicy", "status", "createdAt", "createdByActorId", "controlState", "currentStackReleaseId", "platformType", "platformId", "version", "spec", "source", "resourceBindings", "platformStatus", "platformName", "tags", "latestActivityView", "capabilities", "rowVersion" ], "type": "object" }, "StackWebhookConfig": { "allOf": [ { "$ref": "#/components/schemas/WebhookConfig" }, { "properties": { "forceDeploy": { "type": "boolean" } }, "type": "object" } ] }, "StacksView": { "properties": { "capabilities": { "$ref": "#/components/schemas/ResourceCapabilitiesView" }, "stacks": { "items": { "$ref": "#/components/schemas/StackView" }, "type": "array" } }, "required": [ "stacks", "capabilities" ], "type": "object" }, "StatsHours": { "default": 24, "enum": [ 24, 48, 72 ], "type": "integer" }, "StopSignal": { "enum": [ "SIGTERM", "SIGKILL", "SIGINT", "SIGQUIT" ], "type": "string" }, "SwarmConfigView": { "properties": { "capabilities": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PlatformCapabilitiesView" } ] }, "createdAt": { "format": "date-time", "type": [ "string", "null" ] }, "id": { "type": "string" }, "inUse": { "type": "boolean" }, "isStale": { "type": "boolean" }, "labels": { "additionalProperties": { "type": "string" }, "propertyNames": { "type": "string" }, "type": "object" }, "name": { "type": "string" }, "observedAt": { "format": "date-time", "type": "string" }, "serviceNames": { "items": { "type": "string" }, "type": "array" }, "templatingDriver": { "type": [ "string", "null" ] }, "updatedAt": { "format": "date-time", "type": [ "string", "null" ] }, "versionIndex": { "format": "int64", "type": "integer" } }, "required": [ "id", "versionIndex", "name", "templatingDriver", "serviceNames", "labels", "createdAt", "updatedAt", "observedAt", "isStale", "inUse", "capabilities" ], "type": "object" }, "SwarmItemsResponse_SwarmConfigView": { "properties": { "capabilities": { "$ref": "#/components/schemas/PlatformCapabilitiesView" }, "items": { "items": { "properties": { "capabilities": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PlatformCapabilitiesView" } ] }, "createdAt": { "format": "date-time", "type": [ "string", "null" ] }, "id": { "type": "string" }, "inUse": { "type": "boolean" }, "isStale": { "type": "boolean" }, "labels": { "additionalProperties": { "type": "string" }, "propertyNames": { "type": "string" }, "type": "object" }, "name": { "type": "string" }, "observedAt": { "format": "date-time", "type": "string" }, "serviceNames": { "items": { "type": "string" }, "type": "array" }, "templatingDriver": { "type": [ "string", "null" ] }, "updatedAt": { "format": "date-time", "type": [ "string", "null" ] }, "versionIndex": { "format": "int64", "type": "integer" } }, "required": [ "id", "versionIndex", "name", "templatingDriver", "serviceNames", "labels", "createdAt", "updatedAt", "observedAt", "isStale", "inUse", "capabilities" ], "type": "object" }, "type": "array" } }, "required": [ "items", "capabilities" ], "type": "object" }, "SwarmItemsResponse_SwarmNetworkView": { "properties": { "capabilities": { "$ref": "#/components/schemas/PlatformCapabilitiesView" }, "items": { "items": { "properties": { "capabilities": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PlatformCapabilitiesView" } ] }, "createdAt": { "format": "date-time", "type": [ "string", "null" ] }, "driver": { "type": "string" }, "enableIPv6": { "type": "boolean" }, "id": { "type": "string" }, "isAttachable": { "type": "boolean" }, "isEncrypted": { "type": "boolean" }, "isIngress": { "type": "boolean" }, "isInternal": { "type": "boolean" }, "isStale": { "type": "boolean" }, "labels": { "additionalProperties": { "type": "string" }, "propertyNames": { "type": "string" }, "type": "object" }, "name": { "type": "string" }, "observedAt": { "format": "date-time", "type": "string" }, "scope": { "type": "string" }, "serviceNames": { "items": { "type": "string" }, "type": "array" }, "subnets": { "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "name", "scope", "driver", "isAttachable", "isInternal", "isIngress", "isEncrypted", "enableIPv6", "subnets", "serviceNames", "labels", "createdAt", "observedAt", "isStale", "capabilities" ], "type": "object" }, "type": "array" } }, "required": [ "items", "capabilities" ], "type": "object" }, "SwarmItemsResponse_SwarmNodeView": { "properties": { "capabilities": { "$ref": "#/components/schemas/PlatformCapabilitiesView" }, "items": { "items": { "properties": { "address": { "type": "string" }, "architecture": { "type": "string" }, "availability": { "type": "string" }, "capabilities": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PlatformCapabilitiesView" } ] }, "createdAt": { "format": "date-time", "type": [ "string", "null" ] }, "desiredTaskCount": { "format": "int32", "type": "integer" }, "engineVersion": { "type": "string" }, "hostname": { "type": "string" }, "id": { "type": "string" }, "isLeader": { "type": "boolean" }, "isStale": { "type": "boolean" }, "labels": { "additionalProperties": { "type": "string" }, "propertyNames": { "type": "string" }, "type": "object" }, "observedAt": { "format": "date-time", "type": "string" }, "operatingSystem": { "type": "string" }, "reachability": { "type": "string" }, "role": { "type": "string" }, "runningTaskCount": { "format": "int32", "type": "integer" }, "status": { "type": "string" }, "statusMessage": { "type": [ "string", "null" ] }, "updatedAt": { "format": "date-time", "type": [ "string", "null" ] }, "versionIndex": { "format": "int64", "type": "integer" } }, "required": [ "id", "versionIndex", "hostname", "role", "isLeader", "reachability", "status", "statusMessage", "availability", "engineVersion", "operatingSystem", "architecture", "address", "labels", "runningTaskCount", "desiredTaskCount", "createdAt", "updatedAt", "observedAt", "isStale", "capabilities" ], "type": "object" }, "type": "array" } }, "required": [ "items", "capabilities" ], "type": "object" }, "SwarmItemsResponse_SwarmSecretView": { "properties": { "capabilities": { "$ref": "#/components/schemas/PlatformCapabilitiesView" }, "items": { "items": { "properties": { "capabilities": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PlatformCapabilitiesView" } ] }, "createdAt": { "format": "date-time", "type": [ "string", "null" ] }, "driver": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "inUse": { "type": "boolean" }, "isStale": { "type": "boolean" }, "labels": { "additionalProperties": { "type": "string" }, "propertyNames": { "type": "string" }, "type": "object" }, "name": { "type": "string" }, "observedAt": { "format": "date-time", "type": "string" }, "serviceNames": { "items": { "type": "string" }, "type": "array" }, "updatedAt": { "format": "date-time", "type": [ "string", "null" ] }, "versionIndex": { "format": "int64", "type": "integer" } }, "required": [ "id", "versionIndex", "name", "driver", "serviceNames", "labels", "createdAt", "updatedAt", "observedAt", "isStale", "inUse", "capabilities" ], "type": "object" }, "type": "array" } }, "required": [ "items", "capabilities" ], "type": "object" }, "SwarmItemsResponse_SwarmServiceView": { "properties": { "capabilities": { "$ref": "#/components/schemas/PlatformCapabilitiesView" }, "items": { "items": { "properties": { "capabilities": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PlatformCapabilitiesView" } ] }, "configIds": { "items": { "type": "string" }, "type": "array" }, "createdAt": { "format": "date-time", "type": [ "string", "null" ] }, "desiredTaskCount": { "format": "int32", "type": "integer" }, "dockerStackNamespace": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "image": { "type": "string" }, "isStale": { "type": "boolean" }, "labels": { "additionalProperties": { "type": "string" }, "propertyNames": { "type": "string" }, "type": "object" }, "mode": { "type": "string" }, "name": { "type": "string" }, "networkIds": { "items": { "type": "string" }, "type": "array" }, "observedAt": { "format": "date-time", "type": "string" }, "ownership": { "$ref": "#/components/schemas/SwarmServiceOwnership" }, "ownershipDiagnostic": { "type": [ "string", "null" ] }, "ports": { "items": { "type": "string" }, "type": "array" }, "runningTaskCount": { "format": "int32", "type": "integer" }, "secretIds": { "items": { "type": "string" }, "type": "array" }, "stackId": { "format": "uuid", "type": [ "string", "null" ] }, "swarmServiceId": { "format": "uuid", "type": [ "string", "null" ] }, "updateMessage": { "type": [ "string", "null" ] }, "updateState": { "type": "string" }, "updatedAt": { "format": "date-time", "type": [ "string", "null" ] }, "versionIndex": { "format": "int64", "type": "integer" } }, "required": [ "id", "versionIndex", "name", "mode", "image", "runningTaskCount", "desiredTaskCount", "updateState", "updateMessage", "ports", "networkIds", "secretIds", "configIds", "labels", "ownership", "dockerStackNamespace", "ownershipDiagnostic", "stackId", "swarmServiceId", "createdAt", "updatedAt", "observedAt", "isStale", "capabilities" ], "type": "object" }, "type": "array" } }, "required": [ "items", "capabilities" ], "type": "object" }, "SwarmItemsResponse_SwarmTaskView": { "properties": { "capabilities": { "$ref": "#/components/schemas/PlatformCapabilitiesView" }, "items": { "items": { "properties": { "capabilities": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PlatformCapabilitiesView" } ] }, "createdAt": { "format": "date-time", "type": [ "string", "null" ] }, "desiredState": { "type": "string" }, "error": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "image": { "type": "string" }, "isStale": { "type": "boolean" }, "name": { "type": "string" }, "nodeHostname": { "type": "string" }, "nodeId": { "type": "string" }, "observedAt": { "format": "date-time", "type": "string" }, "ports": { "items": { "type": "string" }, "type": "array" }, "serviceId": { "type": "string" }, "serviceName": { "type": "string" }, "slot": { "format": "int32", "type": [ "integer", "null" ] }, "state": { "type": "string" }, "statusMessage": { "type": [ "string", "null" ] }, "statusTimestamp": { "format": "date-time", "type": [ "string", "null" ] }, "updatedAt": { "format": "date-time", "type": [ "string", "null" ] }, "versionIndex": { "format": "int64", "type": "integer" } }, "required": [ "id", "versionIndex", "name", "serviceId", "serviceName", "slot", "nodeId", "nodeHostname", "desiredState", "state", "statusMessage", "error", "image", "ports", "statusTimestamp", "createdAt", "updatedAt", "observedAt", "isStale", "capabilities" ], "type": "object" }, "type": "array" } }, "required": [ "items", "capabilities" ], "type": "object" }, "SwarmNetworkView": { "properties": { "capabilities": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PlatformCapabilitiesView" } ] }, "createdAt": { "format": "date-time", "type": [ "string", "null" ] }, "driver": { "type": "string" }, "enableIPv6": { "type": "boolean" }, "id": { "type": "string" }, "isAttachable": { "type": "boolean" }, "isEncrypted": { "type": "boolean" }, "isIngress": { "type": "boolean" }, "isInternal": { "type": "boolean" }, "isStale": { "type": "boolean" }, "labels": { "additionalProperties": { "type": "string" }, "propertyNames": { "type": "string" }, "type": "object" }, "name": { "type": "string" }, "observedAt": { "format": "date-time", "type": "string" }, "scope": { "type": "string" }, "serviceNames": { "items": { "type": "string" }, "type": "array" }, "subnets": { "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "name", "scope", "driver", "isAttachable", "isInternal", "isIngress", "isEncrypted", "enableIPv6", "subnets", "serviceNames", "labels", "createdAt", "observedAt", "isStale", "capabilities" ], "type": "object" }, "SwarmNodeAgentCoverage": { "properties": { "agentImageDigest": { "type": [ "string", "null" ] }, "agentImageReference": { "type": [ "string", "null" ] }, "canManageNodeAgents": { "type": "boolean" }, "connectedNodes": { "minimum": 0, "type": "integer" }, "coveredNodes": { "minimum": 0, "type": "integer" }, "eligibleNodes": { "minimum": 0, "type": "integer" }, "enrollingNodes": { "minimum": 0, "type": "integer" }, "enrollmentExpiresAtUtc": { "format": "date-time", "type": [ "string", "null" ] }, "incompatibleNodes": { "minimum": 0, "type": "integer" }, "isInstalled": { "type": "boolean" }, "lastMembershipReconciliationAtUtc": { "format": "date-time", "type": [ "string", "null" ] }, "missingNodes": { "minimum": 0, "type": "integer" }, "nodes": { "items": { "$ref": "#/components/schemas/NodeAgentCoverage" }, "type": "array" }, "offlineNodes": { "minimum": 0, "type": "integer" }, "operation": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/NodeAgentOperation" } ] }, "reasons": { "items": { "type": "string" }, "type": "array" }, "staleNodes": { "minimum": 0, "type": "integer" }, "state": { "type": "string" }, "totalNodes": { "minimum": 0, "type": "integer" }, "unschedulableNodes": { "minimum": 0, "type": "integer" }, "unsupportedNodes": { "minimum": 0, "type": "integer" } }, "required": [ "state", "isInstalled", "coveredNodes", "eligibleNodes", "totalNodes", "connectedNodes", "offlineNodes", "enrollingNodes", "missingNodes", "incompatibleNodes", "unsupportedNodes", "unschedulableNodes", "staleNodes", "reasons", "nodes", "canManageNodeAgents" ], "type": "object" }, "SwarmNodeAvailabilityTarget": { "properties": { "nodeId": { "type": "string" }, "versionIndex": { "format": "int64", "type": "integer" } }, "required": [ "nodeId", "versionIndex" ], "type": "object" }, "SwarmNodeView": { "properties": { "address": { "type": "string" }, "architecture": { "type": "string" }, "availability": { "type": "string" }, "capabilities": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PlatformCapabilitiesView" } ] }, "createdAt": { "format": "date-time", "type": [ "string", "null" ] }, "desiredTaskCount": { "format": "int32", "type": "integer" }, "engineVersion": { "type": "string" }, "hostname": { "type": "string" }, "id": { "type": "string" }, "isLeader": { "type": "boolean" }, "isStale": { "type": "boolean" }, "labels": { "additionalProperties": { "type": "string" }, "propertyNames": { "type": "string" }, "type": "object" }, "observedAt": { "format": "date-time", "type": "string" }, "operatingSystem": { "type": "string" }, "reachability": { "type": "string" }, "role": { "type": "string" }, "runningTaskCount": { "format": "int32", "type": "integer" }, "status": { "type": "string" }, "statusMessage": { "type": [ "string", "null" ] }, "updatedAt": { "format": "date-time", "type": [ "string", "null" ] }, "versionIndex": { "format": "int64", "type": "integer" } }, "required": [ "id", "versionIndex", "hostname", "role", "isLeader", "reachability", "status", "statusMessage", "availability", "engineVersion", "operatingSystem", "architecture", "address", "labels", "runningTaskCount", "desiredTaskCount", "createdAt", "updatedAt", "observedAt", "isStale", "capabilities" ], "type": "object" }, "SwarmOverviewView": { "properties": { "capabilities": { "$ref": "#/components/schemas/PlatformCapabilitiesView" }, "desiredTaskCount": { "format": "int64", "type": "integer" }, "health": { "type": "string" }, "imageCount": { "format": "int64", "type": "integer" }, "isStale": { "type": "boolean" }, "localNetworkCount": { "format": "int64", "type": "integer" }, "managerCount": { "format": "int64", "type": "integer" }, "message": { "type": [ "string", "null" ] }, "networkCount": { "format": "int64", "type": "integer" }, "nodeCount": { "format": "int64", "type": "integer" }, "platformId": { "format": "uuid", "type": "string" }, "quorum": { "$ref": "#/components/schemas/SwarmQuorumView" }, "runningTaskCount": { "format": "int64", "type": "integer" }, "serviceCount": { "format": "int64", "type": "integer" }, "serviceStatusCounts": { "$ref": "#/components/schemas/WorkloadStatusCounts" }, "volumeCount": { "format": "int64", "type": "integer" } }, "required": [ "platformId", "health", "message", "isStale", "nodeCount", "managerCount", "quorum", "serviceCount", "serviceStatusCounts", "runningTaskCount", "desiredTaskCount", "networkCount", "localNetworkCount", "volumeCount", "imageCount", "capabilities" ], "type": "object" }, "SwarmPreflightInput": { "properties": { "driftPolicy": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/StackDriftPolicy" } ] }, "name": { "type": "string" }, "platformId": { "format": "uuid", "type": "string" }, "spec": { "$ref": "#/components/schemas/StackSpec" }, "stackSource": { "$ref": "#/components/schemas/StackSource" } }, "required": [ "name", "platformId", "stackSource", "spec" ], "type": "object" }, "SwarmQuorumState": { "enum": [ "Unknown", "Lost", "Degraded", "Healthy" ], "type": "string" }, "SwarmQuorumView": { "properties": { "hasLeader": { "type": "boolean" }, "reachableManagers": { "format": "int64", "type": "integer" }, "requiredManagers": { "format": "int64", "type": "integer" }, "state": { "$ref": "#/components/schemas/SwarmQuorumState" } }, "required": [ "state", "reachableManagers", "requiredManagers", "hasLeader" ], "type": "object" }, "SwarmSecretView": { "properties": { "capabilities": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PlatformCapabilitiesView" } ] }, "createdAt": { "format": "date-time", "type": [ "string", "null" ] }, "driver": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "inUse": { "type": "boolean" }, "isStale": { "type": "boolean" }, "labels": { "additionalProperties": { "type": "string" }, "propertyNames": { "type": "string" }, "type": "object" }, "name": { "type": "string" }, "observedAt": { "format": "date-time", "type": "string" }, "serviceNames": { "items": { "type": "string" }, "type": "array" }, "updatedAt": { "format": "date-time", "type": [ "string", "null" ] }, "versionIndex": { "format": "int64", "type": "integer" } }, "required": [ "id", "versionIndex", "name", "driver", "serviceNames", "labels", "createdAt", "updatedAt", "observedAt", "isStale", "inUse", "capabilities" ], "type": "object" }, "SwarmServiceActivitySnapshot": { "properties": { "description": { "type": [ "string", "null" ] }, "dockerName": { "type": "string" }, "dockerServiceId": { "type": [ "string", "null" ] }, "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "platformId": { "format": "uuid", "type": "string" }, "spec": {} }, "required": [ "id", "platformId", "name", "dockerName", "spec" ], "type": "object" }, "SwarmServiceAdoptionDraftView": { "properties": { "draft": { "$ref": "#/components/schemas/CreateSwarmServiceInput" }, "issues": { "items": { "$ref": "#/components/schemas/SwarmServiceAdoptionIssue" }, "type": "array" }, "previewFingerprint": { "type": "string" }, "source": { "$ref": "#/components/schemas/SwarmServiceAdoptionSource" } }, "required": [ "source", "draft", "issues", "previewFingerprint" ], "type": "object" }, "SwarmServiceAdoptionIssue": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" }, "SwarmServiceAdoptionSource": { "properties": { "dockerServiceId": { "type": "string" }, "name": { "type": "string" }, "platformId": { "format": "uuid", "type": "string" }, "platformName": { "type": "string" } }, "required": [ "dockerServiceId", "name", "platformId", "platformName" ], "type": "object" }, "SwarmServiceCapabilities": { "properties": { "canApply": { "type": "boolean" }, "canExecute": { "type": "boolean" }, "canInspect": { "type": "boolean" }, "canRead": { "type": "boolean" }, "canViewLogs": { "type": "boolean" }, "canViewResourceBindings": { "type": "boolean" }, "canWrite": { "type": "boolean" } }, "required": [ "canViewLogs", "canInspect", "canApply", "canViewResourceBindings", "canRead", "canWrite", "canExecute" ], "type": "object" }, "SwarmServiceConfigReference": { "properties": { "configId": { "type": "string" }, "configName": { "type": "string" }, "targetName": { "type": "string" } }, "required": [ "configId", "configName", "targetName" ], "type": "object" }, "SwarmServiceDuplicateDraftView": { "properties": { "draft": { "$ref": "#/components/schemas/CreateSwarmServiceInput" }, "warnings": { "items": { "type": "string" }, "type": "array" } }, "required": [ "draft", "warnings" ], "type": "object" }, "SwarmServiceHealth": { "enum": [ "Unknown", "Healthy", "Progressing", "Degraded", "Failed", "Created", "Stopped" ], "type": "string" }, "SwarmServiceHealthCheck": { "properties": { "intervalNanoseconds": { "format": "int64", "type": [ "integer", "null" ] }, "retries": { "format": "int32", "type": [ "integer", "null" ] }, "startPeriodNanoseconds": { "format": "int64", "type": [ "integer", "null" ] }, "test": { "items": { "type": "string" }, "type": "array" }, "timeoutNanoseconds": { "format": "int64", "type": [ "integer", "null" ] } }, "required": [ "test" ], "type": "object" }, "SwarmServiceImageInfo": { "oneOf": [ { "properties": { "$type": { "enum": [ "External" ], "type": "string" }, "imageTag": { "type": "string" }, "registryId": { "format": "uuid", "type": "string" }, "resolvedDigest": { "type": [ "string", "null" ] } }, "required": [ "registryId", "imageTag", "$type" ], "type": "object" }, { "properties": { "$type": { "enum": [ "Build" ], "type": "string" }, "buildProjectId": { "format": "uuid", "type": "string" }, "resolvedBuildRunId": { "format": "uuid", "type": [ "string", "null" ] }, "resolvedDigest": { "type": [ "string", "null" ] }, "resolvedImageReference": { "type": [ "string", "null" ] } }, "required": [ "buildProjectId", "$type" ], "type": "object" } ] }, "SwarmServiceMount": { "properties": { "kind": { "$ref": "#/components/schemas/MountKind" }, "readOnly": { "type": "boolean" }, "source": { "type": "string" }, "target": { "type": "string" } }, "required": [ "kind", "source", "target" ], "type": "object" }, "SwarmServiceOperationKind": { "enum": [ "Apply", "Scale", "ForceUpdate", "Delete" ], "type": "string" }, "SwarmServiceOperationState": { "enum": [ "Prepared", "Canceled", "PendingAcceptance", "Accepted", "Rejected", "NotAccepted", "OutcomeUnknown", "Completed", "OwnershipConflict" ], "type": "string" }, "SwarmServiceOperationView": { "properties": { "attemptedAt": { "format": "date-time", "type": [ "string", "null" ] }, "completedAt": { "format": "date-time", "type": [ "string", "null" ] }, "id": { "format": "uuid", "type": "string" }, "kind": { "$ref": "#/components/schemas/SwarmServiceOperationKind" }, "preparedAt": { "format": "date-time", "type": "string" }, "resultCode": { "type": [ "string", "null" ] }, "resultMessage": { "type": [ "string", "null" ] }, "state": { "$ref": "#/components/schemas/SwarmServiceOperationState" }, "warnings": { "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "kind", "state", "preparedAt", "attemptedAt", "completedAt", "resultCode", "warnings", "resultMessage" ], "type": "object" }, "SwarmServiceOwnership": { "enum": [ "Unmanaged", "DockerStackExternal", "CitadelService", "CitadelStack", "OwnershipConflict", "System" ], "type": "string" }, "SwarmServicePort": { "properties": { "protocol": { "type": "string" }, "publishMode": { "$ref": "#/components/schemas/PortPublishMode" }, "publishedPort": { "format": "int32", "type": [ "integer", "null" ] }, "targetPort": { "format": "int32", "type": "integer" } }, "required": [ "targetPort" ], "type": "object" }, "SwarmServiceProgressItem": { "properties": { "errorMessage": { "type": [ "string", "null" ] }, "isCompleted": { "type": "boolean" }, "isWarning": { "type": "boolean" }, "message": { "type": "string" }, "operationId": { "format": "uuid", "type": [ "string", "null" ] }, "serviceId": { "format": "uuid", "type": "string" }, "stage": { "type": "string" } }, "required": [ "serviceId", "operationId", "stage", "message", "errorMessage" ], "type": "object" }, "SwarmServiceResources": { "properties": { "limitMemoryBytes": { "format": "int64", "type": [ "integer", "null" ] }, "limitNanoCpus": { "format": "int64", "type": [ "integer", "null" ] }, "reservationMemoryBytes": { "format": "int64", "type": [ "integer", "null" ] }, "reservationNanoCpus": { "format": "int64", "type": [ "integer", "null" ] } }, "type": "object" }, "SwarmServiceRestartPolicy": { "properties": { "condition": { "$ref": "#/components/schemas/RestartCondition" }, "delayNanoseconds": { "format": "int64", "type": [ "integer", "null" ] }, "maximumAttempts": { "format": "int32", "type": [ "integer", "null" ] }, "windowNanoseconds": { "format": "int64", "type": [ "integer", "null" ] } }, "type": "object" }, "SwarmServiceSecretReference": { "properties": { "secretId": { "type": "string" }, "secretName": { "type": "string" }, "targetName": { "type": "string" } }, "required": [ "secretId", "secretName", "targetName" ], "type": "object" }, "SwarmServiceSpec": { "properties": { "arguments": { "items": { "type": "string" }, "type": "array" }, "command": { "items": { "type": "string" }, "type": "array" }, "configs": { "items": { "$ref": "#/components/schemas/SwarmServiceConfigReference" }, "type": "array" }, "environment": { "items": { "type": "string" }, "type": "array" }, "healthCheck": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/SwarmServiceHealthCheck" } ] }, "image": { "$ref": "#/components/schemas/SwarmServiceImageInfo" }, "labels": { "additionalProperties": { "type": "string" }, "propertyNames": { "type": "string" }, "type": "object" }, "mounts": { "items": { "$ref": "#/components/schemas/SwarmServiceMount" }, "type": "array" }, "networkIds": { "items": { "type": "string" }, "type": "array" }, "placementConstraints": { "items": { "type": "string" }, "type": "array" }, "ports": { "items": { "$ref": "#/components/schemas/SwarmServicePort" }, "type": "array" }, "replicas": { "format": "int32", "type": [ "integer", "null" ] }, "resources": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/SwarmServiceResources" } ] }, "restartPolicy": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/SwarmServiceRestartPolicy" } ] }, "schedulingMode": { "$ref": "#/components/schemas/SchedulingMode" }, "secrets": { "items": { "$ref": "#/components/schemas/SwarmServiceSecretReference" }, "type": "array" }, "stopGracePeriodNanoseconds": { "format": "int64", "type": [ "integer", "null" ] }, "updateBehavior": { "$ref": "#/components/schemas/UpdateBehavior" }, "updatePolicy": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/SwarmServiceUpdatePolicy" } ] }, "user": { "type": [ "string", "null" ] }, "webhook": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/WebhookConfig" } ] }, "workingDirectory": { "type": [ "string", "null" ] } }, "required": [ "image" ], "type": "object" }, "SwarmServiceSynchronizationState": { "enum": [ "NeverApplied", "DesiredChangesPending", "InSync", "Drifted", "RuntimeMissing", "OutcomeUnknown", "OwnershipConflict" ], "type": "string" }, "SwarmServiceUpdatePolicy": { "properties": { "delayNanoseconds": { "format": "int64", "type": [ "integer", "null" ] }, "failureAction": { "$ref": "#/components/schemas/UpdateFailureAction" }, "order": { "$ref": "#/components/schemas/UpdateOrder" }, "parallelism": { "format": "int32", "type": "integer" } }, "type": "object" }, "SwarmServiceView": { "properties": { "capabilities": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PlatformCapabilitiesView" } ] }, "configIds": { "items": { "type": "string" }, "type": "array" }, "createdAt": { "format": "date-time", "type": [ "string", "null" ] }, "desiredTaskCount": { "format": "int32", "type": "integer" }, "dockerStackNamespace": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "image": { "type": "string" }, "isStale": { "type": "boolean" }, "labels": { "additionalProperties": { "type": "string" }, "propertyNames": { "type": "string" }, "type": "object" }, "mode": { "type": "string" }, "name": { "type": "string" }, "networkIds": { "items": { "type": "string" }, "type": "array" }, "observedAt": { "format": "date-time", "type": "string" }, "ownership": { "$ref": "#/components/schemas/SwarmServiceOwnership" }, "ownershipDiagnostic": { "type": [ "string", "null" ] }, "ports": { "items": { "type": "string" }, "type": "array" }, "runningTaskCount": { "format": "int32", "type": "integer" }, "secretIds": { "items": { "type": "string" }, "type": "array" }, "stackId": { "format": "uuid", "type": [ "string", "null" ] }, "swarmServiceId": { "format": "uuid", "type": [ "string", "null" ] }, "updateMessage": { "type": [ "string", "null" ] }, "updateState": { "type": "string" }, "updatedAt": { "format": "date-time", "type": [ "string", "null" ] }, "versionIndex": { "format": "int64", "type": "integer" } }, "required": [ "id", "versionIndex", "name", "mode", "image", "runningTaskCount", "desiredTaskCount", "updateState", "updateMessage", "ports", "networkIds", "secretIds", "configIds", "labels", "ownership", "dockerStackNamespace", "ownershipDiagnostic", "stackId", "swarmServiceId", "createdAt", "updatedAt", "observedAt", "isStale", "capabilities" ], "type": "object" }, "SwarmStackCompatibilityIssue": { "properties": { "code": { "type": "string" }, "fieldPath": { "type": [ "string", "null" ] }, "message": { "type": "string" }, "severity": { "$ref": "#/components/schemas/SwarmStackCompatibilitySeverity" } }, "required": [ "severity", "code", "message" ], "type": "object" }, "SwarmStackCompatibilityReport": { "properties": { "isCompatible": { "type": "boolean" }, "issues": { "items": { "$ref": "#/components/schemas/SwarmStackCompatibilityIssue" }, "type": "array" } }, "required": [ "isCompatible", "issues" ], "type": "object" }, "SwarmStackCompatibilitySeverity": { "enum": [ "Warning", "Error" ], "type": "string" }, "SwarmTaskView": { "properties": { "capabilities": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PlatformCapabilitiesView" } ] }, "createdAt": { "format": "date-time", "type": [ "string", "null" ] }, "desiredState": { "type": "string" }, "error": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "image": { "type": "string" }, "isStale": { "type": "boolean" }, "name": { "type": "string" }, "nodeHostname": { "type": "string" }, "nodeId": { "type": "string" }, "observedAt": { "format": "date-time", "type": "string" }, "ports": { "items": { "type": "string" }, "type": "array" }, "serviceId": { "type": "string" }, "serviceName": { "type": "string" }, "slot": { "format": "int32", "type": [ "integer", "null" ] }, "state": { "type": "string" }, "statusMessage": { "type": [ "string", "null" ] }, "statusTimestamp": { "format": "date-time", "type": [ "string", "null" ] }, "updatedAt": { "format": "date-time", "type": [ "string", "null" ] }, "versionIndex": { "format": "int64", "type": "integer" } }, "required": [ "id", "versionIndex", "name", "serviceId", "serviceName", "slot", "nodeId", "nodeHostname", "desiredState", "state", "statusMessage", "error", "image", "ports", "statusTimestamp", "createdAt", "updatedAt", "observedAt", "isStale", "capabilities" ], "type": "object" }, "TagPatch": { "properties": { "color": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] } }, "type": "object" }, "TagView": { "properties": { "color": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdByActorId": { "format": "uuid", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" }, "normalizedName": { "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "usageCount": { "format": "int32", "type": "integer" } }, "required": [ "id", "name", "normalizedName", "color", "createdByActorId", "createdAt", "updatedAt", "usageCount" ], "type": "object" }, "TagsResponse": { "properties": { "capabilities": { "$ref": "#/components/schemas/ResourceCapabilitiesView" }, "tags": { "items": { "$ref": "#/components/schemas/AuthorizedTagView" }, "type": "array" } }, "required": [ "tags", "capabilities" ], "type": "object" }, "TaskHistory": { "properties": { "containerProjectionId": { "format": "uuid", "type": "string" }, "dockerContainerId": { "type": "string" }, "stats": { "items": { "$ref": "#/components/schemas/ContainerStatView" }, "type": "array" } }, "required": [ "containerProjectionId", "dockerContainerId", "stats" ], "type": "object" }, "TaskTerminalView": { "properties": { "dockerContainerId": { "type": "string" } }, "required": [ "dockerContainerId" ], "type": "object" }, "TeamActivitySnapshot": { "properties": { "isEnabled": { "type": "boolean" }, "memberActorIds": { "items": { "format": "uuid", "type": "string" }, "type": "array" }, "resourceAccesses": { "items": { "$ref": "#/components/schemas/IdentityResourceAccessSnapshot" }, "type": "array" }, "roleIds": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "required": [ "isEnabled", "memberActorIds", "roleIds", "resourceAccesses" ], "type": "object" }, "TestExternalSecretInput": { "properties": { "externalKey": { "type": "string" }, "externalPath": { "type": "string" }, "externalVersion": { "format": "int32", "type": [ "integer", "null" ] }, "providerId": { "format": "uuid", "type": "string" } }, "required": [ "providerId", "externalPath", "externalKey" ], "type": "object" }, "TestSecretProviderInput": { "properties": { "address": { "type": "string" }, "mountPath": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "providerId": { "format": "uuid", "type": [ "string", "null" ] }, "token": { "type": [ "string", "null" ] } }, "required": [ "address", "mountPath" ], "type": "object" }, "UpdateAutomationActionInput": { "additionalProperties": false, "properties": { "alertOnFailure": { "type": "boolean" }, "code": { "type": "string" }, "defaultArgsJson": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "enabled": { "type": "boolean" }, "runAsActorId": { "format": "uuid", "type": [ "string", "null" ] }, "scheduleCron": { "type": [ "string", "null" ] }, "scheduleEnabled": { "type": "boolean" }, "scheduleTimeZone": { "type": [ "string", "null" ] }, "timeoutSeconds": { "format": "int32", "type": [ "integer", "null" ] }, "webhook": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/WebhookPatch" } ] } }, "type": "object" }, "UpdateAutomationActionMetadata": { "additionalProperties": false, "properties": { "description": { "type": [ "string", "null" ] } }, "type": "object" }, "UpdateBackupPolicyInput": { "properties": { "alertOnFailure": { "type": [ "boolean", "null" ] }, "backupRepositoryId": { "format": "uuid", "type": [ "string", "null" ] }, "cron": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "enabled": { "type": [ "boolean", "null" ] }, "keepLastSuccessful": { "format": "int32", "type": [ "integer", "null" ] }, "runAsActorId": { "format": "uuid", "type": [ "string", "null" ] }, "source": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/BackupSourceSpec" } ] }, "timeZone": { "type": [ "string", "null" ] }, "timeoutSeconds": { "format": "int32", "type": [ "integer", "null" ] }, "webhook": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/WebhookPatch" } ] } }, "type": "object" }, "UpdateBackupRepositoryInput": { "properties": { "description": { "type": [ "string", "null" ] }, "spec": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/BackupRepositorySpec" } ] } }, "type": "object" }, "UpdateBehavior": { "enum": [ "Disabled", "Notify", "AutoDeploy" ], "type": "string" }, "UpdateBuildAgentPoolInput": { "additionalProperties": false, "properties": { "cleanupTimeoutSeconds": { "format": "int32", "type": [ "integer", "null" ] }, "description": { "type": [ "string", "null" ] }, "enabled": { "type": [ "boolean", "null" ] }, "failureRetentionMinutes": { "format": "int32", "type": [ "integer", "null" ] }, "heartbeatTimeoutSeconds": { "format": "int32", "type": [ "integer", "null" ] }, "maxActiveBuilders": { "format": "int32", "type": [ "integer", "null" ] }, "maximumInstanceLifetimeSeconds": { "format": "int32", "type": [ "integer", "null" ] }, "providerSpec": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/BuildAgentPoolProviderSpec" } ] }, "provisioningTimeoutSeconds": { "format": "int32", "type": [ "integer", "null" ] }, "queueTimeoutSeconds": { "format": "int32", "type": [ "integer", "null" ] }, "registrationTimeoutSeconds": { "format": "int32", "type": [ "integer", "null" ] } }, "type": "object" }, "UpdateBuildProjectInput": { "additionalProperties": false, "properties": { "branch": { "type": [ "string", "null" ] }, "buildAgentPoolId": { "format": "uuid", "type": [ "string", "null" ] }, "buildArgs": { "items": { "$ref": "#/components/schemas/BuildArgSpec" }, "type": [ "array", "null" ] }, "buildSecrets": { "items": { "$ref": "#/components/schemas/BuildSecretSpec" }, "type": [ "array", "null" ] }, "builderKind": { "$ref": "#/components/schemas/BuildProjectBuilderKind" }, "contextPath": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "dockerfilePath": { "type": [ "string", "null" ] }, "enabled": { "type": "boolean" }, "gitRepositoryId": { "format": "uuid", "type": "string" }, "imageRepository": { "type": "string" }, "platformId": { "format": "uuid", "type": [ "string", "null" ] }, "pushToRegistry": { "type": "boolean" }, "registryId": { "format": "uuid", "type": [ "string", "null" ] }, "retentionRunCount": { "format": "int32", "type": [ "integer", "null" ] }, "tagTemplates": { "items": { "type": "string" }, "type": [ "array", "null" ] }, "target": { "type": [ "string", "null" ] }, "timeoutSeconds": { "format": "int32", "type": [ "integer", "null" ] }, "webhook": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/WebhookPatch" } ] } }, "type": "object" }, "UpdateFailureAction": { "enum": [ "Continue", "Pause", "Rollback" ], "type": "string" }, "UpdateOrder": { "enum": [ "StopFirst", "StartFirst" ], "type": "string" }, "UpdateSwarmNodeInput": { "properties": { "availability": { "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, "propertyNames": { "type": "string" }, "type": "object" }, "versionIndex": { "format": "int64", "type": "integer" } }, "required": [ "versionIndex", "availability" ], "type": "object" }, "UpdateSwarmNodesAvailabilityInput": { "properties": { "availability": { "type": "string" }, "nodes": { "items": { "$ref": "#/components/schemas/SwarmNodeAvailabilityTarget" }, "type": "array" } }, "required": [ "availability" ], "type": "object" }, "UpdateSwarmResourceLabelsInput": { "properties": { "labels": { "additionalProperties": { "type": "string" }, "propertyNames": { "type": "string" }, "type": "object" }, "versionIndex": { "format": "int64", "type": "integer" } }, "required": [ "versionIndex" ], "type": "object" }, "UpdateSwarmServiceInput": { "additionalProperties": false, "properties": { "rowVersion": { "format": "int64", "type": "integer" }, "spec": { "$ref": "#/components/schemas/SwarmServiceSpec" } }, "required": [ "spec", "rowVersion" ], "type": "object" }, "UserActivitySnapshot": { "properties": { "email": { "type": "string" }, "isEnabled": { "type": "boolean" }, "resourceAccesses": { "items": { "$ref": "#/components/schemas/IdentityResourceAccessSnapshot" }, "type": "array" }, "roleIds": { "items": { "format": "uuid", "type": "string" }, "type": "array" }, "teamIds": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "required": [ "email", "isEnabled", "teamIds", "roleIds", "resourceAccesses" ], "type": "object" }, "ValidateImportRequest": { "additionalProperties": false, "properties": { "importKind": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/StackImportKind" } ] }, "name": { "type": "string" }, "spec": { "$ref": "#/components/schemas/StackSpec" }, "stackSource": { "$ref": "#/components/schemas/StackSource" } }, "required": [ "name", "stackSource", "spec" ], "type": "object" }, "VerifyInput": { "properties": { "alertDestination": { "$ref": "#/components/schemas/AlertDestination" }, "name": { "type": "string" }, "url": { "type": "string" } }, "required": [ "name", "alertDestination", "url" ], "type": "object" }, "VolumeBackupConsistency": { "enum": [ "Live", "StopAttachedContainers" ], "type": "string" }, "VolumeCapabilitiesView": { "properties": { "canBrowse": { "type": "boolean" }, "canDownload": { "type": "boolean" }, "canExecute": { "type": "boolean" }, "canInspect": { "type": "boolean" }, "canRead": { "type": "boolean" }, "canWrite": { "type": "boolean" } }, "required": [ "canRead", "canWrite", "canExecute", "canInspect", "canBrowse", "canDownload" ], "type": "object" }, "VolumeContainerView": { "properties": { "id": { "type": "string" }, "image": { "type": "string" }, "imageId": { "type": "string" }, "name": { "type": "string" }, "networks": { "additionalProperties": { "type": "string" }, "propertyNames": { "type": "string" }, "type": "object" }, "ports": { "additionalProperties": { "items": { "$ref": "#/components/schemas/HostPortBinding" }, "type": "array" }, "propertyNames": { "type": "string" }, "type": "object" }, "state": { "$ref": "#/components/schemas/ContainerStateStatus" } }, "required": [ "id", "name", "image", "imageId", "state", "networks", "ports" ], "type": "object" }, "VolumeContentDownloaded": { "properties": { "fileName": { "type": "string" }, "isDirectory": { "type": "boolean" }, "path": { "type": "string" }, "volumeName": { "type": "string" } }, "required": [ "volumeName", "path", "isDirectory", "fileName" ], "type": "object" }, "VolumeDirectory": { "properties": { "entries": { "items": { "$ref": "#/components/schemas/VolumeFileEntry" }, "type": "array" }, "isTruncated": { "type": "boolean" }, "path": { "type": "string" }, "platformId": { "format": "uuid", "type": "string" }, "volumeName": { "type": "string" } }, "required": [ "platformId", "volumeName", "path", "entries", "isTruncated" ], "type": "object" }, "VolumeEntryType": { "enum": [ "File", "Directory", "Symlink", "Other" ], "type": "string" }, "VolumeFileEntry": { "properties": { "linkTarget": { "type": [ "string", "null" ] }, "modifiedAt": { "format": "date-time", "type": [ "string", "null" ] }, "name": { "type": "string" }, "path": { "type": "string" }, "size": { "format": "int64", "minimum": 0, "type": [ "integer", "null" ] }, "type": { "$ref": "#/components/schemas/VolumeEntryType" } }, "required": [ "name", "path", "type" ], "type": "object" }, "VolumeUsageDataView": { "properties": { "refCount": { "format": "int64", "type": "integer" }, "size": { "format": "int64", "type": "integer" } }, "required": [ "size", "refCount" ], "type": "object" }, "VolumeView": { "properties": { "backupCoverage": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/BackupCoverageView" } ] }, "capabilities": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/VolumeCapabilitiesView" } ] }, "clusterVolume": {}, "containers": { "items": { "$ref": "#/components/schemas/VolumeContainerView" }, "type": "array" }, "createdAt": { "type": "string" }, "dockerNodeId": { "type": [ "string", "null" ] }, "driver": { "type": "string" }, "id": { "type": "string" }, "inUse": { "type": "boolean" }, "isStale": { "type": "boolean" }, "labels": { "additionalProperties": { "type": "string" }, "propertyNames": { "type": "string" }, "type": "object" }, "mountpoint": { "type": "string" }, "name": { "type": "string" }, "nodeHostname": { "type": [ "string", "null" ] }, "options": { "additionalProperties": { "type": "string" }, "propertyNames": { "type": "string" }, "type": "object" }, "scope": { "type": "string" }, "staleReason": { "type": [ "string", "null" ] }, "status": { "additionalProperties": { "type": "string" }, "propertyNames": { "type": "string" }, "type": "object" }, "usageData": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/VolumeUsageDataView" } ] } }, "required": [ "id", "name", "inUse", "scope", "driver", "mountpoint", "createdAt", "clusterVolume", "usageData", "containers", "status", "labels", "options", "dockerNodeId", "nodeHostname", "isStale", "staleReason", "capabilities" ], "type": "object" }, "VolumesResponse": { "properties": { "capabilities": { "$ref": "#/components/schemas/ResourceCapabilitiesView" }, "volumes": { "items": { "$ref": "#/components/schemas/VolumeView" }, "type": "array" } }, "required": [ "volumes", "capabilities" ], "type": "object" }, "WebhookActivityDetails": { "allOf": [ { "$ref": "#/components/schemas/WebhookActivitySource" }, { "properties": { "authType": { "type": "string" }, "dispatchedBranch": { "type": [ "string", "null" ] }, "dispatchedCommitSha": { "type": [ "string", "null" ] }, "execution": { "type": "string" }, "reason": { "type": [ "string", "null" ] }, "requestId": { "format": "uuid", "type": "string" }, "status": { "type": "string" } }, "required": [ "requestId", "authType", "execution", "status" ], "type": "object" } ], "description": "Safe webhook audit metadata. Authentication headers, credentials and request\nbodies are deliberately not representable in the persisted event." }, "WebhookActivitySource": { "properties": { "branch": { "type": [ "string", "null" ] }, "commitSha": { "type": [ "string", "null" ] }, "deliveryId": { "type": [ "string", "null" ] }, "eventType": { "type": [ "string", "null" ] }, "repositoryFullName": { "type": [ "string", "null" ] } }, "type": "object" }, "WebhookAuthScheme": { "enum": [ "GitHubHmacSha256", "GitLabSignedToken", "GitLabLegacyToken", "BearerToken" ], "type": "string" }, "WebhookConfig": { "description": "Shared webhook wire configuration and defaults.", "properties": { "authScheme": { "default": "GitHubHmacSha256", "oneOf": [ { "$ref": "#/components/schemas/WebhookAuthScheme" } ] }, "branchFilter": { "default": null, "type": [ "string", "null" ] }, "enabled": { "default": false, "type": "boolean" }, "provider": { "default": "GitHub", "oneOf": [ { "$ref": "#/components/schemas/WebhookProvider" } ] }, "secret": { "default": null, "type": [ "string", "null" ] } }, "type": "object" }, "WebhookPatch": { "additionalProperties": false, "description": "Partial configuration. Defaults belong to creation, never to omitted patch fields.", "properties": { "authScheme": { "$ref": "#/components/schemas/WebhookAuthScheme" }, "branchFilter": { "type": [ "string", "null" ] }, "enabled": { "type": "boolean" }, "provider": { "$ref": "#/components/schemas/WebhookProvider" }, "secret": { "type": [ "string", "null" ] } }, "type": "object" }, "WebhookProvider": { "enum": [ "GitHub", "GitLab", "Generic" ], "type": "string" }, "WorkloadStatusCounts": { "properties": { "degraded": { "format": "int64", "type": "integer" }, "failed": { "format": "int64", "type": "integer" }, "healthy": { "format": "int64", "type": "integer" }, "inProgress": { "format": "int64", "type": "integer" }, "paused": { "format": "int64", "type": "integer" }, "stopped": { "format": "int64", "type": "integer" }, "total": { "format": "int64", "type": "integer" }, "unknown": { "format": "int64", "type": "integer" } }, "required": [ "total", "healthy", "degraded", "failed", "stopped", "paused", "inProgress", "unknown" ], "type": "object" }, "deployments.model.ImagePullProgress": { "properties": { "current": { "format": "int64", "type": [ "integer", "null" ] }, "start": { "format": "int64", "type": [ "integer", "null" ] }, "total": { "format": "int64", "type": [ "integer", "null" ] }, "units": { "type": [ "string", "null" ] } }, "type": "object" }, "platforms.image_pull.ImagePullProgress": { "properties": { "current": { "format": "int64", "type": [ "integer", "null" ] }, "start": { "format": "int64", "type": [ "integer", "null" ] }, "total": { "format": "int64", "type": [ "integer", "null" ] }, "units": { "type": [ "string", "null" ] } }, "type": "object" }, "resources.tags.TagSummary": { "properties": { "color": { "type": "string" }, "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name", "color" ], "type": "object" }, "server.alerts_http.Events": { "properties": { "pagedResult": { "$ref": "#/components/schemas/AlertEventPage" } }, "required": [ "pagedResult" ], "type": "object" }, "server.backups_http.Events": { "properties": { "events": { "items": { "type": "string" }, "type": "array" }, "runId": { "format": "uuid", "type": "string" } }, "required": [ "runId", "events" ], "type": "object" }, "server.backups_http.Logs": { "properties": { "logs": { "type": "string" }, "runId": { "format": "uuid", "type": "string" } }, "required": [ "runId", "logs" ], "type": "object" }, "server.backups_http.QueueInput": { "properties": { "trigger": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/BackupQueueTrigger" } ] } }, "type": "object" }, "server.backups_http.Runs": { "properties": { "runs": { "items": { "$ref": "#/components/schemas/BackupRunView" }, "type": "array" } }, "required": [ "runs" ], "type": "object" }, "server.builds_http.Logs": { "properties": { "logs": { "items": { "$ref": "#/components/schemas/BuildLogEntry" }, "type": "array" }, "runId": { "format": "uuid", "type": "string" } }, "required": [ "runId", "logs" ], "type": "object" }, "server.builds_http.QueueInput": { "properties": { "trigger": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/QueueBuildTrigger" } ] } }, "type": "object" }, "server.builds_http.Runs": { "properties": { "runs": { "items": { "$ref": "#/components/schemas/BuildRunView" }, "type": "array" } }, "required": [ "runs" ], "type": "object" } }, "securitySchemes": { "Bearer": { "bearerFormat": "Citadel JWT or cit_sa_ Service Account token", "description": "Use a Citadel User JWT or Service Account bearer token in the Authorization header.", "scheme": "bearer", "type": "http" } } }, "info": { "title": "Citadel Public API", "version": "1.0.0" }, "openapi": "3.1.0", "paths": { "/api/v1/activities": { "get": { "operationId": "listActivities", "parameters": [ { "in": "query", "name": "ResourceId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "ResourceType", "required": false, "schema": { "$ref": "#/components/schemas/ActivityResourceType" } }, { "in": "query", "name": "EventType", "required": false, "schema": { "$ref": "#/components/schemas/ActivityEventType" } }, { "in": "query", "name": "Page", "required": false, "schema": { "default": 1, "format": "int32", "minimum": 1, "type": "integer" } }, { "in": "query", "name": "PageSize", "required": false, "schema": { "default": 50, "format": "int32", "maximum": 500, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivitiesView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "List authorized activities", "tags": [ "Activities" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/activities/{id}": { "get": { "operationId": "getActivity", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivityView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get an authorized activity", "tags": [ "Activities" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/alertEvents": { "get": { "operationId": "listAlertEvents", "parameters": [ { "in": "query", "name": "ResourceId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "AlertType", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "ResourceType", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "UnresolvedOnly", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "Page", "required": false, "schema": { "default": 1, "format": "int32", "minimum": 1, "type": "integer" } }, { "in": "query", "name": "PageSize", "required": false, "schema": { "default": 50, "format": "int32", "maximum": 1000, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server.alerts_http.Events" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "List Alert Events", "tags": [ "AlertEvents" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/alertEvents/acknowledge": { "post": { "operationId": "acknowledgeAlertEvents", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ids" } } }, "required": true }, "responses": { "204": { "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Acknowledge Alert Events", "tags": [ "AlertEvents" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/alertEvents/resolve": { "post": { "operationId": "resolveAlertEvents", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResolveInput" } } }, "required": true }, "responses": { "204": { "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Resolve Alert Events", "tags": [ "AlertEvents" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/alertEvents/unresolved-count": { "get": { "operationId": "getUnresolvedAlertEventsCount", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Count" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Count unresolved Alert Events", "tags": [ "AlertEvents" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/alertEvents/{id}": { "get": { "operationId": "getAlertEvent", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertEventView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get an Alert Event", "tags": [ "AlertEvents" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/alertRules": { "delete": { "operationId": "deleteAlertRules", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ids" } } }, "required": true }, "responses": { "204": { "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Delete Alert Rules", "tags": [ "AlertRules" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "get": { "operationId": "listAlertRules", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Rules" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "List Alert Rules", "tags": [ "AlertRules" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "post": { "operationId": "createAlertRule", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertRuleInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertRuleView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Create an Alert Rule", "tags": [ "AlertRules" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/alertRules/channels": { "delete": { "operationId": "deleteAlertChannels", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ids" } } }, "required": true }, "responses": { "204": { "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Delete Alert Channels", "tags": [ "AlertRules" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "get": { "operationId": "listAlertChannels", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Channels" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "List Alert Channels", "tags": [ "AlertRules" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "post": { "operationId": "createAlertChannel", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertChannelInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertChannelView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Create an Alert Channel", "tags": [ "AlertRules" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/alertRules/channels/verify": { "post": { "operationId": "verifyAlertChannel", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerifyInput" } } }, "required": true }, "responses": { "204": { "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "502": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Gateway" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Verify an Alert Channel", "tags": [ "AlertRules" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/alertRules/channels/{id}": { "get": { "operationId": "getAlertChannel", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertChannelView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get an Alert Channel", "tags": [ "AlertRules" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "patch": { "operationId": "updateAlertChannel", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchAlertChannelInput" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/PatchAlertChannelInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertChannelView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Update an Alert Channel", "tags": [ "AlertRules" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/alertRules/rename": { "post": { "operationId": "renameAlertRule", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RenameAlertRuleInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertRuleView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Rename an Alert Rule", "tags": [ "AlertRules" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/alertRules/{id}": { "get": { "operationId": "getAlertRule", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertRuleView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get an Alert Rule", "tags": [ "AlertRules" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "patch": { "operationId": "updateAlertRule", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchAlertRuleInput" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/PatchAlertRuleInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertRuleView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Update an Alert Rule", "tags": [ "AlertRules" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/alertRules/{id}/_cfg": { "get": { "operationId": "getAlertRuleConfig", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertRuleConfig" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get Alert Rule configuration", "tags": [ "AlertRules" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/alertRules/{id}/_metadata": { "patch": { "operationId": "updateAlertRuleMetadata", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchAlertRuleMetadata" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/PatchAlertRuleMetadata" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertRuleView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Update Alert Rule metadata", "tags": [ "AlertRules" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/automation/actions": { "get": { "operationId": "listAutomationActions", "parameters": [ { "in": "query", "name": "tags", "required": false, "schema": { "items": { "type": "string" }, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionList" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "List Automation Actions", "tags": [ "AutomationActions" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "post": { "operationId": "createAutomationAction", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomationActionInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizedAction" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Create an Automation Action", "tags": [ "AutomationActions" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/automation/actions/rename": { "post": { "operationId": "renameAutomationAction", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RenameInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizedAction" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Rename an Automation Action", "tags": [ "AutomationActions" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/automation/actions/{id}": { "delete": { "operationId": "deleteAutomationAction", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Delete an Automation Action", "tags": [ "AutomationActions" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "get": { "operationId": "getAutomationAction", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizedAction" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get an Automation Action", "tags": [ "AutomationActions" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "patch": { "operationId": "updateAutomationAction", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAutomationActionInput" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateAutomationActionInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizedAction" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Update an Automation Action", "tags": [ "AutomationActions" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/automation/actions/{id}/_metadata": { "patch": { "operationId": "updateAutomationActionMetadata", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAutomationActionMetadata" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateAutomationActionMetadata" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizedAction" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Update Automation Action metadata", "tags": [ "AutomationActions" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/automation/actions/{id}/run": { "post": { "operationId": "runAutomationAction", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/RunInput" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/AutomationProgress" }, "type": "array" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Queue an Automation Action run", "tags": [ "AutomationActions" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/automation/actions/{id}/runs": { "get": { "operationId": "listAutomationActionRuns", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunList" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "List Automation Action runs", "tags": [ "AutomationActions" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/automation/actions/{id}/runs/{runId}": { "get": { "operationId": "getAutomationActionRun", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "runId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomationRunView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get an Automation Action run", "tags": [ "AutomationActions" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/automation/actions/{id}/runs/{runId}/cancel": { "post": { "operationId": "cancelAutomationActionRun", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "runId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Cancel an Automation Action run", "tags": [ "AutomationActions" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/automation/actions/{id}/runs/{runId}/logs": { "get": { "operationId": "getAutomationActionRunLogs", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "runId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomationActionRunLogsView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get Automation Action run logs", "tags": [ "AutomationActions" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/automation/actions/{id}/tags": { "get": { "operationId": "getAutomationActionTags", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceTagsResponse" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get AutomationAction tags", "tags": [ "AutomationActions" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "put": { "operationId": "replaceAutomationActionTags", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplaceResourceTagsInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceTagsResponse" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Replace AutomationAction tags", "tags": [ "AutomationActions" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/automation/actions/{id}/test": { "post": { "operationId": "testAutomationAction", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/RunInput" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/AutomationProgress" }, "type": "array" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Queue a test Automation Action run", "tags": [ "AutomationActions" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/backupPolicies": { "get": { "operationId": "listBackupPolicies", "parameters": [ { "in": "query", "name": "tags", "required": false, "schema": { "items": { "type": "string" }, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Policies" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "List Backup Policies", "tags": [ "BackupPolicies" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "post": { "operationId": "createBackupPolicy", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupPolicyInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupPolicyView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Create a Backup Policy", "tags": [ "BackupPolicies" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/backupPolicies/platform-summaries": { "get": { "operationId": "getPlatformBackupSummaries", "parameters": [ { "in": "query", "name": "platformIds", "required": true, "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformBackupSummaries" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get Platform Backup summaries", "tags": [ "BackupPolicies" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/backupPolicies/rename": { "post": { "operationId": "renameBackupPolicy", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RenameBackupPolicyInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupPolicyView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Rename a Backup Policy", "tags": [ "BackupPolicies" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/backupPolicies/{id}": { "delete": { "operationId": "archiveBackupPolicy", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Archive a Backup Policy", "tags": [ "BackupPolicies" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "get": { "operationId": "getBackupPolicy", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupPolicyView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get a Backup Policy", "tags": [ "BackupPolicies" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "patch": { "operationId": "updateBackupPolicy", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateBackupPolicyInput" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateBackupPolicyInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupPolicyView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Update a Backup Policy", "tags": [ "BackupPolicies" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/backupPolicies/{id}/_metadata": { "patch": { "operationId": "updateBackupPolicyMetadata", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupMetadataPatch" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/BackupMetadataPatch" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupPolicyView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Update Backup Policy metadata", "tags": [ "BackupPolicies" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/backupPolicies/{id}/run": { "post": { "operationId": "runBackupPolicy", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server.backups_http.QueueInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/BackupRunStreamItem" }, "type": "array" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Run a Backup Policy with progress", "tags": [ "BackupPolicies" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/backupPolicies/{id}/runs": { "post": { "operationId": "queueBackupRun", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/server.backups_http.QueueInput" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupRunView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Queue a Backup Run", "tags": [ "BackupPolicies" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/backupPolicies/{id}/tags": { "get": { "operationId": "getBackupPolicyTags", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceTagsResponse" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get BackupPolicy tags", "tags": [ "BackupPolicies" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "put": { "operationId": "replaceBackupPolicyTags", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplaceResourceTagsInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceTagsResponse" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Replace BackupPolicy tags", "tags": [ "BackupPolicies" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/backupRepositories": { "get": { "operationId": "listBackupRepositories", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Repositories" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "List Backup Repositories", "tags": [ "BackupRepositories" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "post": { "operationId": "createBackupRepository", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupRepositoryInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupRepositoryView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Create a Backup Repository", "tags": [ "BackupRepositories" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/backupRepositories/{id}": { "delete": { "operationId": "archiveBackupRepository", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Archive a Backup Repository", "tags": [ "BackupRepositories" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "get": { "operationId": "getBackupRepository", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupRepositoryView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get a Backup Repository", "tags": [ "BackupRepositories" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "patch": { "operationId": "updateBackupRepository", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateBackupRepositoryInput" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateBackupRepositoryInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupRepositoryView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Update a Backup Repository", "tags": [ "BackupRepositories" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/backupRepositories/{id}/check": { "post": { "operationId": "checkBackupRepository", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepositoryLocationInput" } } }, "required": true }, "responses": { "204": { "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "502": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Gateway" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Check a Backup Repository", "tags": [ "BackupRepositories" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/backupRepositories/{id}/initialize": { "post": { "operationId": "initializeBackupRepository", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepositoryLocationInput" } } }, "required": true }, "responses": { "204": { "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "502": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Gateway" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Initialize a Backup Repository", "tags": [ "BackupRepositories" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/backupRepositories/{id}/prune": { "post": { "operationId": "pruneBackupRepository", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepositoryLocationInput" } } }, "required": true }, "responses": { "204": { "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "502": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Gateway" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Prune a Backup Repository", "tags": [ "BackupRepositories" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/backupRepositories/{id}/validate": { "post": { "operationId": "validateBackupRepository", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepositoryLocationInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupRepositoryValidationView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "502": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Gateway" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Validate a Backup Repository", "tags": [ "BackupRepositories" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/backupRestoreRuns": { "get": { "operationId": "listBackupRestoreRuns", "parameters": [ { "in": "query", "name": "backupRunId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "policyId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Restores" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "List Backup Restore Runs", "tags": [ "BackupRestoreRuns" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/backupRestoreRuns/{id}": { "get": { "operationId": "getBackupRestoreRun", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupRestoreRunView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get a Backup Restore Run", "tags": [ "BackupRestoreRuns" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/backupRestoreRuns/{id}/cancel": { "post": { "operationId": "cancelBackupRestoreRun", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Cancel a Backup Restore Run", "tags": [ "BackupRestoreRuns" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/backupRestoreRuns/{id}/events": { "get": { "operationId": "getBackupRestoreRunEvents", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server.backups_http.Events" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get Backup Restore Run events", "tags": [ "BackupRestoreRuns" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/backupRestoreRuns/{id}/logs": { "get": { "operationId": "getBackupRestoreRunLogs", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server.backups_http.Logs" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get Backup Restore Run logs", "tags": [ "BackupRestoreRuns" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/backupRuns": { "get": { "operationId": "listBackupRuns", "parameters": [ { "in": "query", "name": "policyId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server.backups_http.Runs" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "List Backup Runs", "tags": [ "BackupRuns" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/backupRuns/{id}": { "get": { "operationId": "getBackupRun", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupRunView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get a Backup Run", "tags": [ "BackupRuns" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/backupRuns/{id}/cancel": { "post": { "operationId": "cancelBackupRun", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Cancel a Backup Run", "tags": [ "BackupRuns" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/backupRuns/{id}/events": { "get": { "operationId": "getBackupRunEvents", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server.backups_http.Events" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get Backup Run events", "tags": [ "BackupRuns" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/backupRuns/{id}/logs": { "get": { "operationId": "getBackupRunLogs", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server.backups_http.Logs" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get Backup Run logs", "tags": [ "BackupRuns" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/backupRuns/{id}/restoreVolume": { "post": { "operationId": "restoreBackupVolume", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestoreInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupRestoreRunView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Queue a Volume restore", "tags": [ "BackupRuns" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/backupRuns/{id}/restoreVolume/run": { "post": { "operationId": "runBackupRestoreVolume", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestoreInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/BackupRestoreRunStreamItem" }, "type": "array" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Restore a Backup Volume with progress", "tags": [ "BackupRuns" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/buildAgentPools": { "get": { "operationId": "listBuildAgentPools", "parameters": [ { "in": "query", "name": "tags", "required": false, "schema": { "items": { "type": "string" }, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Pools" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "List Build Agent Pools", "tags": [ "BuildAgentPools" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "post": { "operationId": "createBuildAgentPool", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuildAgentPoolInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizedPool" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Create a Build Agent Pool", "tags": [ "BuildAgentPools" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/buildAgentPools/rename": { "post": { "operationId": "renameBuildAgentPool", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RenamePool" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizedPool" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Rename a Build Agent Pool", "tags": [ "BuildAgentPools" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/buildAgentPools/{id}": { "delete": { "operationId": "archiveBuildAgentPool", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Archive a Build Agent Pool", "tags": [ "BuildAgentPools" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "get": { "operationId": "getBuildAgentPool", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizedPool" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get a Build Agent Pool", "tags": [ "BuildAgentPools" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "patch": { "operationId": "updateBuildAgentPool", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateBuildAgentPoolInput" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateBuildAgentPoolInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizedPool" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Update a Build Agent Pool", "tags": [ "BuildAgentPools" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/buildAgentPools/{id}/_metadata": { "patch": { "operationId": "updateBuildAgentPoolMetadata", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuildMetadataPatch" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/BuildMetadataPatch" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizedPool" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Update Build Agent Pool metadata", "tags": [ "BuildAgentPools" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/buildAgentPools/{id}/edge/enrollments": { "post": { "operationId": "createBuildAgentPoolEdgeEnrollment", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EdgeEnrollmentView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Create build pool Edge Agent enrollment", "tags": [ "BuildAgentPools" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/buildAgentPools/{id}/edge/revoke": { "post": { "operationId": "revokeBuildAgentPoolEdgeAgent", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Revoke build pool Edge Agent", "tags": [ "BuildAgentPools" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/buildAgentPools/{id}/edge/status": { "get": { "operationId": "getBuildAgentPoolEdgeStatus", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EdgeStatusView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get build pool Edge Agent status", "tags": [ "BuildAgentPools" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/buildAgentPools/{id}/tags": { "get": { "operationId": "getBuildAgentPoolTags", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceTagsResponse" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get BuildAgentPool tags", "tags": [ "BuildAgentPools" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "put": { "operationId": "replaceBuildAgentPoolTags", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplaceResourceTagsInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceTagsResponse" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Replace BuildAgentPool tags", "tags": [ "BuildAgentPools" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/buildAgentPools/{id}/test": { "post": { "operationId": "testBuildAgentPool", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizedPool" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Test a Build Agent Pool", "tags": [ "BuildAgentPools" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/buildProjects": { "get": { "operationId": "listBuildProjects", "parameters": [ { "in": "query", "name": "tags", "required": false, "schema": { "items": { "type": "string" }, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Projects" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "List Build Projects", "tags": [ "BuildProjects" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "post": { "operationId": "createBuildProject", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuildProjectInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizedProject" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Create a Build Project", "tags": [ "BuildProjects" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/buildProjects/rename": { "post": { "operationId": "renameBuild", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RenamePool" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizedProject" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Update Build Project", "tags": [ "BuildProjects" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/buildProjects/{id}": { "delete": { "operationId": "archiveBuildProject", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Archive a Build Project", "tags": [ "BuildProjects" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "get": { "operationId": "getBuildProject", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizedProject" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get a Build Project", "tags": [ "BuildProjects" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "patch": { "operationId": "updateBuildProject", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateBuildProjectInput" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateBuildProjectInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizedProject" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Update Build Project", "tags": [ "BuildProjects" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/buildProjects/{id}/_metadata": { "patch": { "operationId": "updateBuildMetadata", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuildMetadataPatch" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/BuildMetadataPatch" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizedProject" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Update Build Project", "tags": [ "BuildProjects" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/buildProjects/{id}/runs": { "post": { "operationId": "queueBuildRun", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/server.builds_http.QueueInput" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuildRunView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Queue a Build Run", "tags": [ "BuildProjects" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/buildProjects/{id}/tags": { "get": { "operationId": "getBuildTags", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceTagsResponse" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get BuildProject tags", "tags": [ "BuildProjects" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "put": { "operationId": "replaceBuildTags", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplaceResourceTagsInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceTagsResponse" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Replace BuildProject tags", "tags": [ "BuildProjects" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/buildRuns": { "get": { "operationId": "listBuildRuns", "parameters": [ { "in": "query", "name": "projectId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server.builds_http.Runs" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "List Build Runs", "tags": [ "BuildRuns" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/buildRuns/{id}": { "get": { "operationId": "getBuildRun", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuildRunView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get a Build Run", "tags": [ "BuildRuns" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/buildRuns/{id}/cancel": { "post": { "operationId": "cancelBuildRun", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Cancel a Build Run", "tags": [ "BuildRuns" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/buildRuns/{id}/logs": { "get": { "operationId": "getBuildRunLogs", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server.builds_http.Logs" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get Build Run logs", "tags": [ "BuildRuns" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/containers": { "delete": { "operationId": "deleteContainers", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteInput" } } }, "required": true }, "responses": { "204": { "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "502": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Gateway" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Delete Containers", "tags": [ "Containers" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/containers/pause": { "patch": { "operationId": "pauseContainers", "requestBody": { "content": { "application/json": { "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } } }, "required": true }, "responses": { "204": { "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "502": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Gateway" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Pause Containers", "tags": [ "Containers" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/containers/restart": { "patch": { "operationId": "restartContainers", "requestBody": { "content": { "application/json": { "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } } }, "required": true }, "responses": { "204": { "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "502": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Gateway" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Restart Containers", "tags": [ "Containers" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/containers/start": { "patch": { "operationId": "startContainers", "requestBody": { "content": { "application/json": { "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } } }, "required": true }, "responses": { "204": { "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "502": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Gateway" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Start Containers", "tags": [ "Containers" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/containers/stop": { "patch": { "operationId": "stopContainers", "requestBody": { "content": { "application/json": { "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } } }, "required": true }, "responses": { "204": { "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "502": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Gateway" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Stop Containers", "tags": [ "Containers" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/containers/unpause": { "patch": { "operationId": "unpauseContainers", "requestBody": { "content": { "application/json": { "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } } }, "required": true }, "responses": { "204": { "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "502": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Gateway" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Unpause Containers", "tags": [ "Containers" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/containers/{id}": { "get": { "operationId": "getContainer", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContainerView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get a Container", "tags": [ "Containers" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/containers/{id}/adopt": { "post": { "operationId": "adoptContainer", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdoptContainerInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeploymentView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "502": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Gateway" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Adopt a Container without changing Docker", "tags": [ "Containers" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/containers/{id}/adoption-draft": { "get": { "operationId": "getContainerAdoptionDraft", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContainerAdoptionDraft" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "502": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Gateway" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Review adoption of an unmanaged Container", "tags": [ "Containers" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/containers/{id}/data": { "get": { "operationId": "getContainerData", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContainerRuntimeView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "502": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Gateway" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "getContainerData", "tags": [ "Containers" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/containers/{id}/info": { "get": { "operationId": "getContainerInfo", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContainerSummaryView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "502": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Gateway" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "getContainerInfo", "tags": [ "Containers" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/containers/{id}/inspect": { "get": { "operationId": "inspectContainer", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContainerInspectionView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "502": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Gateway" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Inspect a Container with sensitive environment values redacted", "tags": [ "Containers" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/containers/{id}/stats": { "get": { "operationId": "getContainerStats", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "hours", "required": false, "schema": { "$ref": "#/components/schemas/StatsHours" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/History_ContainerStatSnapshot" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get Container statistics", "tags": [ "Containers" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/deployments": { "delete": { "operationId": "deleteDeployments", "requestBody": { "content": { "application/json": { "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } } }, "required": true }, "responses": { "204": { "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Delete Deployments", "tags": [ "Deployments" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "get": { "operationId": "listDeployments", "parameters": [ { "in": "query", "name": "tags", "required": false, "schema": { "items": { "type": "string" }, "type": "array" } }, { "in": "query", "name": "platformId", "required": false, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeploymentsView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "List authorized Deployments", "tags": [ "Deployments" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "post": { "operationId": "createDeployment", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDeploymentInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeploymentView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Create a Deployment", "tags": [ "Deployments" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/deployments/apply": { "post": { "operationId": "applyDeployment", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplyDeploymentInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/DeploymentStreamItem" }, "type": "array" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Apply a Deployment", "tags": [ "Deployments" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/deployments/pause": { "post": { "operationId": "pauseDeployments", "requestBody": { "content": { "application/json": { "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } } }, "required": true }, "responses": { "204": { "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Pause Deployments", "tags": [ "Deployments" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/deployments/rename": { "post": { "operationId": "renameDeployment", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RenameDeploymentInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeploymentView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Rename a Deployment", "tags": [ "Deployments" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/deployments/restart": { "post": { "operationId": "restartDeployments", "requestBody": { "content": { "application/json": { "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } } }, "required": true }, "responses": { "204": { "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Restart Deployments", "tags": [ "Deployments" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/deployments/resume": { "post": { "operationId": "resumeDeployments", "requestBody": { "content": { "application/json": { "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } } }, "required": true }, "responses": { "204": { "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Resume Deployments", "tags": [ "Deployments" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/deployments/start": { "post": { "operationId": "startDeployments", "requestBody": { "content": { "application/json": { "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } } }, "required": true }, "responses": { "204": { "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Start Deployments", "tags": [ "Deployments" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/deployments/stop": { "post": { "operationId": "stopDeployments", "requestBody": { "content": { "application/json": { "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } } }, "required": true }, "responses": { "204": { "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Stop Deployments", "tags": [ "Deployments" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/deployments/{deploymentId}": { "get": { "operationId": "getDeployment", "parameters": [ { "in": "path", "name": "deploymentId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeploymentView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get a Deployment", "tags": [ "Deployments" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/deployments/{deploymentId}/_cfg": { "get": { "operationId": "getDeploymentConfig", "parameters": [ { "in": "path", "name": "deploymentId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeploymentConfigView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get Deployment configuration", "tags": [ "Deployments" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/deployments/{deploymentId}/backup-source-preview": { "get": { "operationId": "getDeploymentBackupSourcePreview", "parameters": [ { "in": "path", "name": "deploymentId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupSourcePreview" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "502": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Gateway" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Preview Deployment Backup volumes", "tags": [ "Deployments" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/deployments/{deploymentId}/check-updates": { "post": { "operationId": "checkDeploymentUpdates", "parameters": [ { "in": "path", "name": "deploymentId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeploymentView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "502": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Gateway" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Check the applied Deployment image for updates", "tags": [ "Deployments" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/deployments/{deploymentId}/duplicate-draft": { "get": { "operationId": "getDeploymentDuplicateDraft", "parameters": [ { "in": "path", "name": "deploymentId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeploymentDuplicateDraftView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Build a Deployment duplicate draft", "tags": [ "Deployments" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/deployments/{deploymentId}/tags": { "get": { "operationId": "getDeploymentTags", "parameters": [ { "in": "path", "name": "deploymentId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceTagsResponse" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get Deployment tags", "tags": [ "Deployments" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "put": { "operationId": "replaceDeploymentTags", "parameters": [ { "in": "path", "name": "deploymentId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplaceResourceTagsInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceTagsResponse" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Replace Deployment tags", "tags": [ "Deployments" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/deployments/{id}": { "patch": { "operationId": "updateDeployment", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchDeploymentInput" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDeploymentInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeploymentView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Update Deployment configuration", "tags": [ "Deployments" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/deployments/{id}/_metadata": { "patch": { "operationId": "updateDeploymentMetadata", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchDeploymentMetadataInput" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDeploymentMetadataInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeploymentView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Update Deployment metadata", "tags": [ "Deployments" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/deployments/{id}/info": { "get": { "operationId": "getDeploymentContainerInfo", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContainerSummaryView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "502": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Gateway" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "getDeploymentContainerInfo", "tags": [ "Deployments" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/deployments/{id}/inspect": { "get": { "operationId": "inspectDeployment", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContainerInspectionView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "502": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Gateway" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "inspectDeployment", "tags": [ "Deployments" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/deployments/{id}/stats": { "get": { "operationId": "getDeploymentStats", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "hours", "required": false, "schema": { "$ref": "#/components/schemas/StatsHours" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/History_ContainerStatSnapshot" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get Deployment statistics", "tags": [ "Deployments" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/gitRepositories": { "delete": { "operationId": "deleteGitRepositories", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteResourcesInput" } } }, "required": true }, "responses": { "204": { "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Delete Git repositories", "tags": [ "GitRepositories" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "get": { "operationId": "listGitRepositories", "parameters": [ { "in": "query", "name": "tags", "required": false, "schema": { "items": { "type": "string" }, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GitRepositoriesResponse" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "List Git repositories", "tags": [ "GitRepositories" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "post": { "operationId": "createGitRepository", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewGitRepository" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GitRepositoryView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Create a Git repository", "tags": [ "GitRepositories" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/gitRepositories/rename": { "post": { "operationId": "renameGitRepository", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RenameResourceInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GitRepositoryView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Rename a Git repository", "tags": [ "GitRepositories" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/gitRepositories/{id}": { "get": { "operationId": "getGitRepository", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizedGitRepositoryView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get a Git repository", "tags": [ "GitRepositories" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "patch": { "operationId": "updateGitRepository", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GitRepositoryPatch" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/GitRepositoryPatch" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GitRepositoryView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Update a Git repository", "tags": [ "GitRepositories" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/gitRepositories/{id}/_cfg": { "get": { "operationId": "getGitRepositoryConfig", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GitRepositoryConfigResponse" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get Git repository configuration", "tags": [ "GitRepositories" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/gitRepositories/{id}/_metadata": { "patch": { "operationId": "updateGitRepositoryMetadata", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchResourceMetadataInput" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/PatchResourceMetadataInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GitRepositoryView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Update Git repository metadata", "tags": [ "GitRepositories" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/gitRepositories/{id}/branches": { "get": { "operationId": "discoverGitRepositoryBranches", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GitRepositoryBranchesResponse" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "502": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Gateway" }, "503": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Discover remote Git branches", "tags": [ "GitRepositories" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/gitRepositories/{id}/compare": { "get": { "operationId": "compareGitRepositoryCommits", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "baseCommitSha", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "headCommitSha", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GitCommitComparison" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "502": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Gateway" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Compare immutable Git commits", "tags": [ "GitRepositories" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/gitRepositories/{id}/compose-projects": { "get": { "operationId": "discoverGitRepositoryComposeProjects", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "branch", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GitComposeDiscovery" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "502": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Gateway" }, "503": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Discover Compose projects in a Git repository", "tags": [ "GitRepositories" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/gitRepositories/{id}/files": { "get": { "operationId": "listGitRepositoryDirectory", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "commitSha", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "path", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GitDirectoryListing" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "502": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Gateway" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "List files in an immutable Git tree", "tags": [ "GitRepositories" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/gitRepositories/{id}/files/content": { "get": { "operationId": "getGitRepositoryFileContent", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "commitSha", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GitFileContent" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "502": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Gateway" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Read a bounded immutable Git file", "tags": [ "GitRepositories" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/gitRepositories/{id}/refs": { "get": { "operationId": "getGitRepositoryRefs", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GitRepositoryRefsResponse" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get synchronized Git repository references", "tags": [ "GitRepositories" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/gitRepositories/{id}/sync": { "post": { "operationId": "syncGitRepository", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "branch", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GitRepositoryView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Queue Git repository synchronization", "tags": [ "GitRepositories" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/gitRepositories/{id}/tags": { "get": { "operationId": "getGitRepositoryTags", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceTagsResponse" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get Git repository tags", "tags": [ "GitRepositories" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "put": { "operationId": "replaceGitRepositoryTags", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplaceResourceTagsInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceTagsResponse" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Replace Git repository tags", "tags": [ "GitRepositories" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/images": { "delete": { "operationId": "deleteImages", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteImagesInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteImagesView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "502": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Gateway" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Delete Images", "tags": [ "Images" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/images/dockerhub/{registryName}/repositories": { "get": { "operationId": "getDockerHubRepositories", "parameters": [ { "in": "path", "name": "registryName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/DockerHubRepositoryInfo" }, "type": "array" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "List Docker Hub repositories", "tags": [ "Images" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/images/dockerhub/{registryName}/{repositoryName}/tags": { "get": { "operationId": "getDockerHubRepositoryTags", "parameters": [ { "in": "path", "name": "registryName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/DockerHubTag" }, "type": "array" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "List Docker Hub repository tags", "tags": [ "Images" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/images/ghcr/{registryName}/{packageName}/versions": { "get": { "operationId": "getGhcrPackageVersions", "parameters": [ { "in": "path", "name": "registryName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "packageName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/GithubPackageVersion" }, "type": "array" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "List GitHub package versions", "tags": [ "Images" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/images/pull": { "post": { "operationId": "pullImage", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PullImageInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/PullImageStreamItem" }, "type": "array" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Pull a Docker image with progress", "tags": [ "Images" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/images/{platformId}": { "get": { "operationId": "listImages", "parameters": [ { "in": "path", "name": "platformId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImagesResponse" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "List Platform Images", "tags": [ "Images" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/images/{platformId}/{imageId}": { "get": { "operationId": "inspectImage", "parameters": [ { "in": "path", "name": "platformId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "imageId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "dockerNodeId", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImageInspectionView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "502": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Gateway" }, "503": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Inspect an Image on its owning Docker node", "tags": [ "Images" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/images/{platformId}/{imageId}/_ports": { "get": { "operationId": "getExposedPorts", "parameters": [ { "in": "path", "name": "platformId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "imageId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExposedPortsView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "502": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Gateway" }, "503": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Read exposed ports using the Citadel Image ID", "tags": [ "Images" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/images/{registryName}/repositories": { "get": { "operationId": "getExternalRepositories", "parameters": [ { "in": "path", "name": "registryName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ExternalRepository" }, "type": "array" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "List Registry repositories", "tags": [ "Images" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/networks": { "delete": { "operationId": "deleteNetworks", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteNetworksInput" } } }, "required": true }, "responses": { "204": { "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Delete Networks", "tags": [ "Networks" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "post": { "operationId": "createNetwork", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateNetworkInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatedNetworkView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Create a Network", "tags": [ "Networks" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/networks/{platformId}": { "get": { "operationId": "listNetworks", "parameters": [ { "in": "path", "name": "platformId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "Dangling", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "Driver", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "Id", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "Name", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworksResponse" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "List Platform Networks", "tags": [ "Networks" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/networks/{platformId}/{networkId}": { "get": { "operationId": "inspectNetwork", "parameters": [ { "in": "path", "name": "platformId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "networkId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "dockerNodeId", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Inspect a Platform Network", "tags": [ "Networks" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/platforms": { "delete": { "operationId": "deletePlatforms", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletePlatformsInput" } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Delete Platform registrations", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "get": { "operationId": "listPlatforms", "parameters": [ { "in": "query", "name": "tags", "required": false, "schema": { "items": { "type": "string" }, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformsResponse" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "List authorized Platforms", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "post": { "operationId": "createPlatform", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePlatformInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Create a Platform", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/platforms/agent/setup": { "get": { "operationId": "getAgentSetup", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSetupView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get regular Agent setup instructions", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/platforms/agent/setup/rotate-key": { "post": { "operationId": "rotateAgentHubKey", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSetupView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Rotate the Agent signing key", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/platforms/rename": { "post": { "operationId": "renamePlatform", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RenamePlatformInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Rename a Platform", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/platforms/{id}": { "get": { "operationId": "getPlatfom", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get a Platform", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "patch": { "operationId": "updatePlatform", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformPatch" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/PlatformPatch" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Update a Platform", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/platforms/{id}/_metadata": { "patch": { "operationId": "updatePlatformMetadata", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchPlatformMetadataInput" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/PatchPlatformMetadataInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Update Platform metadata", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/platforms/{id}/containers": { "get": { "operationId": "listContainers", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContainersResponse" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "List Platform Containers", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/platforms/{id}/edge/enrollments": { "post": { "operationId": "createEdgeAgentEnrollment", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EdgeEnrollmentView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Create an Edge Agent enrollment token", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/platforms/{id}/edge/revoke": { "post": { "operationId": "revokeEdgeAgent", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Revoke an Edge Agent binding", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/platforms/{id}/edge/status": { "get": { "operationId": "getEdgeAgentStatus", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EdgeStatusView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get Edge Agent connection status", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/platforms/{id}/node-agent-coverage": { "get": { "operationId": "getSwarmNodeAgentCoverage", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwarmNodeAgentCoverage" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get Docker Swarm node-agent coverage", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/platforms/{id}/node-agents": { "delete": { "operationId": "removeSwarmNodeAgents", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/NodeAgentProgress" }, "type": "array" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Remove Docker Swarm node agents", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/platforms/{id}/node-agents/install": { "post": { "operationId": "installSwarmNodeAgents", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/NodeAgentProgress" }, "type": "array" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Install Docker Swarm node agents", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/platforms/{id}/node-agents/repair": { "post": { "operationId": "repairSwarmNodeAgents", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/NodeAgentProgress" }, "type": "array" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Repair Docker Swarm node-agent coverage", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/platforms/{id}/node-agents/upgrade": { "post": { "operationId": "upgradeSwarmNodeAgents", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/NodeAgentProgress" }, "type": "array" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Upgrade Docker Swarm node agents", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/platforms/{id}/prune": { "post": { "operationId": "prunePlatform", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrunePlatformInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrunePlatformView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Prune unused Docker resources", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/platforms/{id}/stats": { "get": { "operationId": "getPlatformStats", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "hours", "required": false, "schema": { "$ref": "#/components/schemas/StatsHours" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/History_PlatformStatSnapshot" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get Platform statistics", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/platforms/{id}/tags": { "get": { "operationId": "getPlatformTags", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceTagsResponse" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get Platform tags", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "put": { "operationId": "replacePlatformTags", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplaceResourceTagsInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceTagsResponse" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Replace Platform tags", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/platforms/{platformId}/swarm": { "get": { "operationId": "getSwarmOverview", "parameters": [ { "in": "path", "name": "platformId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwarmOverviewView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "502": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Gateway" }, "503": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get Swarm inventory health and quorum", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/platforms/{platformId}/swarm/configs": { "delete": { "operationId": "deleteSwarmConfigs", "parameters": [ { "in": "path", "name": "platformId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteSwarmResourcesInput" } } }, "required": true }, "responses": { "204": { "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "deleteSwarmConfigs", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "get": { "operationId": "listSwarmConfigs", "parameters": [ { "in": "path", "name": "platformId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwarmItemsResponse_SwarmConfigView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "List Swarm Configs", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "post": { "operationId": "createSwarmConfig", "parameters": [ { "in": "path", "name": "platformId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSwarmMaterialInput" } } }, "required": true }, "responses": { "204": { "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "createSwarmConfig", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/platforms/{platformId}/swarm/configs/{resourceId}": { "get": { "operationId": "getSwarmConfig", "parameters": [ { "in": "path", "name": "platformId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "resourceId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwarmConfigView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get a Swarm Config", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/platforms/{platformId}/swarm/configs/{resourceId}/content": { "get": { "operationId": "getSwarmConfigData", "parameters": [ { "in": "path", "name": "platformId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "resourceId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigContentView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "getSwarmConfigData", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/platforms/{platformId}/swarm/configs/{resourceId}/labels": { "patch": { "operationId": "updateSwarmConfigLabels", "parameters": [ { "in": "path", "name": "platformId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "resourceId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSwarmResourceLabelsInput" } } }, "required": true }, "responses": { "204": { "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "updateSwarmConfigLabels", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/platforms/{platformId}/swarm/networks": { "get": { "operationId": "listSwarmNetworks", "parameters": [ { "in": "path", "name": "platformId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwarmItemsResponse_SwarmNetworkView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "List Swarm Networks", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/platforms/{platformId}/swarm/networks/{resourceId}": { "get": { "operationId": "getSwarmNetwork", "parameters": [ { "in": "path", "name": "platformId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "resourceId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwarmNetworkView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get a Swarm Network", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/platforms/{platformId}/swarm/nodes": { "get": { "operationId": "listSwarmNodes", "parameters": [ { "in": "path", "name": "platformId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwarmItemsResponse_SwarmNodeView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "List Swarm Nodes", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/platforms/{platformId}/swarm/nodes/availability": { "patch": { "operationId": "updateSwarmNodesAvailability", "parameters": [ { "in": "path", "name": "platformId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSwarmNodesAvailabilityInput" } } }, "required": true }, "responses": { "204": { "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "updateSwarmNodesAvailability", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/platforms/{platformId}/swarm/nodes/{nodeId}": { "get": { "operationId": "getSwarmNode", "parameters": [ { "in": "path", "name": "platformId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "nodeId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwarmNodeView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get a Swarm Node", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "patch": { "operationId": "updateSwarmNode", "parameters": [ { "in": "path", "name": "platformId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "nodeId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSwarmNodeInput" } } }, "required": true }, "responses": { "204": { "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "updateSwarmNode", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/platforms/{platformId}/swarm/nodes/{nodeId}/inspect": { "get": { "operationId": "inspectSwarmNode", "parameters": [ { "in": "path", "name": "platformId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "nodeId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NodeInspectionView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "inspectSwarmNode", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/platforms/{platformId}/swarm/refresh": { "post": { "operationId": "refreshSwarmInventory", "parameters": [ { "in": "path", "name": "platformId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Inventory refreshed" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "502": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Gateway" }, "503": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Refresh Swarm inventory from the manager", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/platforms/{platformId}/swarm/secrets": { "delete": { "operationId": "deleteSwarmSecrets", "parameters": [ { "in": "path", "name": "platformId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteSwarmResourcesInput" } } }, "required": true }, "responses": { "204": { "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "deleteSwarmSecrets", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "get": { "operationId": "listSwarmSecrets", "parameters": [ { "in": "path", "name": "platformId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwarmItemsResponse_SwarmSecretView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "List Swarm Secrets", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "post": { "operationId": "createSwarmSecret", "parameters": [ { "in": "path", "name": "platformId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSwarmMaterialInput" } } }, "required": true }, "responses": { "204": { "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "createSwarmSecret", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/platforms/{platformId}/swarm/secrets/{resourceId}": { "get": { "operationId": "getSwarmSecret", "parameters": [ { "in": "path", "name": "platformId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "resourceId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwarmSecretView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get a Swarm Secret", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/platforms/{platformId}/swarm/secrets/{resourceId}/labels": { "patch": { "operationId": "updateSwarmSecretLabels", "parameters": [ { "in": "path", "name": "platformId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "resourceId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSwarmResourceLabelsInput" } } }, "required": true }, "responses": { "204": { "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "updateSwarmSecretLabels", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/platforms/{platformId}/swarm/services": { "delete": { "operationId": "deleteSwarmInventoryServices", "parameters": [ { "in": "path", "name": "platformId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteSwarmResourcesInput" } } }, "required": true }, "responses": { "204": { "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "deleteSwarmInventoryServices", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "get": { "operationId": "listSwarmServices", "parameters": [ { "in": "path", "name": "platformId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwarmItemsResponse_SwarmServiceView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "List Swarm Services", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/platforms/{platformId}/swarm/services/{resourceId}": { "get": { "operationId": "getSwarmService", "parameters": [ { "in": "path", "name": "platformId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "resourceId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwarmServiceView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get a Swarm Service", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/platforms/{platformId}/swarm/services/{resourceId}/adopt": { "post": { "operationId": "adoptSwarmService", "parameters": [ { "in": "path", "name": "platformId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "resourceId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdoptSwarmServiceInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedSwarmServiceView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Adopt an existing Docker Service without changing Docker", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/platforms/{platformId}/swarm/services/{resourceId}/adoption-draft": { "get": { "operationId": "getSwarmServiceAdoptionDraft", "parameters": [ { "in": "path", "name": "platformId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "resourceId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwarmServiceAdoptionDraftView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Review an unmanaged Docker Service for adoption", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/platforms/{platformId}/swarm/services/{resourceId}/inspect": { "get": { "operationId": "inspectSwarmService", "parameters": [ { "in": "path", "name": "platformId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "resourceId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceInspectionView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "inspectSwarmService", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/platforms/{platformId}/swarm/services/{resourceId}/logs": { "get": { "operationId": "getSwarmServiceLogs", "parameters": [ { "in": "path", "name": "platformId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "tail", "required": false, "schema": { "default": 100, "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogSnapshot" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "502": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Gateway" }, "503": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Read bounded Service logs", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/platforms/{platformId}/swarm/services/{resourceId}/restart": { "post": { "operationId": "restartSwarmService", "parameters": [ { "in": "path", "name": "platformId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "resourceId", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "restartSwarmService", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/platforms/{platformId}/swarm/services/{resourceId}/stats": { "get": { "operationId": "getSwarmServiceStats", "parameters": [ { "in": "path", "name": "platformId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "hours", "required": false, "schema": { "$ref": "#/components/schemas/StatsHours" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceStatistics" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "502": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Gateway" }, "503": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get Service statistics and node coverage", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/platforms/{platformId}/swarm/tasks": { "get": { "operationId": "listSwarmTasks", "parameters": [ { "in": "path", "name": "platformId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "serviceId", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwarmItemsResponse_SwarmTaskView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "List Swarm Tasks", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/platforms/{platformId}/swarm/tasks/{resourceId}": { "get": { "operationId": "getSwarmTask", "parameters": [ { "in": "path", "name": "platformId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "resourceId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwarmTaskView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get a Swarm Task", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/platforms/{platformId}/swarm/tasks/{resourceId}/inspect": { "get": { "operationId": "inspectSwarmTask", "parameters": [ { "in": "path", "name": "platformId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "resourceId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContainerInspectionView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "502": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Gateway" }, "503": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Inspect the current Task container", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/platforms/{platformId}/swarm/tasks/{resourceId}/logs": { "get": { "operationId": "getSwarmTaskLogs", "parameters": [ { "in": "path", "name": "platformId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "tail", "required": false, "schema": { "default": 100, "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogSnapshot" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "502": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Gateway" }, "503": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Read current Task logs on its owning node", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/platforms/{platformId}/swarm/tasks/{resourceId}/stats": { "get": { "operationId": "getSwarmTaskStats", "parameters": [ { "in": "path", "name": "platformId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "hours", "required": false, "schema": { "$ref": "#/components/schemas/StatsHours" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskHistory" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "502": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Gateway" }, "503": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get current Task statistics", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/platforms/{platformId}/swarm/tasks/{resourceId}/terminal": { "get": { "operationId": "getSwarmTaskTerminalTarget", "parameters": [ { "in": "path", "name": "platformId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "resourceId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskTerminalView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "502": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Gateway" }, "503": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Resolve the current Task terminal target", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/platforms/{platformId}/unmanaged-compose-projects/{projectName}": { "get": { "operationId": "getComposeProjectImportDraft", "parameters": [ { "in": "path", "name": "platformId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "projectName", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "importKind", "required": false, "schema": { "$ref": "#/components/schemas/StackImportKind" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComposeProjectImportDraftView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get a Compose or Swarm Stack import draft", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/platforms/{platformId}/unmanaged-compose-projects/{projectName}/import": { "post": { "operationId": "importComposeProject", "parameters": [ { "in": "path", "name": "platformId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "projectName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StackView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Import a Compose project or Swarm Stack", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/platforms/{platformId}/unmanaged-compose-projects/{projectName}/import-draft": { "post": { "operationId": "validateComposeProjectImportDraft", "parameters": [ { "in": "path", "name": "platformId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "projectName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateImportRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComposeProjectImportValidation" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Validate a source for an unmanaged Compose project", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/platforms/{platformId}/volumes/{name}/files": { "get": { "operationId": "listVolumeDirectory", "parameters": [ { "in": "path", "name": "platformId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "path", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "dockerNodeId", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VolumeDirectory" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "502": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Gateway" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Browse a Volume directory", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/platforms/{platformId}/volumes/{name}/files/download": { "get": { "operationId": "downloadVolumePath", "parameters": [ { "in": "path", "name": "platformId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "path", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "dockerNodeId", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "502": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Gateway" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Download a Volume file or directory", "tags": [ "Platforms" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/registries": { "delete": { "operationId": "deleteRegistries", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteResourcesInput" } } }, "required": true }, "responses": { "204": { "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Delete Registries", "tags": [ "Registries" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "get": { "operationId": "listRegistries", "parameters": [ { "in": "query", "name": "includeDisabled", "required": false, "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "tags", "required": false, "schema": { "items": { "type": "string" }, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistriesResponse" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "List Registries", "tags": [ "Registries" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "post": { "operationId": "createRegistry", "requestBody": { "content": { "application/json": { "examples": { "AWS": { "value": { "configuration": { "$type": "AWS", "accessKey": "example-access-key", "authenticationRequired": true, "region": "us-east-2", "secretAccessKey": "example-secret-key" }, "name": "my-ecr-registry", "registryHost": "123456789012.dkr.ecr.us-east-2.amazonaws.com", "status": "Active" } }, "Azure": { "value": { "configuration": { "$type": "Azure", "password": "example-password", "userName": "example-user" }, "name": "my-azure-registry", "registryHost": "myproject.azurecr.io", "status": "Active" } }, "Custom": { "value": { "configuration": { "$type": "Custom", "authEnabled": true, "password": "example-password", "userName": "example-user" }, "name": "my-custom-registry", "registryHost": "localhost:9965", "status": "Active" } }, "DockerHub": { "value": { "configuration": { "$type": "DockerHub", "pat": "example-token", "userName": "example-user" }, "name": "my-dockerhub-registry", "status": "Active" } }, "GitHub": { "value": { "configuration": { "$type": "GitHub", "ghcrAuthEnabled": true, "nameSpace": "citadel-p", "pat": "example-token" }, "name": "my-github-registry", "status": "Active" } }, "Gitlab": { "value": { "configuration": { "$type": "Gitlab", "instanceUrl": "https://gitlab.com", "pat": "example-token", "userName": "example-user" }, "name": "my-gitlab-registry", "registryHost": "registry.gitlab.com", "status": "Active" } } }, "schema": { "$ref": "#/components/schemas/NewRegistry" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistryView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Create a Registry", "tags": [ "Registries" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/registries/rename": { "post": { "operationId": "renameRegistry", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RenameResourceInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistryView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Rename a Registry", "tags": [ "Registries" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/registries/{id}": { "get": { "operationId": "getRegistry", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizedRegistryView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get a Registry", "tags": [ "Registries" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "patch": { "operationId": "updateRegistry", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "examples": { "AWS": { "value": { "configuration": { "$type": "AWS", "accessKey": "example-access-key", "authenticationRequired": true, "region": "us-east-2", "secretAccessKey": "example-secret-key" }, "name": "my-ecr-registry", "registryHost": "123456789012.dkr.ecr.us-east-2.amazonaws.com", "status": "Active" } }, "Azure": { "value": { "configuration": { "$type": "Azure", "password": "example-password", "userName": "example-user" }, "name": "my-azure-registry", "registryHost": "myproject.azurecr.io", "status": "Active" } }, "Custom": { "value": { "configuration": { "$type": "Custom", "authEnabled": true, "password": "example-password", "userName": "example-user" }, "name": "my-custom-registry", "registryHost": "localhost:9965", "status": "Active" } }, "DockerHub": { "value": { "configuration": { "$type": "DockerHub", "pat": "example-token", "userName": "example-user" }, "name": "my-dockerhub-registry", "status": "Active" } }, "GitHub": { "value": { "configuration": { "$type": "GitHub", "ghcrAuthEnabled": true, "nameSpace": "citadel-p", "pat": "example-token" }, "name": "my-github-registry", "status": "Active" } }, "Gitlab": { "value": { "configuration": { "$type": "Gitlab", "instanceUrl": "https://gitlab.com", "pat": "example-token", "userName": "example-user" }, "name": "my-gitlab-registry", "registryHost": "registry.gitlab.com", "status": "Active" } } }, "schema": { "$ref": "#/components/schemas/RegistryPatch" } }, "application/merge-patch+json": { "examples": { "AWS": { "value": { "configuration": { "$type": "AWS", "accessKey": "example-access-key", "authenticationRequired": true, "region": "us-east-2", "secretAccessKey": "example-secret-key" }, "name": "my-ecr-registry", "registryHost": "123456789012.dkr.ecr.us-east-2.amazonaws.com", "status": "Active" } }, "Azure": { "value": { "configuration": { "$type": "Azure", "password": "example-password", "userName": "example-user" }, "name": "my-azure-registry", "registryHost": "myproject.azurecr.io", "status": "Active" } }, "Custom": { "value": { "configuration": { "$type": "Custom", "authEnabled": true, "password": "example-password", "userName": "example-user" }, "name": "my-custom-registry", "registryHost": "localhost:9965", "status": "Active" } }, "DockerHub": { "value": { "configuration": { "$type": "DockerHub", "pat": "example-token", "userName": "example-user" }, "name": "my-dockerhub-registry", "status": "Active" } }, "GitHub": { "value": { "configuration": { "$type": "GitHub", "ghcrAuthEnabled": true, "nameSpace": "citadel-p", "pat": "example-token" }, "name": "my-github-registry", "status": "Active" } }, "Gitlab": { "value": { "configuration": { "$type": "Gitlab", "instanceUrl": "https://gitlab.com", "pat": "example-token", "userName": "example-user" }, "name": "my-gitlab-registry", "registryHost": "registry.gitlab.com", "status": "Active" } } }, "schema": { "$ref": "#/components/schemas/RegistryPatch" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistryView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Update a Registry", "tags": [ "Registries" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/registries/{id}/_cfg": { "get": { "operationId": "getRegistryConfig", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistryConfigResponse" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get Registry configuration", "tags": [ "Registries" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/registries/{id}/_metadata": { "patch": { "operationId": "updateRegistryMetadata", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchResourceMetadataInput" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/PatchResourceMetadataInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistryView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Update Registry metadata", "tags": [ "Registries" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/registries/{id}/tags": { "get": { "operationId": "getRegistryTags", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceTagsResponse" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get Registry tags", "tags": [ "Registries" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "put": { "operationId": "replaceRegistryTags", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplaceResourceTagsInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceTagsResponse" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Replace Registry tags", "tags": [ "Registries" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/resourceBindings/global": { "get": { "operationId": "getGlobalResourceBindings", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlobalBindingsResponse" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get global resource bindings", "tags": [ "ResourceBindings" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "patch": { "operationId": "updateGlobalResourceBinding", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceBindingInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceBindingsView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Update a global resource binding", "tags": [ "ResourceBindings" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "post": { "operationId": "createGlobalResourceBinding", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewResourceBinding" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceBindingsView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Create a global resource binding", "tags": [ "ResourceBindings" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/resourceBindings/global/{id}": { "delete": { "operationId": "deleteGlobalResourceBinding", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceBindingsView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Delete a global resource binding", "tags": [ "ResourceBindings" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/resourceBindings/secret-providers": { "get": { "operationId": "listSecretProviders", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretProvidersResponse" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "List Secret providers", "tags": [ "ResourceBindings" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/resourceBindings/secret-providers/vault-kv2": { "post": { "operationId": "createVaultKvV2SecretProvider", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretProviderInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretProviderView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Create a Vault-compatible KV v2 Secret provider", "tags": [ "ResourceBindings" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/resourceBindings/secret-providers/vault-kv2/test": { "post": { "operationId": "testVaultKvV2SecretProviderConnection", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestSecretProviderInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretTestResult" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Test a Vault-compatible KV v2 Secret provider connection", "tags": [ "ResourceBindings" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/resourceBindings/secret-providers/vault-kv2/{id}": { "patch": { "operationId": "updateVaultKvV2SecretProvider", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretProviderPatch" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/SecretProviderPatch" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretProviderView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Update a Vault-compatible KV v2 Secret provider", "tags": [ "ResourceBindings" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/resourceBindings/secret-providers/{id}": { "delete": { "operationId": "deleteSecretProvider", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Delete a Secret provider", "tags": [ "ResourceBindings" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/resourceBindings/secrets": { "get": { "operationId": "listSecretDefinitions", "parameters": [ { "in": "query", "name": "scope", "required": false, "schema": { "$ref": "#/components/schemas/ResourceBindingScope" } }, { "in": "query", "name": "resourceId", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "targetResourceType", "required": false, "schema": { "$ref": "#/components/schemas/ResourceType" } }, { "in": "query", "name": "targetResourceId", "required": false, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretDefinitionsResponse" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "List Secret definitions", "tags": [ "ResourceBindings" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "post": { "operationId": "createInternalSecret", "parameters": [ { "in": "query", "name": "scope", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "resourceId", "required": false, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalSecretInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretDefinitionView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Create an internal encrypted Secret", "tags": [ "ResourceBindings" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/resourceBindings/secrets/external": { "post": { "operationId": "createExternalSecret", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalSecretInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretDefinitionView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Create an external Secret definition", "tags": [ "ResourceBindings" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/resourceBindings/secrets/external/test": { "post": { "operationId": "testExternalSecret", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestExternalSecretInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretTestResult" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Test an external Secret reference", "tags": [ "ResourceBindings" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/resourceBindings/secrets/external/{id}": { "patch": { "operationId": "updateExternalSecret", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalSecretPatch" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/ExternalSecretPatch" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretDefinitionView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Update an external Secret definition", "tags": [ "ResourceBindings" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/resourceBindings/secrets/{id}": { "delete": { "operationId": "deleteSecretDefinition", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Delete an unused Secret definition", "tags": [ "ResourceBindings" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/resourceBindings/{scope}/{resourceId}": { "get": { "operationId": "getResourceBindings", "parameters": [ { "in": "path", "name": "scope", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "resourceId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceBindingsView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get resource bindings", "tags": [ "ResourceBindings" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "patch": { "operationId": "updateResourceBinding", "parameters": [ { "in": "path", "name": "scope", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "resourceId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceBindingInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceBindingsView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Update a resource binding", "tags": [ "ResourceBindings" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "post": { "operationId": "createResourceBinding", "parameters": [ { "in": "path", "name": "scope", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "resourceId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewResourceBinding" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceBindingsView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Create a resource binding", "tags": [ "ResourceBindings" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/resourceBindings/{scope}/{resourceId}/{id}": { "delete": { "operationId": "deleteResourceBinding", "parameters": [ { "in": "path", "name": "scope", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "resourceId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceBindingsView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Delete a resource binding", "tags": [ "ResourceBindings" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/stacks": { "delete": { "operationId": "deleteStacks", "requestBody": { "content": { "application/json": { "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } } }, "required": true }, "responses": { "204": { "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Delete Stacks", "tags": [ "Stacks" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "get": { "operationId": "listStacks", "parameters": [ { "in": "query", "name": "tags", "required": false, "schema": { "items": { "type": "string" }, "type": "array" } }, { "in": "query", "name": "platformId", "required": false, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StacksView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "List authorized Stacks", "tags": [ "Stacks" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "post": { "operationId": "createStack", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateStackInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StackView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Create a Stack", "tags": [ "Stacks" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/stacks/apply": { "post": { "operationId": "applyStack", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplyStackInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/StackStreamItem" }, "type": "array" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Apply a Stack and stream progress", "tags": [ "Stacks" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/stacks/pause": { "post": { "operationId": "pauseStacks", "requestBody": { "content": { "application/json": { "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } } }, "required": true }, "responses": { "204": { "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Pause Stacks", "tags": [ "Stacks" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/stacks/preflight/swarm": { "post": { "operationId": "preflightSwarmStack", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwarmPreflightInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwarmStackCompatibilityReport" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Validate Docker Swarm Stack compatibility", "tags": [ "Stacks" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/stacks/rename": { "post": { "operationId": "renameStack", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RenameStackInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StackView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Rename a Stack", "tags": [ "Stacks" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/stacks/restart": { "post": { "operationId": "restartStacks", "requestBody": { "content": { "application/json": { "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } } }, "required": true }, "responses": { "204": { "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Restart Stacks", "tags": [ "Stacks" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/stacks/resume": { "post": { "operationId": "resumeStacks", "requestBody": { "content": { "application/json": { "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } } }, "required": true }, "responses": { "204": { "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Resume Stacks", "tags": [ "Stacks" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/stacks/rollback": { "post": { "operationId": "rollbackStack", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RollbackStackInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/StackStreamItem" }, "type": "array" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Roll back a Stack and stream progress", "tags": [ "Stacks" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/stacks/start": { "post": { "operationId": "startStacks", "requestBody": { "content": { "application/json": { "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } } }, "required": true }, "responses": { "204": { "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Start Stacks", "tags": [ "Stacks" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/stacks/stop": { "post": { "operationId": "stopStacks", "requestBody": { "content": { "application/json": { "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } } }, "required": true }, "responses": { "204": { "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Stop Stacks", "tags": [ "Stacks" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/stacks/{id}": { "patch": { "operationId": "updateStack", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchStackInput" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/PatchStackInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StackView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Update Stack configuration", "tags": [ "Stacks" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/stacks/{id}/_metadata": { "patch": { "operationId": "updateStackMetadata", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchStackMetadataInput" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/PatchStackMetadataInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StackView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Update Stack metadata", "tags": [ "Stacks" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/stacks/{stackId}": { "get": { "operationId": "getStack", "parameters": [ { "in": "path", "name": "stackId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StackView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get a Stack", "tags": [ "Stacks" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/stacks/{stackId}/_cfg": { "get": { "operationId": "getStackConfig", "parameters": [ { "in": "path", "name": "stackId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StackConfigView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get Stack configuration", "tags": [ "Stacks" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/stacks/{stackId}/backup-source-preview": { "get": { "operationId": "getStackBackupSourcePreview", "parameters": [ { "in": "path", "name": "stackId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupSourcePreview" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "502": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Gateway" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Preview Stack Backup volumes", "tags": [ "Stacks" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/stacks/{stackId}/check-updates": { "post": { "operationId": "checkStackUpdates", "parameters": [ { "in": "path", "name": "stackId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StackView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "502": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Gateway" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Check a Stack source for updates", "tags": [ "Stacks" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/stacks/{stackId}/containers/{containerId}/inspect": { "get": { "operationId": "inspectStackContainer", "parameters": [ { "in": "path", "name": "stackId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "containerId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContainerInspectionView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "502": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Gateway" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Inspect a Stack Container with sensitive environment values redacted", "tags": [ "Stacks" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/stacks/{stackId}/data": { "get": { "operationId": "getContainersData", "parameters": [ { "in": "path", "name": "stackId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContainerRuntimeListView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get Stack runtime containers", "tags": [ "Stacks" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/stacks/{stackId}/drift": { "get": { "operationId": "getStackDrift", "parameters": [ { "in": "path", "name": "stackId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StackDriftReport" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get Stack drift", "tags": [ "Stacks" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/stacks/{stackId}/drift-policy": { "put": { "operationId": "updateStackDriftPolicy", "parameters": [ { "in": "path", "name": "stackId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StackDriftPolicyInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StackView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Update Stack drift policy", "tags": [ "Stacks" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/stacks/{stackId}/duplicate-draft": { "get": { "operationId": "getStackDuplicateDraft", "parameters": [ { "in": "path", "name": "stackId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StackDuplicateDraftView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Build a Stack duplicate draft", "tags": [ "Stacks" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/stacks/{stackId}/reconcile": { "post": { "operationId": "reconcileStack", "parameters": [ { "in": "path", "name": "stackId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StackReconciliationResult" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Reconcile safe Stack drift", "tags": [ "Stacks" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/stacks/{stackId}/releases": { "get": { "operationId": "listStackReleases", "parameters": [ { "in": "path", "name": "stackId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StackReleasesView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "List previous healthy Stack releases", "tags": [ "Stacks" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/stacks/{stackId}/stats": { "get": { "operationId": "getStackStats", "parameters": [ { "in": "path", "name": "stackId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "hours", "required": false, "schema": { "$ref": "#/components/schemas/StatsHours" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StackHistory" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get Stack Container statistics", "tags": [ "Stacks" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/stacks/{stackId}/tags": { "get": { "operationId": "getStackTags", "parameters": [ { "in": "path", "name": "stackId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceTagsResponse" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get Stack tags", "tags": [ "Stacks" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "put": { "operationId": "replaceStackTags", "parameters": [ { "in": "path", "name": "stackId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplaceResourceTagsInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceTagsResponse" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Replace Stack tags", "tags": [ "Stacks" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/swarmServices": { "delete": { "operationId": "deleteSwarmServices", "requestBody": { "content": { "application/json": { "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } } }, "required": true }, "responses": { "204": { "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Delete managed Docker Swarm Services", "tags": [ "SwarmServices" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "get": { "operationId": "listManagedSwarmServices", "parameters": [ { "in": "query", "name": "tags", "required": false, "schema": { "items": { "type": "string" }, "type": "array" } }, { "in": "query", "name": "platformId", "required": false, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedSwarmServicesView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "List managed Docker Swarm Services", "tags": [ "SwarmServices" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "post": { "operationId": "createSwarmService", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSwarmServiceInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedSwarmServiceView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Create a managed Docker Swarm Service", "tags": [ "SwarmServices" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/swarmServices/rename": { "post": { "operationId": "renameSwarmService", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RenameSwarmServiceInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedSwarmServiceView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Rename a managed Docker Swarm Service", "tags": [ "SwarmServices" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/swarmServices/{id}": { "get": { "operationId": "getManagedSwarmService", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedSwarmServiceView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get a managed Docker Swarm Service", "tags": [ "SwarmServices" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "patch": { "operationId": "updateSwarmService", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSwarmServiceInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedSwarmServiceView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Update managed Docker Swarm Service configuration", "tags": [ "SwarmServices" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/swarmServices/{id}/_metadata": { "patch": { "operationId": "updateSwarmServiceMetadata", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceMetadataInput" } }, "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/ServiceMetadataInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedSwarmServiceView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Update managed Service metadata", "tags": [ "SwarmServices" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/swarmServices/{id}/apply": { "post": { "operationId": "applySwarmService", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/SwarmServiceProgressItem" }, "type": "array" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Apply a managed Docker Swarm Service and stream progress", "tags": [ "SwarmServices" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/swarmServices/{id}/backup-source-preview": { "get": { "operationId": "getSwarmServiceBackupSourcePreview", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupSourcePreview" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "502": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Gateway" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Preview Service Backup volumes", "tags": [ "SwarmServices" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/swarmServices/{id}/check-updates": { "post": { "operationId": "checkSwarmServiceUpdates", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedSwarmServiceView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "502": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Gateway" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Check the applied Service image for updates", "tags": [ "SwarmServices" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/swarmServices/{id}/duplicate-draft": { "get": { "operationId": "getSwarmServiceDuplicateDraft", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwarmServiceDuplicateDraftView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Prepare a managed Service duplicate", "tags": [ "SwarmServices" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/swarmServices/{id}/force-update": { "post": { "operationId": "forceUpdateSwarmService", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/SwarmServiceProgressItem" }, "type": "array" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Force a managed Docker Swarm Service task update and stream progress", "tags": [ "SwarmServices" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/swarmServices/{id}/inspect": { "get": { "operationId": "inspectManagedSwarmService", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceInspectionView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Inspect the deployed managed Service", "tags": [ "SwarmServices" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/swarmServices/{id}/logs": { "get": { "operationId": "getManagedSwarmServiceLogs", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "tail", "required": false, "schema": { "default": 100, "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogSnapshot" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "502": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Gateway" }, "503": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Read managed Service logs", "tags": [ "SwarmServices" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/swarmServices/{id}/scale": { "post": { "operationId": "scaleSwarmService", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScaleSwarmServiceInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/SwarmServiceProgressItem" }, "type": "array" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Service Unavailable" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Scale a managed Docker Swarm Service and stream progress", "tags": [ "SwarmServices" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/swarmServices/{id}/tags": { "get": { "operationId": "getSwarmServiceTags", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceTagsResponse" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Get SwarmService tags", "tags": [ "SwarmServices" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "put": { "operationId": "replaceSwarmServiceTags", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplaceResourceTagsInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceTagsResponse" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Replace SwarmService tags", "tags": [ "SwarmServices" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/tags": { "get": { "operationId": "listTags", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagsResponse" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "List resource tags", "tags": [ "Tags" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "post": { "operationId": "createTag", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewTag" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Create a resource tag", "tags": [ "Tags" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/tags/{id}": { "delete": { "operationId": "deleteTag", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Delete a resource tag", "tags": [ "Tags" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "patch": { "operationId": "patchTag", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagPatch" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Update a resource tag", "tags": [ "Tags" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/volumes": { "delete": { "operationId": "deleteVolumes", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteVolumesInput" } } }, "required": true }, "responses": { "204": { "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Delete Volumes", "tags": [ "Volumes" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false }, "post": { "operationId": "createVolume", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateVolumeInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VolumeView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Not Found" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Create a Volume", "tags": [ "Volumes" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/volumes/{platformId}": { "get": { "operationId": "listVolumes", "parameters": [ { "in": "path", "name": "platformId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "Dangling", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "Driver", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "Name", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VolumesResponse" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "List Platform Volumes", "tags": [ "Volumes" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/api/v1/volumes/{platformId}/{name}": { "get": { "operationId": "inspectVolume", "parameters": [ { "in": "path", "name": "platformId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "dockerNodeId", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VolumeView" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Forbidden" }, "409": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Conflict" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [ { "Bearer": [] } ], "summary": "Inspect a Platform Volume", "tags": [ "Volumes" ], "x-citadel-principal": "actor", "x-citadel-public": true, "x-citadel-setup-exempt": false } }, "/health": { "get": { "operationId": "getHealth", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HealthResponse" } } }, "description": "Success" }, "400": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Bad Request" }, "429": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Internal Server Error" }, "default": { "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } }, "description": "Request failed" } }, "security": [], "summary": "Process liveness", "tags": [ "Diagnostics" ], "x-citadel-principal": "anonymous", "x-citadel-public": true, "x-citadel-setup-exempt": true } } } }