Skip to content

Latest commit

 

History

History
667 lines (442 loc) · 24 KB

CosignersBetaApi.md

File metadata and controls

667 lines (442 loc) · 24 KB

CosignersBetaApi

All URIs are relative to https://developers.fireblocks.com/reference/

Method HTTP request Description
addCosigner POST /cosigners Add cosigner
getApiKey GET /cosigners/{cosignerId}/api_keys/{apiKeyId} Get API key
getApiKeys GET /cosigners/{cosignerId}/api_keys Get all API keys
getCosigner GET /cosigners/{cosignerId} Get cosigner
getCosigners GET /cosigners Get all cosigners
getRequestStatus GET /cosigners/{cosignerId}/api_keys/{apiKeyId}/{requestId} Get request status
pairApiKey PUT /cosigners/{cosignerId}/api_keys/{apiKeyId} Pair API key
renameCosigner PATCH /cosigners/{cosignerId} Rename cosigner
unpairApiKey DELETE /cosigners/{cosignerId}/api_keys/{apiKeyId} Unpair API key
updateCallbackHandler PATCH /cosigners/{cosignerId}/api_keys/{apiKeyId} Update API key callback handler

addCosigner

AddCosignerResponse addCosigner(addCosignerRequest)

Add a new cosigner. The cosigner will be pending pairing until the API key is manually paired

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, CosignersBetaApiAddCosignerRequest, AddCosignerResponse } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: CosignersBetaApiAddCosignerRequest = {
  // AddCosignerRequest
  addCosignerRequest: param_value,
  // string | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. (optional)
  idempotencyKey: idempotencyKey_example,
};

