Skip to main content
GET/custody-mode-transition/{job_id}

Get Transition Status

Returns a custody transition job's state.

Parameters
projectId *query

The project's id.

job_id *path

The transition job's id, as Start Custody Transition returned it: ctjob_ and a UUID.

Responses
HTTPK9O CodeDescription
200The job's state.
401The request carries no authenticated caller.
404No such transition job.
500An internal error. Retry later.
Response body (200)
completedAtstring <date-time> | null

Transition completion timestamp; null while in progress.

The database time of the completing transaction, identical on the POST answer, the poll and GET /vault.

Example: "2026-11-15T09:30:00.123Z"
completedSeqinteger <int64> | null

The project's completed jobs in strictly increasing order.

Compare jobs on this, never on completedAt or jobId.

Absent until the job completes.

Example: 12
errorany
One of: null
or: object
code *string

Machine-readable error code.

Example: "BYOK_KEY_UNREACHABLE"
message *string

Human-readable error message.

Example: "The customer KMS key could not be reached."
fromMode *"PLATFORM_MANAGED" | "CONFIDENTIAL_WORKLOAD" | "BYOK" | "HYOK"

Custody mode of a project's vault.

jobId *string

Job identifier — UUID prefixed "ctjob_".

Example: "ctjob_7c9e6679-7425-40de-944b-e07fc1f90ae7"
projectId *string

Project this transition is for.

Example: "3f2b8c1e-5d4a-4e6f-9a7b-1c2d3e4f5a6b"
rekeyProgress *number <double>

Re-key progress (0.0 .. 1.0); meaningful only when rekey_required == true.

Example: 1
rekeyRequired *boolean

Whether a re-key is required for this transition.

Example: true
restoreEpochstring | null

The id of the last restore this kibo came back from, or null if it was never restored.

When it changes, completedSeq numbering started again.

Example: "rfn_3Hk8Pz2Qw7Ln"
restoreGenerationinteger <int64> | null

The ordered restoreGeneration of that episode (the HWM its lift published to the external witness); a gateway accepts a watermark reset only for a GREATER one.

Example: 2
startedAt *string <date-time>

Transition start timestamp.

Example: "2026-11-01T08:00:00.000Z"
status *"in_progress" | "complete" | "failed"

Custody-mode-transition job lifecycle status.

toMode *"PLATFORM_MANAGED" | "CONFIDENTIAL_WORKLOAD" | "BYOK" | "HYOK"

Custody mode of a project's vault.

cURL
curl -X GET 'https://<org>.api-<region>.k9o.io/@storefront/custody-mode-transition/<jobId>' \
  -H 'Authorization: Bearer $K9O_TOKEN'

Showing example in cURL

Response example (200)
{
  "completedAt": "2026-11-15T09:30:00.123Z",
  "completedSeq": 12,
  "fromMode": "PLATFORM_MANAGED",
  "jobId": "ctjob_7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "projectId": "3f2b8c1e-5d4a-4e6f-9a7b-1c2d3e4f5a6b",
  "rekeyProgress": 1,
  "rekeyRequired": true,
  "restoreEpoch": "rfn_3Hk8Pz2Qw7Ln",
  "restoreGeneration": 2,
  "startedAt": "2026-11-01T08:00:00.000Z",
  "status": "in_progress",
  "toMode": "PLATFORM_MANAGED"
}

More in Custody & Exit