Skip to content

WorkspaceStatusBetaApi.md

Latest commit

 

History

History
64 lines (38 loc) · 2.14 KB

WorkspaceStatusBetaApi.md

File metadata and controls

64 lines (38 loc) · 2.14 KB

WorkspaceStatusBetaApi

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

Method HTTP request Description
getWorkspaceStatus GET /management/workspace_status Returns current workspace status

getWorkspaceStatus

GetWorkspaceStatusResponse getWorkspaceStatus()

Returns current workspace status (Beta). Note: - This endpoint is now in Beta, disabled for general availability at this time. - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions.
Endpoint Permission: Admin, Non-Signing Admin.

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, GetWorkspaceStatusResponse } 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.workspaceStatusBeta.getWorkspaceStatus(body).then((res: FireblocksResponse<GetWorkspaceStatusResponse>) => {
  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

GetWorkspaceStatusResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Current workspace status -
404 Workspace not found -

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