Get a bulk registration job

GET

key_link

signing_keys

bulk

jobs

{jobId}

TypeScript

const response: Promise<FireblocksResponse<BulkSigningKeyJob>> = fireblocks.keyLinkBeta.getBulkSigningKeysJob(keyLinkBetaApiGetBulkSigningKeysJobRequest);

const options = {method: 'GET'};

fetch('https://api.fireblocks.io/v1/key_link/signing_keys/bulk/jobs/{jobId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.fireblocks.io/v1/key_link/signing_keys/bulk/jobs/{jobId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fireblocks.io/v1/key_link/signing_keys/bulk/jobs/{jobId}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.fireblocks.io/v1/key_link/signing_keys/bulk/jobs/{jobId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

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

{
  "message": "<string>",
  "code": 123
}

Path Parameters

jobId

string

required

The id of the bulk registration job

Response

The bulk registration job

jobId

string

required

Id of the registration job.

Example:

"46a92767-5f93-4a46-9eed-f012196bb4fc"

status

enum<string>

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.

Available options:

QUEUED,

IN_PROGRESS,

COMPLETED,

INCOMPLETE,

FAILED

Example:

"COMPLETED"

total

number

required

Keys in the submitted request.

Example:

10000

created

number

required

Keys registered by this job.

Example:

5700

alreadyRegistered

number

required

Keys already present in the workspace, recognized and skipped.

Example:

4300

failed

number

required

Keys rejected. See reason.

Example:

0

createdAt

number

required

Creation date (timestamp) in milliseconds.

Example:

124757537

updatedAt

number

required

Last progress update (timestamp) in milliseconds.

Example:

124757537

reason

string | null

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

Example:

null

fileHash

string | null

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

Example:

"2fbd1d6db47ea4d7599c81a30b6f31ff6728661c842414d4510718e109253d98"

⌘I

TypeScript

const response: Promise<FireblocksResponse<BulkSigningKeyJob>> = fireblocks.keyLinkBeta.getBulkSigningKeysJob(keyLinkBetaApiGetBulkSigningKeysJobRequest);

const options = {method: 'GET'};

fetch('https://api.fireblocks.io/v1/key_link/signing_keys/bulk/jobs/{jobId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.fireblocks.io/v1/key_link/signing_keys/bulk/jobs/{jobId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fireblocks.io/v1/key_link/signing_keys/bulk/jobs/{jobId}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.fireblocks.io/v1/key_link/signing_keys/bulk/jobs/{jobId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

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

{
  "message": "<string>",
  "code": 123
}

Introduction

Errors & Statuses

Data Objects

API Endpoints

Path Parameters

Response