Skip to content

Latest commit

 

History

History
130 lines (82 loc) · 4.37 KB

OTABetaApi.md

File metadata and controls

130 lines (82 loc) · 4.37 KB
Raw

OTABetaApi

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

Method HTTP request Description
getOtaStatus GET /management/ota Returns current OTA status
setOtaStatus PUT /management/ota Enable or disable transactions to OTA

getOtaStatus

GetOtaStatusResponse getOtaStatus()

Returns current OTA status

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, GetOtaStatusResponse } 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:any = {};

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

Parameters

This endpoint does not need any parameter.

Return type

GetOtaStatusResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Current OTA status -
404 Configuration not found for tenant -

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

setOtaStatus

SetOtaStatusResponse setOtaStatus(setOtaStatusRequest)

Enable or disable transactions to OTA

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, OTABetaApiSetOtaStatusRequest, SetOtaStatusResponse } 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: OTABetaApiSetOtaStatusRequest = {
  // SetOtaStatusRequest
  setOtaStatusRequest: 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.otaBeta.setOtaStatus(body).then((res: FireblocksResponse<SetOtaStatusResponse>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name Type Description Notes
setOtaStatusRequest SetOtaStatusRequest
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

SetOtaStatusResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
202 Successfully updated OTA status * X-Request-ID -
400 Bad request -
409 Similar request already pending -
500 Internal server error -

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