| Field | Value |
|---|
| Source spec | release-orchestrator/openapi/v1.json |
| OpenAPI version | 3.1.1 |
| API version | 1.0.0 |
| Operations | 387 |
| Path filter | All paths |
| Property | Value |
|---|
| Operation ID | ResourceAccess_EffectiveCombined |
| Tags | Resource Access |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
environmentId | query | no | |
releaseId | query | no | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
List operator-managed promotion approval policies for the calling tenant.
| Property | Value |
|---|
| Operation ID | ApprovalPolicy_List |
| Tags | Approval Policies |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
includeDisabled | query | no | |
name | query | no | |
releaseName | query | no | |
sourceEnvironment | query | no | |
targetEnvironment | query | no | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Create an operator-managed promotion approval policy.
| Property | Value |
|---|
| Operation ID | ApprovalPolicy_Create |
| Tags | Approval Policies |
| Auth | Not declared |
| Request body | application/json |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Return a single promotion approval policy by id.
| Property | Value |
|---|
| Operation ID | ApprovalPolicy_Get |
| Tags | Approval Policies |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Update an operator-managed promotion approval policy.
| Property | Value |
|---|
| Operation ID | ApprovalPolicy_Update |
| Tags | Approval Policies |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Disable an approval policy while retaining it for audit replay.
| Property | Value |
|---|
| Operation ID | ApprovalPolicy_Delete |
| Tags | Approval Policies |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
orchestrator.approval.list_description
| Property | Value |
|---|
| Operation ID | Approval_List |
| Tags | Approvals |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
environment | query | no | |
statuses | query | no | |
urgencies | query | no | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
orchestrator.approval.create_description
| Property | Value |
|---|
| Operation ID | Approval_BatchApprove |
| Tags | Approvals |
| Auth | Not declared |
| Request body | application/json |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Cancel multiple open (pending or expired) approvals in one call — queue hygiene for stale or duplicate promotion requests. Approvals in any other state are skipped and reported back.
| Property | Value |
|---|
| Operation ID | Approval_BatchCancel |
| Tags | Approvals |
| Auth | Not declared |
| Request body | application/json |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
orchestrator.approval.cancel_description
| Property | Value |
|---|
| Operation ID | Approval_BatchReject |
| Tags | Approvals |
| Auth | Not declared |
| Request body | application/json |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Create a developer-originated service image update approval request.
| Property | Value |
|---|
| Operation ID | Approval_CreateDeveloperUpdateRequest |
| Tags | Approvals |
| Auth | Not declared |
| Request body | application/json |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
orchestrator.approval.get_description
| Property | Value |
|---|
| Operation ID | Approval_Get |
| Tags | Approvals |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
orchestrator.approval.approve_description
| Property | Value |
|---|
| Operation ID | Approval_Approve |
| Tags | Approvals |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
orchestrator.approval.reject_description
| Property | Value |
|---|
| Operation ID | Approval_Reject |
| Tags | Approvals |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Return a consolidated release dashboard snapshot for the Console control plane, including pending approvals, active promotions, recent deployments, and environment health indicators. Used by the UI to populate the main release management view.
| Property | Value |
|---|
| Operation ID | - |
| Tags | ReleaseDashboard |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | Deployment_List |
| Tags | Deployments |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
environment | query | no | |
environments | query | no | |
page | query | no | |
pageSize | query | no | |
releaseId | query | no | |
releases | query | no | |
sortField | query | no | |
sortOrder | query | no | |
status | query | no | |
statuses | query | no | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | Deployment_Create |
| Tags | Deployments |
| Auth | Not declared |
| Request body | application/json |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | Deployment_Get |
| Tags | Deployments |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | Deployment_Cancel |
| Tags | Deployments |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | Deployment_GetEvents |
| Tags | Deployments |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | Deployment_GetLogs |
| Tags | Deployments |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
level | query | no | |
limit | query | no | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | Deployment_GetMetrics |
| Tags | Deployments |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | Deployment_Pause |
| Tags | Deployments |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | Deployment_Resume |
| Tags | Deployments |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | Deployment_Rollback |
| Tags | Deployments |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | DeploymentShare_Create |
| Tags | Deployment Share Grants |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | DeploymentShare_List |
| Tags | Deployment Share Grants |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | Deployment_GetTargetLogs |
| Tags | Deployments |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
targetId | path | yes | |
level | query | no | |
limit | query | no | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
The response body is { "entries": DeploymentLogEntry[] }. For real-engine terminal deployments, entries are persisted from the matched target task only: already-redacted stdout/stderr/output, or the allowlisted Compose execution facts (projectName, services, runtime verification, and completed phases). The route never synthesizes output for a task that returned none. targetId, level, and limit filters apply after tenant + deployment scoping.
| Property | Value |
|---|
| Operation ID | Deployment_RetryTarget |
| Tags | Deployments |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
targetId | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
List operator-managed environment-to-policy-pack bindings for the calling tenant.
| Property | Value |
|---|
| Operation ID | EnvironmentPolicyBinding_List |
| Tags | Environment Policy Bindings |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
includeDisabled | query | no | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Return the environment policy binding for a single environment, if any.
| Property | Value |
|---|
| Operation ID | EnvironmentPolicyBinding_Get |
| Tags | Environment Policy Bindings |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
environment | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Insert or update the policy-pack binding for an environment (idempotent).
| Property | Value |
|---|
| Operation ID | EnvironmentPolicyBinding_Upsert |
| Tags | Environment Policy Bindings |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
environment | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Soft-delete the policy-pack binding for an environment (sets enabled=false).
| Property | Value |
|---|
| Operation ID | EnvironmentPolicyBinding_Delete |
| Tags | Environment Policy Bindings |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
environment | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | EnvironmentAccess_List |
| Tags | Resource Access |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | EnvironmentAccess_Create |
| Tags | Resource Access |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | EnvironmentAccess_Effective |
| Tags | Resource Access |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | EnvironmentAccess_Transfer |
| Tags | Resource Access |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | EnvironmentAccess_Revoke |
| Tags | Resource Access |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
grantId | path | yes | |
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Return a paginated list of evidence packets for the calling tenant, optionally filtered by release, type, and creation time window. Each packet includes its identifier, associated release, evidence type, content hash, and creation timestamp.
| Property | Value |
|---|
| Operation ID | Evidence_List |
| Tags | Evidence |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
page | query | no | |
pageSize | query | no | |
releaseId | query | no | |
search | query | no | |
sortField | query | no | |
sortOrder | query | no | |
type | query | no | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Submit a verified release evidence packet. The service recomputes the payload hash before storing the packet so promotion and deployment gates can rely on durable evidence truth.
| Property | Value |
|---|
| Operation ID | Evidence_Create |
| Tags | Evidence |
| Auth | Not declared |
| Request body | application/json |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Return the full evidence packet record for the specified ID including release association, evidence type, content hash, algorithm, size, and metadata. Returns 404 when the evidence packet does not exist in the tenant.
| Property | Value |
|---|
| Operation ID | Evidence_Get |
| Tags | Evidence |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Export the specified evidence packet as a self-contained JSON bundle suitable for offline audit. The bundle includes the evidence metadata, content, and verification hashes.
| Property | Value |
|---|
| Operation ID | Evidence_Export |
| Tags | Evidence |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Download the raw binary content of the specified evidence packet. Returns the unprocessed evidence payload with Content-Type application/octet-stream. Returns 404 when the evidence packet does not exist.
| Property | Value |
|---|
| Operation ID | Evidence_DownloadRaw |
| Tags | Evidence |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Return the chronological event timeline for the specified evidence packet including creation, verification, export, and access events. Useful for audit trails and provenance tracking.
| Property | Value |
|---|
| Operation ID | Evidence_Timeline |
| Tags | Evidence |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Verify the integrity of the specified evidence packet by recomputing and comparing its content hash. Returns the verification result including the computed hash, algorithm used, and whether the content matches the stored digest.
| Property | Value |
|---|
| Operation ID | Evidence_Verify |
| Tags | Evidence |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Return the server-canonical operator-decision@v1 payload and DSSE PAE bytes for a release governance action.
| Property | Value |
|---|
| Operation ID | OperatorDecision_Prepare |
| Tags | Operator Decisions |
| Auth | Not declared |
| Request body | application/json |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Record an approval decision on the specified pending promotion request, allowing the associated release to advance to the next environment. The calling principal must hold the release approval scope. Returns 404 when the promotion ID does not exist.
| Property | Value |
|---|
| Operation ID | - |
| Tags | ReleaseDashboard |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Record a rejection decision on the specified pending promotion request with an optional rejection reason, blocking the release from advancing. The calling principal must hold the release approval scope. Returns 404 when the promotion ID does not exist.
| Property | Value |
|---|
| Operation ID | - |
| Tags | ReleaseDashboard |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Return the effective administrator release environment limit for the calling tenant. Stored settings override deployment configuration.
| Property | Value |
|---|
| Operation ID | ReleaseEnvironmentLimit_Get |
| Tags | Release Environment Limits |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Persist the administrator release environment allow-list for the calling tenant.
| Property | Value |
|---|
| Operation ID | ReleaseEnvironmentLimit_Update |
| Tags | Release Environment Limits |
| Auth | Not declared |
| Request body | application/json |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Return the tenant-scoped reverse release impact for a CVE or advisory identifier. The response contains currentImpact.releases, approvals, promotions, environments, gateVerdicts, reachableCves, and evidenceLinks, all sorted deterministically for FE diffing. Example response shape: { identifier, normalizedIdentifier, empty, currentImpact: { releases, approvals, promotions, environments, gateVerdicts, reachableCves, evidenceLinks }, timeline: { current, historical } }. timeline.current contains the current matching verdict rows; timeline.historical contains older matching gate-decision rows and does not contribute to currentImpact. Empty matches return 200 with empty=true and empty arrays; a missing identifier returns 400 identifier_required.
| Property | Value |
|---|
| Operation ID | ReleaseImpact_Query |
| Tags | Release Impact |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
identifier | query | no | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Return a paginated list of releases for the calling tenant, optionally filtered by status, environment, project, and creation time window. Each release record includes its name, version, current status, component count, and lifecycle timestamps.
| Property | Value |
|---|
| Operation ID | Release_List |
| Tags | Releases |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
access | query | no | |
environment | query | no | |
page | query | no | |
pageSize | query | no | |
search | query | no | |
sortField | query | no | |
sortOrder | query | no | |
statuses | query | no | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Create a new release record in Draft state. The release captures an intent to promote a versioned set of components through defined environments. Returns 409 if a release with the same name and version already exists.
| Property | Value |
|---|
| Operation ID | Release_Create |
| Tags | Releases |
| Auth | Not declared |
| Request body | application/json |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Return a paginated feed of release activities across all releases, optionally filtered by environment, outcome, and time window.
| Property | Value |
|---|
| Operation ID | Release_Activity |
| Tags | Releases |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
environment | query | no | |
limit | query | no | |
outcome | query | no | |
releaseId | query | no | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Return the most recent release with the given name, including structured metadata for smart defaults when creating a new version. Used by the release creation wizard to auto-fill from the previous version.
| Property | Value |
|---|
| Operation ID | Release_LatestByName |
| Tags | Releases |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
name | query | no | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Suggest the next semantic version for a release name based on the latest existing version. Returns the suggested version string and the source release ID.
| Property | Value |
|---|
| Operation ID | Release_SuggestVersion |
| Tags | Releases |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
currentVersion | query | no | |
name | query | no | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Return a filtered list of release versions, optionally filtered by gate status.
| Property | Value |
|---|
| Operation ID | Release_Versions |
| Tags | Releases |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
gateStatus | query | no | |
limit | query | no | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Return the full release record for the specified ID including name, version, status, component list, approval gate state, and event history summary. Returns 404 when the release does not exist in the tenant.
| Property | Value |
|---|
| Operation ID | Release_Get |
| Tags | Releases |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Permanently remove the specified release record. Only releases in Draft or Failed status can be deleted; returns 409 for releases in other states. All associated components and events are removed with the release record.
| Property | Value |
|---|
| Operation ID | Release_Delete |
| Tags | Releases |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Update mutable metadata on the specified release including description, target environment, and custom labels. Status transitions must be performed through the dedicated lifecycle endpoints. Returns 404 when the release does not exist.
| Property | Value |
|---|
| Operation ID | Release_Update |
| Tags | Releases |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | ReleaseAccess_List |
| Tags | Resource Access |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | ReleaseAccess_Create |
| Tags | Resource Access |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | ReleaseAccess_Effective |
| Tags | Resource Access |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | ReleaseAccess_Transfer |
| Tags | Resource Access |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | ReleaseAccess_Revoke |
| Tags | Resource Access |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
grantId | path | yes | |
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Create a new release by copying the components, labels, and target environment from the specified source release, applying a new name and version. The cloned release starts in Draft state and is independent of the source.
| Property | Value |
|---|
| Operation ID | Release_Clone |
| Tags | Releases |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Trigger deployment of the specified release to its current target environment. Deployment is orchestrated by the platform and may include pre-deployment checks, artifact staging, and post-deployment validation. Returns 409 if gates have not been satisfied.
| Property | Value |
|---|
| Operation ID | Release_Deploy |
| Tags | Releases |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
preflightOverrideJustification | query | no | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Initiate the promotion workflow to advance the specified release to its next target environment, triggering policy gate evaluation. The promotion runs asynchronously; poll the release record or subscribe to events for outcome updates.
The target may be supplied as a legacy env-* alias, environment name, or UUID. When it resolves, the persisted approval uses the canonical environment name and its configured RequiredApprovals (minimum one). A positive requiredApprovals supplied by the evaluated gate/policy decision overrides that initial environment quorum. Unresolved legacy references retain the compatibility quorum of two.
| Property | Value |
|---|
| Operation ID | Release_Promote |
| Tags | Releases |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Transition the specified release from Draft to Ready state, signalling that all components are assembled and the release is eligible for promotion gate evaluation. Returns 409 if the release is not in Draft state or required components are missing.
| Property | Value |
|---|
| Operation ID | Release_MarkReady |
| Tags | Releases |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Initiate a rollback of the specified deployed release to the previous stable version in the current environment. The rollback is audited and creates a new release event. Returns 409 if the release is not in Deployed state or no prior stable version exists.
| Property | Value |
|---|
| Operation ID | Release_Rollback |
| Tags | Releases |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Return per-component version currency for the specified release: which components have a STRICTLY-NEWER version that the registry actually serves (never a guessed version/digest), which are up to date, and which could not be checked (registry unreachable/unresolved). Read-only — surfacing an update never deploys; the one-click draft rides the Editor-gated create-version endpoint referenced by each row’s actionEndpoint.
| Property | Value |
|---|
| Operation ID | Release_Updates |
| Tags | Releases |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Create a new draft release version from an existing release when a component artifact digest changes. The new version copies source release metadata and components, replaces only the changed component digest/reference, and applies administrator environment scope limits.
| Property | Value |
|---|
| Operation ID | Release_CreateVersionFromArtifactUpdate |
| Tags | Releases |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Return the list of environment targets that the specified release can be promoted to from its current state, based on the configured promotion pipeline and the caller’s access rights. Returns 404 when the release does not exist.
| Property | Value |
|---|
| Operation ID | Release_AvailableEnvironments |
| Tags | Releases |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
releaseId | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Return the list of components registered in the specified release including their artifact references, versions, content digests, and current deployment status. Returns 404 when the release does not exist.
| Property | Value |
|---|
| Operation ID | Release_GetComponents |
| Tags | Releases |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
releaseId | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Register a new component in the specified release, supplying the artifact reference and content digest. Components must be added before the release is marked Ready. Returns 409 if a component with the same name is already registered.
| Property | Value |
|---|
| Operation ID | Release_AddComponent |
| Tags | Releases |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
releaseId | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Remove the specified component from the release. Only permitted when the release is in Draft state; returns 409 for releases that are Ready or beyond. Returns 404 when the component or release does not exist in the tenant.
| Property | Value |
|---|
| Operation ID | Release_RemoveComponent |
| Tags | Releases |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
componentId | path | yes | |
releaseId | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Update the artifact reference, version, or content digest of the specified release component. Returns 404 when the component does not exist within the release or the release itself does not exist in the tenant.
| Property | Value |
|---|
| Operation ID | Release_UpdateComponent |
| Tags | Releases |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
componentId | path | yes | |
releaseId | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Operator-triggered “scan now when unknown”: trigger a Scanner scan for the named release component (resolved to its pinned image reference + digest) so an absent/pending/failed SBOM-readiness gate can be satisfied. Requires scanner:scan + release:read.
| Property | Value |
|---|
| Operation ID | - |
| Tags | Releases |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
componentName | path | yes | |
releaseId | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Return the honest deployment strategy plan preview for the specified release into the given environment (?environmentId=) under a requested strategy (?strategy=rolling|canary|blue_green|all_at_once). The response mirrors the REAL strategy batching (phases: index + per-phase target count) plus the effective behaviour and honest caveats: single-target-collapse (with one target, canary/blue-green/rolling collapse to a single all-at-once deploy) and no-traffic-management (canary/blue-green do phased TARGET rollout, not traffic splitting; cutover is external). Unknown/unresolvable target count returns an honest cannot-preview, never a fabricated plan. Read-only — it never deploys.
| Property | Value |
|---|
| Operation ID | Release_DeployPlan |
| Tags | Releases |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
releaseId | path | yes | |
environmentId | query | no | |
strategy | query | no | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Return the pre-launch deployment readiness checklist for the specified release into the given environment (?environmentId=). Each row is tri-state (pass/fail/unknown); a fail carries the deployment failure anatomy (plain reason + action). armed is true iff no check hard-failed. Honest: unknown (a probe that could not determine the answer) is surfaced as a caution, never a false pass and never a lone blocker. Floor-independent preview — it never deploys.
| Property | Value |
|---|
| Operation ID | Release_DeployPreflight |
| Tags | Releases |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
releaseId | path | yes | |
environmentId | query | no | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Return the chronological event log for the specified release including status transitions, gate evaluations, approval decisions, deployment actions, and rollback events. Useful for audit trails and post-incident analysis.
| Property | Value |
|---|
| Operation ID | Release_GetEvents |
| Tags | Releases |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
releaseId | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Evaluate and return the gate check results for the specified release’s next promotion without committing any state change. Returns the verdict for each configured policy gate so operators can assess promotion eligibility before triggering it.
The preview resolves targetEnvironmentId by environment UUID or name; when the query is omitted it uses the release’s configured target. targetEnvironment, requiredApprovers, and requiresHumanApproval come from that resolved environment so the preview matches the promotion contract. Unresolved legacy references retain the compatibility fallback (staging, two approvers).
| Property | Value |
|---|
| Operation ID | Release_PromotionPreview |
| Tags | Releases |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
releaseId | path | yes | |
targetEnvironmentId | query | no | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | DeploymentShare_Get |
| Tags | Deployment Share Grants |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
grantId | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | DeploymentShare_Revoke |
| Tags | Deployment Share Grants |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
grantId | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | DeploymentShare_Patch |
| Tags | Deployment Share Grants |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
grantId | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | DeploymentShare_Accept |
| Tags | Deployment Share Grants |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
grantId | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | DeploymentShare_Approve |
| Tags | Deployment Share Grants |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
grantId | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
List available agents
| Property | Value |
|---|
| Operation ID | ListAgents |
| Tags | Topology Agents |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Request deletion of a agent
| Property | Value |
|---|
| Operation ID | RequestDeleteAgent |
| Tags | Topology Deletion |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
503 | Service Unavailable | - |
Return the v2 approval queue for the calling tenant, including per-request digest confidence, reachability-weighted risk score, and ops-data integrity score. Optionally filtered by status and target environment. Designed for the enhanced approval UX.
| Property | Value |
|---|
| Operation ID | ApprovalsV2_List |
| Tags | Approvals v2 |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
status | query | no | |
targetEnvironment | query | no | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Return the v2 decision packet for the specified approval, including the full policy gate evaluation trace, reachability-adjusted finding counts, confidence bands, and all structured evidence references required to make an informed approval decision.
| Property | Value |
|---|
| Operation ID | ApprovalsV2_Get |
| Tags | Approvals v2 |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Apply a structured decision action (approve, reject, defer, escalate) to the specified v2 approval, attributing the decision to the calling principal with an optional comment. Returns 409 if the approval is not in a state that accepts decisions.
| Property | Value |
|---|
| Operation ID | ApprovalsV2_Decision |
| Tags | Approvals v2 |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Return the structured evidence reference set attached to the specified v2 approval decision packet, including SBOM digests, attestation references, scan results, and provenance records. Used to verify the completeness of the evidence chain before approving.
| Property | Value |
|---|
| Operation ID | ApprovalsV2_Evidence |
| Tags | Approvals v2 |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Override (bypass) a blocking release gate via a signed, audited gate exception. Requires the dedicated release:gate-bypass scope and a verified operator decision envelope (DSSE) signed with the operator’s platform key, plus a justification and an explicit risk acknowledgement. The targeted gate is flipped to a non-blocking EXCEPTION state so the promotion can be approved; it does NOT auto-approve. 403 without the scope or a valid signature; 404 if the gate is unknown; 409 if the gate is not in a blocking state.
| Property | Value |
|---|
| Operation ID | ApprovalsV2_GateException |
| Tags | Approvals v2 |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Return the detailed gate evaluation trace for the specified v2 approval, showing each policy gate’s inputs, computed verdict, confidence weight, and any override history. Used by approvers to understand the basis for automated gate results.
| Property | Value |
|---|
| Operation ID | ApprovalsV2_Gates |
| Tags | Approvals v2 |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Return the operational data-integrity confidence indicators for the specified approval, including staleness of scan data, missing coverage gaps, and pipeline signal freshness. Low confidence scores reduce the defensibility of approval decisions.
| Property | Value |
|---|
| Operation ID | ApprovalsV2_OpsHealth |
| Tags | Approvals v2 |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Return deterministic replay status for the specified approval decision packet, including the decision digest and replay log reference used by the approval detail UI.
| Property | Value |
|---|
| Operation ID | ApprovalsV2_Replay |
| Tags | Approvals v2 |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Return the security snapshot computed for the specified approval context, including reachability-adjusted critical and high finding counts (CritR, HighR), SBOM coverage percentage, and the weighted risk score used in the approval decision packet.
| Property | Value |
|---|
| Operation ID | ApprovalsV2_SecuritySnapshot |
| Tags | Approvals v2 |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
API alias for /buildinfo.json (same payload).
| Property | Value |
|---|
| Operation ID | StellaOpsBuildInfoApi |
| Tags | StellaOps.ReleaseOrchestrator.WebApi |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
List tenant-scoped release components.
| Property | Value |
|---|
| Operation ID | Components_List |
| Tags | Components |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
search | query | no | |
status | query | no | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Create a tenant-scoped release component bound to a registry integration and image repository.
| Property | Value |
|---|
| Operation ID | Components_Create |
| Tags | Components |
| Auth | Not declared |
| Request body | application/json |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Update SCM provenance fields for a digest-pinned component version.
| Property | Value |
|---|
| Operation ID | Components_UpdateVersionScm |
| Tags | Components |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
componentId | path | yes | |
versionId | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Get one tenant-scoped release component.
| Property | Value |
|---|
| Operation ID | Components_Get |
| Tags | Components |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Retire a component without deleting historical versions.
| Property | Value |
|---|
| Operation ID | Components_Retire |
| Tags | Components |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Update mutable component registry metadata.
| Property | Value |
|---|
| Operation ID | Components_Update |
| Tags | Components |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Resolve repository tags to immutable digests and upsert component version-map rows.
| Property | Value |
|---|
| Operation ID | Components_SyncVersions |
| Tags | Components |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
List recorded component versions.
| Property | Value |
|---|
| Operation ID | Components_ListVersions |
| Tags | Components |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
channel | query | no | |
limit | query | no | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
List environments
| Property | Value |
|---|
| Operation ID | ListEnvironments |
| Tags | Topology Environments |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Create a new environment in the topology
| Property | Value |
|---|
| Operation ID | CreateEnvironment |
| Tags | Topology Environments |
| Auth | Not declared |
| Request body | application/json |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Return the standardized environment detail header for the specified environment ID, including its name, tier (dev/stage/prod), current active release, and promotion pipeline position. Used to populate the environment context in release dashboards.
| Property | Value |
|---|
| Operation ID | EnvironmentsV2_Get |
| Tags | Environments v2 |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Return the deployment history for the specified environment ordered by deployment timestamp descending, including each release version, deployment status, and rollback availability. Used for environment-scoped audit and change management views.
| Property | Value |
|---|
| Operation ID | EnvironmentsV2_Deployments |
| Tags | Environments v2 |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Return the evidence snapshot and export references for the specified environment, including the active attestation bundle, SBOM digest, scan result references, and the evidence locker ID for compliance archiving. Used for environment-level attestation workflows.
| Property | Value |
|---|
| Operation ID | EnvironmentsV2_Evidence |
| Tags | Environments v2 |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Rename a environment
| Property | Value |
|---|
| Operation ID | RenameEnvironment |
| Tags | Topology Rename |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
503 | Service Unavailable | - |
Return the operational data-confidence and health signals for the specified environment, including scan data staleness, missing SBOM coverage, pipeline signal freshness, and any active incidents affecting the environment’s reliability score.
| Property | Value |
|---|
| Operation ID | EnvironmentsV2_OpsHealth |
| Tags | Environments v2 |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Get readiness for all targets in an environment
| Property | Value |
|---|
| Operation ID | GetEnvironmentReadiness |
| Tags | Topology Readiness |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | application/json |
Request deletion of a environment
| Property | Value |
|---|
| Operation ID | RequestDeleteEnvironment |
| Tags | Topology Deletion |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
503 | Service Unavailable | - |
Return the current security posture snapshot for the specified environment, including reachability-adjusted critical and high finding counts, SBOM coverage, and the top-ranked risks by exploitability. Refreshed on each new deployment or scan cycle.
| Property | Value |
|---|
| Operation ID | EnvironmentsV2_SecuritySnapshot |
| Tags | Environments v2 |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
List bindings by scope
| Property | Value |
|---|
| Operation ID | ListInfrastructureBindings |
| Tags | Infrastructure Bindings |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
scopeId | query | no | |
scopeType | query | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | application/json |
Bind an integration to a scope
| Property | Value |
|---|
| Operation ID | CreateInfrastructureBinding |
| Tags | Infrastructure Bindings |
| Auth | Not declared |
| Request body | application/json |
Responses:
| Status | Description | Content types |
|---|
201 | Created | application/json |
Resolve a binding with inheritance cascade
| Property | Value |
|---|
| Operation ID | ResolveInfrastructureBinding |
| Tags | Infrastructure Bindings |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
environmentId | query | yes | |
role | query | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | application/json |
404 | Not Found | - |
Resolve all binding roles with inheritance
| Property | Value |
|---|
| Operation ID | ResolveAllInfrastructureBindings |
| Tags | Infrastructure Bindings |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
environmentId | query | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | application/json |
Remove an infrastructure binding
| Property | Value |
|---|
| Operation ID | DeleteInfrastructureBinding |
| Tags | Infrastructure Bindings |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
204 | No Content | - |
Test binding connectivity
| Property | Value |
|---|
| Operation ID | TestInfrastructureBinding |
| Tags | Infrastructure Bindings |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | application/json |
Fans out a discovery probe across all tenant-visible registry integrations to find which registries host the queried image repository. Returns per-(registry, repository) hits the operator can pin from in the component-add wizard.
| Property | Value |
|---|
| Operation ID | Integrations_RegistrySearch |
| Tags | Integrations |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
query | query | no | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Request deletion of a integration
| Property | Value |
|---|
| Operation ID | RequestDeleteIntegration |
| Tags | Topology Deletion |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
503 | Service Unavailable | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | JobEngine Legacy - Audit |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
actorId | query | no | |
cursor | query | no | |
endTime | query | no | |
eventType | query | no | |
limit | query | no | |
resourceId | query | no | |
resourceType | query | no | |
startTime | query | no | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Legacy jobengine compatibility endpoint - feature pending migration.
| Property | Value |
|---|
| Operation ID | - |
| Tags | JobEngine Legacy - dag |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Legacy jobengine compatibility endpoint - feature pending migration.
| Property | Value |
|---|
| Operation ID | - |
| Tags | JobEngine Legacy - dag |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Legacy jobengine compatibility endpoint - feature pending migration.
| Property | Value |
|---|
| Operation ID | - |
| Tags | JobEngine Legacy - dag |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Legacy jobengine compatibility endpoint - feature pending migration.
| Property | Value |
|---|
| Operation ID | - |
| Tags | JobEngine Legacy - dag |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Legacy jobengine compatibility endpoint - feature pending migration.
| Property | Value |
|---|
| Operation ID | - |
| Tags | JobEngine Legacy - dag |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Legacy jobengine compatibility endpoint - feature pending migration.
| Property | Value |
|---|
| Operation ID | - |
| Tags | JobEngine Legacy - dag |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Legacy jobengine compatibility endpoint - feature pending migration.
| Property | Value |
|---|
| Operation ID | - |
| Tags | JobEngine Legacy - deadletter |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Legacy jobengine compatibility endpoint - feature pending migration.
| Property | Value |
|---|
| Operation ID | - |
| Tags | JobEngine Legacy - deadletter |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Legacy jobengine compatibility endpoint - feature pending migration.
| Property | Value |
|---|
| Operation ID | - |
| Tags | JobEngine Legacy - deadletter |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Legacy jobengine compatibility endpoint - feature pending migration.
| Property | Value |
|---|
| Operation ID | - |
| Tags | JobEngine Legacy - deadletter |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Legacy jobengine compatibility endpoint - feature pending migration.
| Property | Value |
|---|
| Operation ID | - |
| Tags | JobEngine Legacy - deadletter |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Legacy jobengine compatibility endpoint - feature pending migration.
| Property | Value |
|---|
| Operation ID | - |
| Tags | JobEngine Legacy - deadletter |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Legacy jobengine compatibility endpoint - feature pending migration.
| Property | Value |
|---|
| Operation ID | - |
| Tags | JobEngine Legacy - jobs |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Legacy jobengine compatibility endpoint - feature pending migration.
| Property | Value |
|---|
| Operation ID | - |
| Tags | JobEngine Legacy - jobs |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Legacy jobengine compatibility endpoint - feature pending migration.
| Property | Value |
|---|
| Operation ID | - |
| Tags | JobEngine Legacy - jobs |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Legacy jobengine compatibility endpoint - feature pending migration.
| Property | Value |
|---|
| Operation ID | - |
| Tags | JobEngine Legacy - jobs |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Legacy jobengine compatibility endpoint - feature pending migration.
| Property | Value |
|---|
| Operation ID | - |
| Tags | JobEngine Legacy - jobs |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Legacy jobengine compatibility endpoint - feature pending migration.
| Property | Value |
|---|
| Operation ID | - |
| Tags | JobEngine Legacy - jobs |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Legacy jobengine compatibility endpoint - feature pending migration.
| Property | Value |
|---|
| Operation ID | - |
| Tags | JobEngine Legacy - pack-runs |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Legacy jobengine compatibility endpoint - feature pending migration.
| Property | Value |
|---|
| Operation ID | - |
| Tags | JobEngine Legacy - pack-runs |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Legacy jobengine compatibility endpoint - feature pending migration.
| Property | Value |
|---|
| Operation ID | - |
| Tags | JobEngine Legacy - pack-runs |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Legacy jobengine compatibility endpoint - feature pending migration.
| Property | Value |
|---|
| Operation ID | - |
| Tags | JobEngine Legacy - pack-runs |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Legacy jobengine compatibility endpoint - feature pending migration.
| Property | Value |
|---|
| Operation ID | - |
| Tags | JobEngine Legacy - pack-runs |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Legacy jobengine compatibility endpoint - feature pending migration.
| Property | Value |
|---|
| Operation ID | - |
| Tags | JobEngine Legacy - pack-runs |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Legacy jobengine compatibility endpoint - feature pending migration.
| Property | Value |
|---|
| Operation ID | - |
| Tags | JobEngine Legacy - quotas |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Legacy jobengine compatibility endpoint - feature pending migration.
| Property | Value |
|---|
| Operation ID | - |
| Tags | JobEngine Legacy - quotas |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Legacy jobengine compatibility endpoint - feature pending migration.
| Property | Value |
|---|
| Operation ID | - |
| Tags | JobEngine Legacy - quotas |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Legacy jobengine compatibility endpoint - feature pending migration.
| Property | Value |
|---|
| Operation ID | - |
| Tags | JobEngine Legacy - quotas |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Legacy jobengine compatibility endpoint - feature pending migration.
| Property | Value |
|---|
| Operation ID | - |
| Tags | JobEngine Legacy - quotas |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Legacy jobengine compatibility endpoint - feature pending migration.
| Property | Value |
|---|
| Operation ID | - |
| Tags | JobEngine Legacy - quotas |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Legacy jobengine compatibility endpoint - feature pending migration.
| Property | Value |
|---|
| Operation ID | - |
| Tags | JobEngine Legacy - Runs |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Legacy jobengine compatibility endpoint - feature pending migration.
| Property | Value |
|---|
| Operation ID | - |
| Tags | JobEngine Legacy - Runs |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Legacy jobengine compatibility endpoint - feature pending migration.
| Property | Value |
|---|
| Operation ID | - |
| Tags | JobEngine Legacy - Runs |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Legacy jobengine compatibility endpoint - feature pending migration.
| Property | Value |
|---|
| Operation ID | - |
| Tags | JobEngine Legacy - Runs |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Legacy jobengine compatibility endpoint - feature pending migration.
| Property | Value |
|---|
| Operation ID | - |
| Tags | JobEngine Legacy - Runs |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Legacy jobengine compatibility endpoint - feature pending migration.
| Property | Value |
|---|
| Operation ID | - |
| Tags | JobEngine Legacy - Runs |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | JobEngine Legacy - Runs |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
If-None-Match | header | no | |
runId | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Legacy jobengine compatibility endpoint - feature pending migration.
| Property | Value |
|---|
| Operation ID | - |
| Tags | JobEngine Legacy - slos |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Legacy jobengine compatibility endpoint - feature pending migration.
| Property | Value |
|---|
| Operation ID | - |
| Tags | JobEngine Legacy - slos |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Legacy jobengine compatibility endpoint - feature pending migration.
| Property | Value |
|---|
| Operation ID | - |
| Tags | JobEngine Legacy - slos |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Legacy jobengine compatibility endpoint - feature pending migration.
| Property | Value |
|---|
| Operation ID | - |
| Tags | JobEngine Legacy - slos |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Legacy jobengine compatibility endpoint - feature pending migration.
| Property | Value |
|---|
| Operation ID | - |
| Tags | JobEngine Legacy - slos |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Legacy jobengine compatibility endpoint - feature pending migration.
| Property | Value |
|---|
| Operation ID | - |
| Tags | JobEngine Legacy - slos |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Legacy jobengine compatibility endpoint - feature pending migration.
| Property | Value |
|---|
| Operation ID | - |
| Tags | JobEngine Legacy - sources |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Legacy jobengine compatibility endpoint - feature pending migration.
| Property | Value |
|---|
| Operation ID | - |
| Tags | JobEngine Legacy - sources |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Legacy jobengine compatibility endpoint - feature pending migration.
| Property | Value |
|---|
| Operation ID | - |
| Tags | JobEngine Legacy - sources |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Legacy jobengine compatibility endpoint - feature pending migration.
| Property | Value |
|---|
| Operation ID | - |
| Tags | JobEngine Legacy - sources |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Legacy jobengine compatibility endpoint - feature pending migration.
| Property | Value |
|---|
| Operation ID | - |
| Tags | JobEngine Legacy - sources |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Legacy jobengine compatibility endpoint - feature pending migration.
| Property | Value |
|---|
| Operation ID | - |
| Tags | JobEngine Legacy - sources |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Legacy jobengine compatibility endpoint - feature pending migration.
| Property | Value |
|---|
| Operation ID | - |
| Tags | JobEngine Legacy - stream |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Legacy jobengine compatibility endpoint - feature pending migration.
| Property | Value |
|---|
| Operation ID | - |
| Tags | JobEngine Legacy - stream |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Legacy jobengine compatibility endpoint - feature pending migration.
| Property | Value |
|---|
| Operation ID | - |
| Tags | JobEngine Legacy - stream |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Legacy jobengine compatibility endpoint - feature pending migration.
| Property | Value |
|---|
| Operation ID | - |
| Tags | JobEngine Legacy - stream |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Legacy jobengine compatibility endpoint - feature pending migration.
| Property | Value |
|---|
| Operation ID | - |
| Tags | JobEngine Legacy - stream |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Legacy jobengine compatibility endpoint - feature pending migration.
| Property | Value |
|---|
| Operation ID | - |
| Tags | JobEngine Legacy - stream |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
List all pending deletions for the current tenant
| Property | Value |
|---|
| Operation ID | ListPendingDeletions |
| Tags | Topology Deletion |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | application/json |
Get pending deletion details with cascade summary
| Property | Value |
|---|
| Operation ID | GetPendingDeletion |
| Tags | Topology Deletion |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | application/json |
404 | Not Found | - |
Cancel a pending deletion
| Property | Value |
|---|
| Operation ID | CancelDeletion |
| Tags | Topology Deletion |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
204 | No Content | - |
Confirm a pending deletion after cool-off expires
| Property | Value |
|---|
| Operation ID | ConfirmDeletion |
| Tags | Topology Deletion |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
503 | Service Unavailable | - |
List all regions for the current tenant
| Property | Value |
|---|
| Operation ID | ListRegions |
| Tags | Regions |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | application/json |
Create a new region
| Property | Value |
|---|
| Operation ID | CreateRegion |
| Tags | Regions |
| Auth | Not declared |
| Request body | application/json |
Responses:
| Status | Description | Content types |
|---|
201 | Created | application/json |
Get a region by ID
| Property | Value |
|---|
| Operation ID | GetRegion |
| Tags | Regions |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | application/json |
404 | Not Found | - |
Update a region
| Property | Value |
|---|
| Operation ID | UpdateRegion |
| Tags | Regions |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | application/json |
Delete a region
| Property | Value |
|---|
| Operation ID | DeleteRegion |
| Tags | Regions |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
204 | No Content | - |
Rename a region
| Property | Value |
|---|
| Operation ID | RenameRegion |
| Tags | Topology Rename |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
503 | Service Unavailable | - |
Request deletion of a region
| Property | Value |
|---|
| Operation ID | RequestDeleteRegion |
| Tags | Topology Deletion |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
503 | Service Unavailable | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Registry Cache |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Registry Cache |
| Auth | Not declared |
| Request body | application/json |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Registry Cache |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
repository | query | no | |
scope | query | no | |
tenantId | query | no | |
upstreamSlug | query | no | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Registry Cache |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
repository | query | no | |
tenantId | query | no | |
upstreamSlug | query | no | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Registry Cache |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Registry Upstreams |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Registry Upstreams |
| Auth | Not declared |
| Request body | application/json |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Registry Upstreams |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
slug | query | no | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Registry Upstreams |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Resource Access |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
environmentId | query | no | |
releaseId | query | no | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Secret Admin |
| Auth | Not declared |
| Request body | application/json |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Tenant Admin |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
tenantId | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Tenant Admin |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
tenantId | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Tenant Admin |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
tenantId | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Agent Runtime |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
agentId | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Agent Runtime |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
agentId | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Agent Runtime |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
agentId | path | yes | |
taskId | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Agent Runtime |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
agentId | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Agent Registration |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
capability | query | no | |
status | query | no | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Agent Registration |
| Auth | Not declared |
| Request body | application/json |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Agent Registration |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Agent Registration |
| Auth | Not declared |
| Request body | application/json |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Agent Registration |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Environments |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
agentId | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Agent Registration |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Agent Registration |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
reason | query | no | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Agent Registration |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Agent Registration |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
List operator-managed promotion approval policies for the calling tenant.
| Property | Value |
|---|
| Operation ID | - |
| Tags | Approval Policies |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
includeDisabled | query | no | |
name | query | no | |
releaseName | query | no | |
sourceEnvironment | query | no | |
targetEnvironment | query | no | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Create an operator-managed promotion approval policy.
| Property | Value |
|---|
| Operation ID | - |
| Tags | Approval Policies |
| Auth | Not declared |
| Request body | application/json |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Return a single promotion approval policy by id.
| Property | Value |
|---|
| Operation ID | - |
| Tags | Approval Policies |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Update an operator-managed promotion approval policy.
| Property | Value |
|---|
| Operation ID | - |
| Tags | Approval Policies |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Disable an approval policy while retaining it for audit replay.
| Property | Value |
|---|
| Operation ID | - |
| Tags | Approval Policies |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
orchestrator.approval.list_description
| Property | Value |
|---|
| Operation ID | - |
| Tags | Approvals |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
environment | query | no | |
statuses | query | no | |
urgencies | query | no | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
orchestrator.approval.create_description
| Property | Value |
|---|
| Operation ID | - |
| Tags | Approvals |
| Auth | Not declared |
| Request body | application/json |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Cancel multiple open (pending or expired) approvals in one call — queue hygiene for stale or duplicate promotion requests. Approvals in any other state are skipped and reported back.
| Property | Value |
|---|
| Operation ID | - |
| Tags | Approvals |
| Auth | Not declared |
| Request body | application/json |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
orchestrator.approval.cancel_description
| Property | Value |
|---|
| Operation ID | - |
| Tags | Approvals |
| Auth | Not declared |
| Request body | application/json |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Create a developer-originated service image update approval request.
| Property | Value |
|---|
| Operation ID | - |
| Tags | Approvals |
| Auth | Not declared |
| Request body | application/json |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
orchestrator.approval.get_description
| Property | Value |
|---|
| Operation ID | - |
| Tags | Approvals |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
orchestrator.approval.approve_description
| Property | Value |
|---|
| Operation ID | - |
| Tags | Approvals |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
orchestrator.approval.reject_description
| Property | Value |
|---|
| Operation ID | - |
| Tags | Approvals |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
orchestrator.audit.list_description
| Property | Value |
|---|
| Operation ID | ReleaseOrchestrator_ListAuditEntries |
| Tags | Release Orchestrator Audit |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
actorId | query | no | |
cursor | query | no | |
endTime | query | no | |
eventType | query | no | |
limit | query | no | |
resourceId | query | no | |
resourceType | query | no | |
startTime | query | no | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
orchestrator.audit.get_latest_description
| Property | Value |
|---|
| Operation ID | ReleaseOrchestrator_GetLatestAuditEntry |
| Tags | Release Orchestrator Audit |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
orchestrator.audit.get_resource_history_description
| Property | Value |
|---|
| Operation ID | ReleaseOrchestrator_GetResourceHistory |
| Tags | Release Orchestrator Audit |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
resourceId | path | yes | |
resourceType | path | yes | |
limit | query | no | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
orchestrator.audit.get_by_sequence_description
| Property | Value |
|---|
| Operation ID | ReleaseOrchestrator_GetAuditBySequence |
| Tags | Release Orchestrator Audit |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
endSeq | path | yes | |
startSeq | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
orchestrator.audit.summary_description
| Property | Value |
|---|
| Operation ID | ReleaseOrchestrator_GetAuditSummary |
| Tags | Release Orchestrator Audit |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
since | query | no | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
orchestrator.audit.verify_description
| Property | Value |
|---|
| Operation ID | ReleaseOrchestrator_VerifyAuditChain |
| Tags | Release Orchestrator Audit |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
deep | query | no | |
endSeq | query | no | |
startSeq | query | no | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
orchestrator.audit.get_description
| Property | Value |
|---|
| Operation ID | ReleaseOrchestrator_GetAuditEntry |
| Tags | Release Orchestrator Audit |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
entryId | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Ingest an agent-computed reachability graph (canonical JSON + resultDigest + node/edge counts) from the live build context and, when it passes the stub guard, attach a source=build-context reachability referrer on the pushed digest.
| Property | Value |
|---|
| Operation ID | BuildCoProduction_IngestReachability |
| Tags | Release Orchestrator Build Co-Production |
| Auth | Not declared |
| Request body | application/json |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Ingest a build.docker co-production signal (pushed digest + SCM provenance + emit flags) and, when requested with complete SCM info, publish ComponentVersionScmInfoAvailable to drive the central scanner.
| Property | Value |
|---|
| Operation ID | BuildCoProduction_IngestScmInfo |
| Tags | Release Orchestrator Build Co-Production |
| Auth | Not declared |
| Request body | application/json |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Return a consolidated release dashboard snapshot for the Console control plane, including pending approvals, active promotions, recent deployments, and environment health indicators. Used by the UI to populate the main release management view.
| Property | Value |
|---|
| Operation ID | ReleaseDashboard_Get |
| Tags | ReleaseDashboard |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Deployments |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
environment | query | no | |
environments | query | no | |
page | query | no | |
pageSize | query | no | |
releaseId | query | no | |
releases | query | no | |
sortField | query | no | |
sortOrder | query | no | |
status | query | no | |
statuses | query | no | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Deployments |
| Auth | Not declared |
| Request body | application/json |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Deployments |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Deployment Bundles |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
X-StellaOps-TenantId | header | no | |
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Deployments |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Deployments |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Deployments |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
level | query | no | |
limit | query | no | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Deployments |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Deployments |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Content By Digest |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
X-StellaOps-Deployment-Capability | header | no | |
X-StellaOps-TenantId | header | no | |
digest | path | yes | |
id | path | yes | |
kind | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Content By Digest |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
X-StellaOps-Deployment-Capability | header | no | |
X-StellaOps-TenantId | header | no | |
digest | path | yes | |
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Deployments |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Deployments |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Deployment Secret Broker |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
X-StellaOps-TenantId | header | no | |
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Deployment Share Grants |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Deployment Share Grants |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Deployments |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
targetId | path | yes | |
level | query | no | |
limit | query | no | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
The response body is { "entries": DeploymentLogEntry[] }. For real-engine terminal deployments, entries are persisted from the matched target task only: already-redacted stdout/stderr/output, or the allowlisted Compose execution facts (projectName, services, runtime verification, and completed phases). The route never synthesizes output for a task that returned none. targetId, level, and limit filters apply after tenant + deployment scoping.
| Property | Value |
|---|
| Operation ID | - |
| Tags | Deployments |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
targetId | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Environments |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Environments |
| Auth | Not declared |
| Request body | application/json |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Environments |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
name | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
List operator-managed environment-to-policy-pack bindings for the calling tenant.
| Property | Value |
|---|
| Operation ID | - |
| Tags | Environment Policy Bindings |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
includeDisabled | query | no | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Environments |
| Auth | Not declared |
| Request body | application/json |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Environments |
| Auth | Not declared |
| Request body | application/json |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Environments |
| Auth | Not declared |
| Request body | application/json |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Return the environment policy binding for a single environment, if any.
| Property | Value |
|---|
| Operation ID | - |
| Tags | Environment Policy Bindings |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
environment | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Insert or update the policy-pack binding for an environment (idempotent).
| Property | Value |
|---|
| Operation ID | - |
| Tags | Environment Policy Bindings |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
environment | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Soft-delete the policy-pack binding for an environment (sets enabled=false).
| Property | Value |
|---|
| Operation ID | - |
| Tags | Environment Policy Bindings |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
environment | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Environments |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Environments |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Environments |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Resource Access |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Resource Access |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Resource Access |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Resource Access |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Resource Access |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
grantId | path | yes | |
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Environments |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Environments |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Environments |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Environments |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Environments |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
releaseBundleId | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Environments |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Environments |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Environments |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Environments |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Environments |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Environments |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Environments |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
name | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Environments |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Estate |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Estate |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Estate |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
digest | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Estate |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Estate |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Return a paginated list of evidence packets for the calling tenant, optionally filtered by release, type, and creation time window. Each packet includes its identifier, associated release, evidence type, content hash, and creation timestamp.
| Property | Value |
|---|
| Operation ID | - |
| Tags | Evidence |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
page | query | no | |
pageSize | query | no | |
releaseId | query | no | |
search | query | no | |
sortField | query | no | |
sortOrder | query | no | |
type | query | no | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Submit a verified release evidence packet. The service recomputes the payload hash before storing the packet so promotion and deployment gates can rely on durable evidence truth.
| Property | Value |
|---|
| Operation ID | - |
| Tags | Evidence |
| Auth | Not declared |
| Request body | application/json |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Return the full evidence packet record for the specified ID including release association, evidence type, content hash, algorithm, size, and metadata. Returns 404 when the evidence packet does not exist in the tenant.
| Property | Value |
|---|
| Operation ID | - |
| Tags | Evidence |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Export the specified evidence packet as a self-contained JSON bundle suitable for offline audit. The bundle includes the evidence metadata, content, and verification hashes.
| Property | Value |
|---|
| Operation ID | - |
| Tags | Evidence |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Download the raw binary content of the specified evidence packet. Returns the unprocessed evidence payload with Content-Type application/octet-stream. Returns 404 when the evidence packet does not exist.
| Property | Value |
|---|
| Operation ID | - |
| Tags | Evidence |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Return the chronological event timeline for the specified evidence packet including creation, verification, export, and access events. Useful for audit trails and provenance tracking.
| Property | Value |
|---|
| Operation ID | - |
| Tags | Evidence |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Verify the integrity of the specified evidence packet by recomputing and comparing its content hash. Returns the verification result including the computed hash, algorithm used, and whether the content matches the stored digest.
| Property | Value |
|---|
| Operation ID | - |
| Tags | Evidence |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
List built-in execution plugin adapters available to release targets.
| Property | Value |
|---|
| Operation ID | ExecutionPlugins_List |
| Tags | Execution Plugins |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Environments |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
exemptionId | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Environments |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Environments |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Environments |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Environments |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Environments |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Return the server-canonical operator-decision@v1 payload and DSSE PAE bytes for a release governance action.
| Property | Value |
|---|
| Operation ID | - |
| Tags | Operator Decisions |
| Auth | Not declared |
| Request body | application/json |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Record an approval decision on the specified pending promotion request, allowing the associated release to advance to the next environment. The calling principal must hold the release approval scope. Returns 404 when the promotion ID does not exist.
| Property | Value |
|---|
| Operation ID | ReleaseDashboard_ApprovePromotion |
| Tags | ReleaseDashboard |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Record a rejection decision on the specified pending promotion request with an optional rejection reason, blocking the release from advancing. The calling principal must hold the release approval scope. Returns 404 when the promotion ID does not exist.
| Property | Value |
|---|
| Operation ID | ReleaseDashboard_RejectPromotion |
| Tags | ReleaseDashboard |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Return the effective administrator release environment limit for the calling tenant. Stored settings override deployment configuration.
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Environment Limits |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Persist the administrator release environment allow-list for the calling tenant.
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Environment Limits |
| Auth | Not declared |
| Request body | application/json |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Return the tenant-scoped reverse release impact for a CVE or advisory identifier. The response contains currentImpact.releases, approvals, promotions, environments, gateVerdicts, reachableCves, and evidenceLinks, all sorted deterministically for FE diffing. Example response shape: { identifier, normalizedIdentifier, empty, currentImpact: { releases, approvals, promotions, environments, gateVerdicts, reachableCves, evidenceLinks }, timeline: { current, historical } }. timeline.current contains the current matching verdict rows; timeline.historical contains older matching gate-decision rows and does not contribute to currentImpact. Empty matches return 200 with empty=true and empty arrays; a missing identifier returns 400 identifier_required.
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Impact |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
identifier | query | no | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Return a paginated list of releases for the calling tenant, optionally filtered by status, environment, project, and creation time window. Each release record includes its name, version, current status, component count, and lifecycle timestamps.
| Property | Value |
|---|
| Operation ID | - |
| Tags | Releases |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
access | query | no | |
environment | query | no | |
page | query | no | |
pageSize | query | no | |
search | query | no | |
sortField | query | no | |
sortOrder | query | no | |
statuses | query | no | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Create a new release record in Draft state. The release captures an intent to promote a versioned set of components through defined environments. Returns 409 if a release with the same name and version already exists.
| Property | Value |
|---|
| Operation ID | - |
| Tags | Releases |
| Auth | Not declared |
| Request body | application/json |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Return a paginated feed of release activities across all releases, optionally filtered by environment, outcome, and time window.
| Property | Value |
|---|
| Operation ID | - |
| Tags | Releases |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
environment | query | no | |
limit | query | no | |
outcome | query | no | |
releaseId | query | no | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Return the most recent release with the given name, including structured metadata for smart defaults when creating a new version. Used by the release creation wizard to auto-fill from the previous version.
| Property | Value |
|---|
| Operation ID | - |
| Tags | Releases |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
name | query | no | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Create or idempotently re-read a sealed release by aggregating release creation, component registration, ready transition, recorded seal evidence, approval gate truth, and deployment dispatch.
| Property | Value |
|---|
| Operation ID | Release_SealAggregate |
| Tags | Releases |
| Auth | Not declared |
| Request body | application/json |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Suggest the next semantic version for a release name based on the latest existing version. Returns the suggested version string and the source release ID.
| Property | Value |
|---|
| Operation ID | - |
| Tags | Releases |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
currentVersion | query | no | |
name | query | no | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Return a filtered list of release versions, optionally filtered by gate status.
| Property | Value |
|---|
| Operation ID | - |
| Tags | Releases |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
gateStatus | query | no | |
limit | query | no | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Return the full release record for the specified ID including name, version, status, component list, approval gate state, and event history summary. Returns 404 when the release does not exist in the tenant.
| Property | Value |
|---|
| Operation ID | - |
| Tags | Releases |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Permanently remove the specified release record. Only releases in Draft or Failed status can be deleted; returns 409 for releases in other states. All associated components and events are removed with the release record.
| Property | Value |
|---|
| Operation ID | - |
| Tags | Releases |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Update mutable metadata on the specified release including description, target environment, and custom labels. Status transitions must be performed through the dedicated lifecycle endpoints. Returns 404 when the release does not exist.
| Property | Value |
|---|
| Operation ID | - |
| Tags | Releases |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Resource Access |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Resource Access |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Resource Access |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Resource Access |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Resource Access |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
grantId | path | yes | |
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Create a new release by copying the components, labels, and target environment from the specified source release, applying a new name and version. The cloned release starts in Draft state and is independent of the source.
| Property | Value |
|---|
| Operation ID | - |
| Tags | Releases |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Trigger deployment of the specified release to its current target environment. Deployment is orchestrated by the platform and may include pre-deployment checks, artifact staging, and post-deployment validation. Returns 409 if gates have not been satisfied.
| Property | Value |
|---|
| Operation ID | - |
| Tags | Releases |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
preflightOverrideJustification | query | no | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Initiate the promotion workflow to advance the specified release to its next target environment, triggering policy gate evaluation. The promotion runs asynchronously; poll the release record or subscribe to events for outcome updates.
The target may be supplied as a legacy env-* alias, environment name, or UUID. When it resolves, the persisted approval uses the canonical environment name and its configured RequiredApprovals (minimum one). A positive requiredApprovals supplied by the evaluated gate/policy decision overrides that initial environment quorum. Unresolved legacy references retain the compatibility quorum of two.
| Property | Value |
|---|
| Operation ID | - |
| Tags | Releases |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Transition the specified release from Draft to Ready state, signalling that all components are assembled and the release is eligible for promotion gate evaluation. Returns 409 if the release is not in Draft state or required components are missing.
| Property | Value |
|---|
| Operation ID | - |
| Tags | Releases |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Initiate a rollback of the specified deployed release to the previous stable version in the current environment. The rollback is audited and creates a new release event. Returns 409 if the release is not in Deployed state or no prior stable version exists.
| Property | Value |
|---|
| Operation ID | - |
| Tags | Releases |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Return per-component version currency for the specified release: which components have a STRICTLY-NEWER version that the registry actually serves (never a guessed version/digest), which are up to date, and which could not be checked (registry unreachable/unresolved). Read-only — surfacing an update never deploys; the one-click draft rides the Editor-gated create-version endpoint referenced by each row’s actionEndpoint.
| Property | Value |
|---|
| Operation ID | - |
| Tags | Releases |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Create a new draft release version from an existing release when a component artifact digest changes. The new version copies source release metadata and components, replaces only the changed component digest/reference, and applies administrator environment scope limits.
| Property | Value |
|---|
| Operation ID | - |
| Tags | Releases |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Return the list of environment targets that the specified release can be promoted to from its current state, based on the configured promotion pipeline and the caller’s access rights. Returns 404 when the release does not exist.
| Property | Value |
|---|
| Operation ID | - |
| Tags | Releases |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
releaseId | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Return the list of components registered in the specified release including their artifact references, versions, content digests, and current deployment status. Returns 404 when the release does not exist.
| Property | Value |
|---|
| Operation ID | - |
| Tags | Releases |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
releaseId | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Register a new component in the specified release, supplying the artifact reference and content digest. Components must be added before the release is marked Ready. Returns 409 if a component with the same name is already registered.
| Property | Value |
|---|
| Operation ID | - |
| Tags | Releases |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
releaseId | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Remove the specified component from the release. Only permitted when the release is in Draft state; returns 409 for releases that are Ready or beyond. Returns 404 when the component or release does not exist in the tenant.
| Property | Value |
|---|
| Operation ID | - |
| Tags | Releases |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
componentId | path | yes | |
releaseId | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Update the artifact reference, version, or content digest of the specified release component. Returns 404 when the component does not exist within the release or the release itself does not exist in the tenant.
| Property | Value |
|---|
| Operation ID | - |
| Tags | Releases |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
componentId | path | yes | |
releaseId | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Operator-triggered “scan now when unknown”: trigger a Scanner scan for the named release component (resolved to its pinned image reference + digest) so an absent/pending/failed SBOM-readiness gate can be satisfied. Requires scanner:scan + release:read.
| Property | Value |
|---|
| Operation ID | - |
| Tags | Releases |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
componentName | path | yes | |
releaseId | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Return the honest deployment strategy plan preview for the specified release into the given environment (?environmentId=) under a requested strategy (?strategy=rolling|canary|blue_green|all_at_once). The response mirrors the REAL strategy batching (phases: index + per-phase target count) plus the effective behaviour and honest caveats: single-target-collapse (with one target, canary/blue-green/rolling collapse to a single all-at-once deploy) and no-traffic-management (canary/blue-green do phased TARGET rollout, not traffic splitting; cutover is external). Unknown/unresolvable target count returns an honest cannot-preview, never a fabricated plan. Read-only — it never deploys.
| Property | Value |
|---|
| Operation ID | - |
| Tags | Releases |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
releaseId | path | yes | |
environmentId | query | no | |
strategy | query | no | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Return the pre-launch deployment readiness checklist for the specified release into the given environment (?environmentId=). Each row is tri-state (pass/fail/unknown); a fail carries the deployment failure anatomy (plain reason + action). armed is true iff no check hard-failed. Honest: unknown (a probe that could not determine the answer) is surfaced as a caution, never a false pass and never a lone blocker. Floor-independent preview — it never deploys.
| Property | Value |
|---|
| Operation ID | - |
| Tags | Releases |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
releaseId | path | yes | |
environmentId | query | no | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Return the chronological event log for the specified release including status transitions, gate evaluations, approval decisions, deployment actions, and rollback events. Useful for audit trails and post-incident analysis.
| Property | Value |
|---|
| Operation ID | - |
| Tags | Releases |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
releaseId | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Evaluate and return the gate check results for the specified release’s next promotion without committing any state change. Returns the verdict for each configured policy gate so operators can assess promotion eligibility before triggering it.
The preview resolves targetEnvironmentId by environment UUID or name; when the query is omitted it uses the release’s configured target. targetEnvironment, requiredApprovers, and requiresHumanApproval come from that resolved environment so the preview matches the promotion contract. Unresolved legacy references retain the compatibility fallback (staging, two approvers).
| Property | Value |
|---|
| Operation ID | - |
| Tags | Releases |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
releaseId | path | yes | |
targetEnvironmentId | query | no | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
orchestrator.first_signal.get_description
| Property | Value |
|---|
| Operation ID | ReleaseOrchestrator_GetFirstSignal |
| Tags | Release Orchestrator Runs |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
If-None-Match | header | no | |
runId | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Deployment Share Grants |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
grantId | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Deployment Share Grants |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
grantId | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Deployment Share Grants |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
grantId | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Deployment Share Grants |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
grantId | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Deployment Share Grants |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
grantId | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Environments |
| Auth | Not declared |
| Request body | application/json |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Environments |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Environments |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Environments |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Environments |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Environments |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Environments |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Release Orchestrator Environments |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
List targets
| Property | Value |
|---|
| Operation ID | ListTargets |
| Tags | Topology Targets |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
environmentId | query | no | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Create a new deployment target
| Property | Value |
|---|
| Operation ID | CreateTarget |
| Tags | Topology Targets |
| Auth | Not declared |
| Request body | application/json |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Assign an agent to a target
| Property | Value |
|---|
| Operation ID | AssignAgent |
| Tags | Topology Targets |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Rename a target
| Property | Value |
|---|
| Operation ID | RenameTarget |
| Tags | Topology Rename |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
503 | Service Unavailable | - |
Get latest readiness report for a target
| Property | Value |
|---|
| Operation ID | GetTargetReadiness |
| Tags | Topology Readiness |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | application/json |
404 | Not Found | - |
Request deletion of a target
| Property | Value |
|---|
| Operation ID | RequestDeleteTarget |
| Tags | Topology Deletion |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
503 | Service Unavailable | - |
Run all readiness gates for a target
| Property | Value |
|---|
| Operation ID | ValidateTarget |
| Tags | Topology Readiness |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
id | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | application/json |
List scripts with optional search, language, and visibility filters.
| Property | Value |
|---|
| Operation ID | ListScripts |
| Tags | ScriptsEndpoints |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Create a new script.
| Property | Value |
|---|
| Operation ID | CreateScript |
| Tags | ScriptsEndpoints |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Validate script syntax without saving.
| Property | Value |
|---|
| Operation ID | ValidateScript |
| Tags | ScriptsEndpoints |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Get a single script by ID.
| Property | Value |
|---|
| Operation ID | GetScript |
| Tags | ScriptsEndpoints |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
scriptId | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Delete a script.
| Property | Value |
|---|
| Operation ID | DeleteScript |
| Tags | ScriptsEndpoints |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
scriptId | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Update an existing script.
| Property | Value |
|---|
| Operation ID | UpdateScript |
| Tags | ScriptsEndpoints |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
scriptId | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Check script compatibility with a target environment.
| Property | Value |
|---|
| Operation ID | CheckScriptCompatibility |
| Tags | ScriptsEndpoints |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
scriptId | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
List all versions of a script.
| Property | Value |
|---|
| Operation ID | ListScriptVersions |
| Tags | ScriptsEndpoints |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
scriptId | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Get the content of a specific script version.
| Property | Value |
|---|
| Operation ID | GetScriptVersionContent |
| Tags | ScriptsEndpoints |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
scriptId | path | yes | |
version | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
Image build provenance (module, gitSha, gitCommitTime, imageBuiltAt, branch) for drift detection.
| Property | Value |
|---|
| Operation ID | StellaOpsBuildInfoFile |
| Tags | StellaOps.ReleaseOrchestrator.WebApi |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Health |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Health |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | - |
| Tags | Health |
| Auth | Not declared |
| Request body | - |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | ROInternalGetCryptoPopulations |
| Tags | InternalCrypto |
| Auth | Verified Bearer or StellaRouterEnvelope: crypto:kek:read, crypto:kek:rotate, or ops.admin |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
kekId | query | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | ROInternalStartCryptoReSeal |
| Tags | InternalCrypto |
| Auth | Verified Bearer or StellaRouterEnvelope: crypto:kek:rotate or ops.admin |
| Request body | application/json |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | ROInternalAbortCryptoReSeal |
| Tags | InternalCrypto |
| Auth | Verified Bearer or StellaRouterEnvelope: crypto:kek:rotate or ops.admin |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
rotationId | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |
| Property | Value |
|---|
| Operation ID | ROInternalGetCryptoReSealProgress |
| Tags | InternalCrypto |
| Auth | Verified Bearer or StellaRouterEnvelope: crypto:kek:read, crypto:kek:rotate, or ops.admin |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
rotationId | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | - |