{ "opencollection": "1.0.0", "info": { "name": "Fireblocks Blockchains and Assets Approval Requests Workspace Management API", "version": "1.8.0" }, "items": [ { "info": { "name": "Workspace Management", "type": "folder" }, "items": [ { "info": { "name": "Freeze", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireblocks.io/v1/workspace/freeze", "headers": [ { "name": "Idempotency-Key", "value": "" } ] }, "docs": "Freezes a Workspace so that ALL operations by ANY user are blocked.\nYou should only perform this action when the workspace faces imminent risk, such as when you have a security breach.\nTo unfreeze a workspace, the workspace Owner must submit a request to Fireblocks Support.\n**NOTE:** \n- This operation can only be performed by the workspace Admins - Your workspace continues to receive incoming transfers during this time.\n
Endpoint Permission: Admin, Non-Signing Admin." }, { "info": { "name": "List user groups", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireblocks.io/v1/management/user_groups" }, "docs": "Get all user groups in your workspace\n\n- Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions.\n
Endpoint Permission: Admin, Non-Signing Admin." }, { "info": { "name": "Create user group", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireblocks.io/v1/management/user_groups", "headers": [ { "name": "Idempotency-Key", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new user group. Users with the Viewer role cannot be added to groups.\n
Endpoint Permission: Admin, Non-Signing Admin." }, { "info": { "name": "Get user group", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireblocks.io/v1/management/user_groups/:groupId", "params": [ { "name": "groupId", "value": "", "type": "path", "description": "The ID of the user group" } ] }, "docs": "Get a user group by ID\n\n- Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions.\n
Endpoint Permission: Admin, Non-Signing Admin." }, { "info": { "name": "Update user group", "type": "http" }, "http": { "method": "PUT", "url": "https://api.fireblocks.io/v1/management/user_groups/:groupId", "headers": [ { "name": "Idempotency-Key", "value": "" } ], "params": [ { "name": "groupId", "value": "", "type": "path", "description": "The ID of the user group" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a user group by ID\n- Please note that this endpoint is available only for API keys with Admin permissions.\n
Endpoint Permission: Admin, Non-Signing Admin." }, { "info": { "name": "Delete user group", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.fireblocks.io/v1/management/user_groups/:groupId", "params": [ { "name": "groupId", "value": "", "type": "path", "description": "The ID of the user group" } ] }, "docs": "Delete a user group by ID.
\n- Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions.\n
Endpoint Permission: Admin, Non-Signing Admin." }, { "info": { "name": "List users", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireblocks.io/v1/users" }, "docs": "DEPRECATED - please use `GET /management/users` instead\n
Endpoint Permission: Admin, Non-Signing Admin." }, { "info": { "name": "Get audit logs", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireblocks.io/v1/audits", "params": [ { "name": "timePeriod", "value": "", "type": "query", "description": "The last time period to fetch audit logs" } ] }, "docs": "Deprecated. Please use the `GET /management/audit_logs` endpoint instead.\n
Endpoint Permission: Admin, Non-Signing Admin." }, { "info": { "name": "Get audit logs", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireblocks.io/v1/management/audit_logs", "params": [ { "name": "timePeriod", "value": "", "type": "query", "description": "The last time period to fetch audit logs" }, { "name": "cursor", "value": "", "type": "query", "description": "The next id to start fetch audit logs from" } ] }, "docs": "Get Audit logs for the last Day/Week.\n\n- Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions.\n
Endpoint Permission: Admin, Non-Signing Admin." }, { "info": { "name": "Update admin quorum threshold", "type": "http" }, "http": { "method": "PUT", "url": "https://api.fireblocks.io/v1/admin_quorum", "headers": [ { "name": "Idempotency-Key", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update admin quorum threshold.\n\n\n
Endpoint Permission: Admin, Non-Signing Admin." }, { "info": { "name": "Returns current OTA status", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireblocks.io/v1/management/ota" }, "docs": "Returns current One Time Address status.\nLearn more about [One Time Addresses](https://support.fireblocks.io/hc/en-us/articles/4409104568338-One-Time-Address-OTA-feature)\n- Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions.\n
Endpoint Permission: Admin, Non-Signing Admin." }, { "info": { "name": "Enable or disable transactions to OTA", "type": "http" }, "http": { "method": "PUT", "url": "https://api.fireblocks.io/v1/management/ota", "headers": [ { "name": "Idempotency-Key", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Enable or disable transactions to One Time Addresses (Non Whitelisted addresses).\nLearn more about [One Time Addresses](https://support.fireblocks.io/hc/en-us/articles/4409104568338-One-Time-Address-OTA-feature)\n- Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions.\n
Endpoint Permission: Admin, Non-Signing Admin." }, { "info": { "name": "Returns current workspace status", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireblocks.io/v1/management/workspace_status" }, "docs": "Returns current workspace status (Beta).\n**Note**:\n- This endpoint is now in Beta, disabled for general availability at this time.\n- Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions.\n\n
Endpoint Permission: Admin, Non-Signing Admin." }, { "info": { "name": "Get console users", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireblocks.io/v1/management/users" }, "docs": "Get console users for your workspace.\n- Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions.\n
Endpoint Permission: Admin, Non-Signing Admin." }, { "info": { "name": "Create console user", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireblocks.io/v1/management/users", "headers": [ { "name": "Idempotency-Key", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create console users in your workspace\n- Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions.\nLearn more about Fireblocks Users management in the following [guide](https://developers.fireblocks.com/docs/manage-users).\n
Endpoint Permission: Admin, Non-Signing Admin." }, { "info": { "name": "Get API Keys", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireblocks.io/v1/management/api_users" }, "docs": "List all API keys in your workspace.\n- Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions.\n
Endpoint Permission: Admin, Non-Signing Admin." }, { "info": { "name": "Create API Key", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireblocks.io/v1/management/api_users", "headers": [ { "name": "Idempotency-Key", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new API key in your workspace.\nLearn more about Fireblocks API Keys management in the following [guide](https://developers.fireblocks.com/docs/manage-api-keys).\n
Endpoint Permission: Admin, Non-Signing Admin." }, { "info": { "name": "Resets device", "type": "http" }, "http": { "method": "POST", "url": "https://api.fireblocks.io/v1/management/users/:id/reset_device", "headers": [ { "name": "Idempotency-Key", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the console user" } ] }, "docs": "Resets mobile device for given console user, that user will need to do mobile onboarding again.\n- Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions.\n
Endpoint Permission: Admin, Non-Signing Admin." }, { "info": { "name": "Get whitelisted ip addresses for an API Key", "type": "http" }, "http": { "method": "GET", "url": "https://api.fireblocks.io/v1/management/api_users/:userId/whitelist_ip_addresses", "params": [ { "name": "userId", "value": "", "type": "path", "description": "The ID of the api user" } ] }, "docs": "Get a list of the whitelisted IP addresses for a specific API Key\n- Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions.\n
Endpoint Permission: Admin, Non-Signing Admin." } ] } ], "bundled": true }