FIfireblocks
Key Link

Get a bulk registration job

Returns the progress and outcome of a bulk registration job. created + alreadyRegistered reaching total means every submitted key is present.

get/key_link/signing_keys/bulk/jobs/{jobId}

Request

Path parameters

jobIdstring required

The id of the bulk registration job

Response

The bulk registration job

jobIdstring required

Id of the registration job.

status'QUEUED' | 'IN_PROGRESS' | 'COMPLETED' | 'INCOMPLETE' | 'FAILED' required

QUEUED means the job is waiting for another bulk registration to finish, since only a limited number run at once. IN_PROGRESS means it is running. COMPLETED means every submitted key is present in the workspace. FAILED means the request was refused before any key was registered, so reason has to be acted on before resubmitting is worth anything. INCOMPLETE means some keys are not registered; resubmitting the same request retries exactly those, and reason says whether that is likely to help -- keys not registered because of a transient failure will succeed, a key whose certificate or proof was rejected will be rejected again.

totalnumber required

Keys in the submitted request.

creatednumber required

Keys registered by this job.

alreadyRegisterednumber required

Keys already present in the workspace, recognized and skipped.

failednumber required

Keys rejected. See reason.

reasonstring nullable

Free text describing what went wrong. Null while the job is healthy.

fileHashstring nullable

Hex digest over the submitted keys. Two jobs sharing a digest were the same set of keys, which makes a sequence of resubmissions recognizable.

createdAtnumber required

Creation date (timestamp) in milliseconds.

updatedAtnumber required

Last progress update (timestamp) in milliseconds.

Example response

{
  "jobId": "46a92767-5f93-4a46-9eed-f012196bb4fc",
  "status": "COMPLETED",
  "total": 10000,
  "created": 5700,
  "alreadyRegistered": 4300,
  "fileHash": "2fbd1d6db47ea4d7599c81a30b6f31ff6728661c842414d4510718e109253d98",
  "createdAt": 124757537,
  "updatedAt": 124757537
}

Changes

No recorded changes to this operation across all 1 revision of this API.