fireblocks.cosignersBeta.addCosigner(body).then((res: FireblocksResponse<AddCosignerResponse>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name Type Description Notes
addCosignerRequest AddCosignerRequest
idempotencyKey [string] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. (optional) defaults to undefined

Return type

AddCosignerResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
201 Pending cosigner added * X-Request-ID -
0 Error Response * X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getApiKey

ApiKey getApiKey()

Get an API key by ID Note: These endpoints are currently in beta and might be subject to changes.

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, CosignersBetaApiGetApiKeyRequest, ApiKey } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: CosignersBetaApiGetApiKeyRequest = {
  // string | The unique identifier of the cosigner
  cosignerId: 44fcead0-7053-4831-a53a-df7fb90d440f,
  // string | The unique identifier of the API key
  apiKeyId: 44fcead0-7053-4831-a53a-df7fb90d440f,
};

fireblocks.cosignersBeta.getApiKey(body).then((res: FireblocksResponse<ApiKey>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name Type Description Notes
cosignerId [string] The unique identifier of the cosigner defaults to undefined
apiKeyId [string] The unique identifier of the API key defaults to undefined

Return type

ApiKey

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 An ApiKey object * X-Request-ID -
0 Error Response * X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getApiKeys

ApiKeysPaginatedResponse getApiKeys()

Get all cosigner paired API keys (paginated)

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, CosignersBetaApiGetApiKeysRequest, ApiKeysPaginatedResponse } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: CosignersBetaApiGetApiKeysRequest = {
  // string | The unique identifier of the cosigner
  cosignerId: 44fcead0-7053-4831-a53a-df7fb90d440f,
  // 'ASC' | 'DESC' | ASC / DESC ordering (default DESC) (optional)
  order: ASC,
  // string | Cursor of the required page (optional)
  pageCursor: pageCursor_example,
  // number | Maximum number of items in the page (optional)
  pageSize: 10,
};

fireblocks.cosignersBeta.getApiKeys(body).then((res: FireblocksResponse<ApiKeysPaginatedResponse>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name Type Description Notes
cosignerId [string] The unique identifier of the cosigner defaults to undefined
order [**'ASC' 'DESC'**]Array<'ASC' | 'DESC'> ASC / DESC ordering (default DESC)
pageCursor [string] Cursor of the required page (optional) defaults to undefined
pageSize [number] Maximum number of items in the page (optional) defaults to 10

Return type

ApiKeysPaginatedResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 A paginated response containing ApiKey objects * X-Request-ID -
0 Error Response * X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getCosigner

Cosigner getCosigner()

Get a cosigner by ID Note: These endpoints are currently in beta and might be subject to changes.

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, CosignersBetaApiGetCosignerRequest, Cosigner } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: CosignersBetaApiGetCosignerRequest = {
  // string | The unique identifier of the cosigner
  cosignerId: 44fcead0-7053-4831-a53a-df7fb90d440f,
};

fireblocks.cosignersBeta.getCosigner(body).then((res: FireblocksResponse<Cosigner>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name Type Description Notes
cosignerId [string] The unique identifier of the cosigner defaults to undefined

Return type

Cosigner

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 A cosigner object * X-Request-ID -
0 Error Response * X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getCosigners

CosignersPaginatedResponse getCosigners()

Get all workspace cosigners (paginated) Note: These endpoints are currently in beta and might be subject to changes.

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, CosignersBetaApiGetCosignersRequest, CosignersPaginatedResponse } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: CosignersBetaApiGetCosignersRequest = {
  // 'ASC' | 'DESC' | ASC / DESC ordering (default DESC) (optional)
  order: ASC,
  // string | Cursor of the required page (optional)
  pageCursor: pageCursor_example,
  // number | Maximum number of items in the page (optional)
  pageSize: 10,
};

fireblocks.cosignersBeta.getCosigners(body).then((res: FireblocksResponse<CosignersPaginatedResponse>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name Type Description Notes
order [**'ASC' 'DESC'**]Array<'ASC' | 'DESC'> ASC / DESC ordering (default DESC)
pageCursor [string] Cursor of the required page (optional) defaults to undefined
pageSize [number] Maximum number of items in the page (optional) defaults to 10

Return type

CosignersPaginatedResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 A paginated response containing Cosigner objects * X-Request-ID -
0 Error Response * X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getRequestStatus

Status getRequestStatus()

Get the status of an asynchronous request

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, CosignersBetaApiGetRequestStatusRequest, Status } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: CosignersBetaApiGetRequestStatusRequest = {
  // string | The unique identifier of the cosigner
  cosignerId: 44fcead0-7053-4831-a53a-df7fb90d440f,
  // string | The unique identifier of the API key
  apiKeyId: 44fcead0-7053-4831-a53a-df7fb90d440f,
  // string
  requestId: requestId_example,
};

fireblocks.cosignersBeta.getRequestStatus(body).then((res: FireblocksResponse<Status>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name Type Description Notes
cosignerId [string] The unique identifier of the cosigner defaults to undefined
apiKeyId [string] The unique identifier of the API key defaults to undefined
requestId [string] defaults to undefined

Return type

Status

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 The status of the request * X-Request-ID -
0 Error Response * X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

pairApiKey

PairApiKeyResponse pairApiKey(pairApiKeyRequest, )

Pair an API key to a cosigner

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, CosignersBetaApiPairApiKeyRequest, PairApiKeyResponse } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: CosignersBetaApiPairApiKeyRequest = {
  // PairApiKeyRequest
  pairApiKeyRequest: param_value,
  // string | The unique identifier of the cosigner
  cosignerId: 44fcead0-7053-4831-a53a-df7fb90d440f,
  // string | The unique identifier of the API key
  apiKeyId: 44fcead0-7053-4831-a53a-df7fb90d440f,
  // string | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. (optional)
  idempotencyKey: idempotencyKey_example,
};

fireblocks.cosignersBeta.pairApiKey(body).then((res: FireblocksResponse<PairApiKeyResponse>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name Type Description Notes
pairApiKeyRequest PairApiKeyRequest
cosignerId [string] The unique identifier of the cosigner defaults to undefined
apiKeyId [string] The unique identifier of the API key defaults to undefined
idempotencyKey [string] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. (optional) defaults to undefined

Return type

PairApiKeyResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
202 The API key object to be paired * X-Request-ID -
* Location -
0 Error Response * X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

renameCosigner

Cosigner renameCosigner(renameCosigner, )

Rename a cosigner by ID Note: These endpoints are currently in beta and might be subject to changes.

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, CosignersBetaApiRenameCosignerRequest, Cosigner } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: CosignersBetaApiRenameCosignerRequest = {
  // RenameCosigner
  renameCosigner: param_value,
  // string | The unique identifier of the cosigner
  cosignerId: 44fcead0-7053-4831-a53a-df7fb90d440f,
};

fireblocks.cosignersBeta.renameCosigner(body).then((res: FireblocksResponse<Cosigner>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name Type Description Notes
renameCosigner RenameCosigner
cosignerId [string] The unique identifier of the cosigner defaults to undefined

Return type

Cosigner

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 A cosigner object * X-Request-ID -
0 Error Response * X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

unpairApiKey

ApiKey unpairApiKey()

Unpair an API key from a cosigner

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, CosignersBetaApiUnpairApiKeyRequest, ApiKey } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: CosignersBetaApiUnpairApiKeyRequest = {
  // string | The unique identifier of the cosigner
  cosignerId: 44fcead0-7053-4831-a53a-df7fb90d440f,
  // string | The unique identifier of the API key
  apiKeyId: 44fcead0-7053-4831-a53a-df7fb90d440f,
};

fireblocks.cosignersBeta.unpairApiKey(body).then((res: FireblocksResponse<ApiKey>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name Type Description Notes
cosignerId [string] The unique identifier of the cosigner defaults to undefined
apiKeyId [string] The unique identifier of the API key defaults to undefined

Return type

ApiKey

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
202 The API key object to be unpaired * X-Request-ID -
* Location -
0 Error Response * X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateCallbackHandler

UpdateCallbackHandlerResponse updateCallbackHandler(updateCallbackHandlerRequest, )

Update the callback handler of an API key

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, CosignersBetaApiUpdateCallbackHandlerRequest, UpdateCallbackHandlerResponse } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: CosignersBetaApiUpdateCallbackHandlerRequest = {
  // UpdateCallbackHandlerRequest
  updateCallbackHandlerRequest: param_value,
  // string | The unique identifier of the cosigner
  cosignerId: 44fcead0-7053-4831-a53a-df7fb90d440f,
  // string | The unique identifier of the API key
  apiKeyId: 44fcead0-7053-4831-a53a-df7fb90d440f,
};

fireblocks.cosignersBeta.updateCallbackHandler(body).then((res: FireblocksResponse<UpdateCallbackHandlerResponse>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name Type Description Notes
updateCallbackHandlerRequest UpdateCallbackHandlerRequest
cosignerId [string] The unique identifier of the cosigner defaults to undefined
apiKeyId [string] The unique identifier of the API key defaults to undefined

Return type

UpdateCallbackHandlerResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
202 The API key object with the new callback handler * X-Request-ID -
* Location -
0 Error Response * X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]