Deployments

Atomic project release deployment.

Operations

Each operation lists its specific responses. See Common error responses for errors shared by every operation on this page.

Bootstrap this unclaimed instance with an issuer-owned ProjectUID

POST /api/v1/instance/project-claim

Operation ID: bootstrapProjectClaim
Effect: write
Confirmation: conditional
Required privilege: PROJECT_ADMIN
Focused reference: JSON · Markdown

Parameters

Name In Required Type Description
Idempotency-Key header Yes string

Request body

Content types: application/json.

Responses

Status Description
200 The request has succeeded.

Upload a missing immutable private-candidate source blob

PUT /api/v1/projects/{project}/candidate-sync/blobs/{digest}

Operation ID: uploadProjectCandidateSourceBlob
Effect: idempotent-write
Confirmation: conditional
Required privilege: RESOURCE_EDIT
Focused reference: JSON · Markdown

Parameters

Name In Required Type Description
project path Yes string
digest path Yes string
Content-Type header Yes string
Content-Digest header Yes string
Source-Synchronization-Plan header Yes string

Request body

Content types: application/octet-stream.

Responses

Status Description
201 The request has succeeded and a new resource has been created as a result.

Plan content-addressed synchronization for the current author's private candidate

POST /api/v1/projects/{project}/candidate-sync/plan

Operation ID: planProjectCandidateSynchronization
Effect: write
Confirmation: conditional
Required privilege: RESOURCE_EDIT
Focused reference: JSON · Markdown

Parameters

Name In Required Type Description
project path Yes string
Idempotency-Key header Yes string

Request body

Content types: application/json.

Responses

Status Description
200 The request has succeeded.

Retain an exact source snapshot without preparing a candidate

POST /api/v1/projects/{project}/candidate-sync/source

This source-only operation stores immutable bytes for a later target-owned delivery plan. It must not create a candidate, acquire physical credentials, or perform catalog work.

Operation ID: retainProjectCandidateSource
Effect: write
Confirmation: conditional
Required privilege: RESOURCE_EDIT
Focused reference: JSON · Markdown

Parameters

Name In Required Type Description
project path Yes string
Idempotency-Key header Yes string
Source-Synchronization-Plan header Yes string

Request body

Content types: application/json.

Responses

Status Description
200 The request has succeeded.

Common error responses

These error responses apply to every operation on this page.

Status Description
400 The server could not understand the request due to invalid syntax.
401 Access is unauthorized.
403 Access is forbidden.
404 The server cannot find the requested resource.
409 The request conflicts with the current state of the server.
412 Precondition failed.
413 Client error
415 Client error
422 Client error
429 Client error
500 Server error
502 Server error
503 Service unavailable.