Fireblocks Workspace API

openapi: 3.2.0
info:
  title: Fireblocks Workspace API
  description: 'Fireblocks provides a suite of applications to manage digital asset operations and a complete development platform to build your business on the blockchain.


    - Visit our website for more information: Fireblocks Website

    - Visit our developer docs: Fireblocks DevPortal'
  version: 1.6.2
  contact:
    email: developers@fireblocks.com
servers:
- url: https://api.fireblocks.io/v1
  description: Fireblocks Production Environment Base URL
- url: https://sandbox-api.fireblocks.io/v1
  description: Fireblocks Sandbox Environment Base URL
tags:
- name: Workspace
paths:
  /workspace:
    get:
      operationId: getWorkspace
      summary: Get workspace
      description: Returns the workspace ID and name for the authenticated user.
      x-rate-limit-category: read
      responses:
        '200':
          description: Workspace details
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Workspace'
        default:
          $ref: '#/components/responses/Error'
      tags:
      - Workspace
      x-readme:
        code-samples:
        - language: typescript
          code: 'const response: Promise<FireblocksResponse<Workspace>> = fireblocks.workspace.getWorkspace();'
          name: Fireblocks SDK TypeScript example
        - language: java
          code: CompletableFuture<ApiResponse<Workspace>> response = fireblocks.workspace().getWorkspace();
          name: Fireblocks SDK Java example
        - language: python
          code: response = fireblocks.workspace.get_workspace();
          name: Fireblocks SDK Python example
      x-codeSamples:
      - lang: TypeScript
        source: 'const response: Promise<FireblocksResponse<Workspace>> = fireblocks.workspace.getWorkspace();'
      - lang: Java
        source: CompletableFuture<ApiResponse<Workspace>> response = fireblocks.workspace().getWorkspace();
      - lang: Python
        source: response = fireblocks.workspace.get_workspace();
  /workspace/freeze:
    post:
      x-internal: true
      operationId: freezeWorkspace
      summary: Freeze
      description: 'Freezes a Workspace so that ALL operations by ANY user are blocked.

        You should only perform this action when the workspace faces imminent risk, such as when you have a security breach.

        To unfreeze a workspace, the workspace Owner must submit a request to Fireblocks Support.

        **NOTE:**

        - This operation can only be performed by the workspace Admins - Your workspace continues to receive incoming transfers during this time.

        Endpoint Permission: Admin, Non-Signing Admin.'
      tags:
      - Workspace
      x-rate-limit-category: write
      parameters:
      - $ref: '#/components/parameters/X-Idempotency-Key'
      responses:
        '204':
          description: Indicates that the workspace is now frozen
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        default:
          $ref: '#/components/responses/Error'
components:
  responses:
    Error:
      description: Error Response
      headers:
        X-Request-ID:
          $ref: '#/components/headers/X-Request-ID'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorSchema'
  parameters:
    X-Idempotency-Key:
      name: Idempotency-Key
      in: header
      description: 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.
      required: false
      schema:
        type: string
  schemas:
    ErrorSchema:
      type: object
      properties:
        message:
          type: string
        code:
          type: number
    Workspace:
      type: object
      properties:
        id:
          type: string
          description: The ID of the workspace
          example: 123e4567-e89b-12d3-a456-426614174000
        name:
          type: string
          description: The name of the workspace
          example: My Workspace
      required:
      - id
      - name
  headers:
    X-Request-ID:
      schema:
        type: string
      description: Unique ID correlated to the API request. Please provide it in any support ticket you create or on Github issues related to Fireblocks SDKs
  securitySchemes:
    bearerTokenAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
x-readme:
  explorer-enabled: false
  samples-languages:
  - curl
  - javascript
  - python
x-provenance:
  method: harvested
  publisher: Fireblocks
  source: https://swagger.fireblocks.com/openapi.yaml
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)