fireblocks-sdk 2025.10.17

Rust implementation of the Fireblocks SDK
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303

# \KeyLinkApi

All URIs are relative to *https://api.fireblocks.io/v1*

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_signing_key**](KeyLinkApi.md#create_signing_key) | **POST** /key_link/signing_keys | Add a new signing key
[**create_validation_key**](KeyLinkApi.md#create_validation_key) | **POST** /key_link/validation_keys | Add a new validation key
[**disable_validation_key**](KeyLinkApi.md#disable_validation_key) | **PATCH** /key_link/validation_keys/{keyId} | Disables a validation key
[**get_signing_key**](KeyLinkApi.md#get_signing_key) | **GET** /key_link/signing_keys/{keyId} | Get a signing key by `keyId`
[**get_signing_keys_list**](KeyLinkApi.md#get_signing_keys_list) | **GET** /key_link/signing_keys | Get list of signing keys
[**get_validation_key**](KeyLinkApi.md#get_validation_key) | **GET** /key_link/validation_keys/{keyId} | Get a validation key by `keyId`
[**get_validation_keys_list**](KeyLinkApi.md#get_validation_keys_list) | **GET** /key_link/validation_keys | Get list of registered validation keys
[**set_agent_id**](KeyLinkApi.md#set_agent_id) | **PATCH** /key_link/signing_keys/{keyId}/agent_user_id | Set agent user id
[**update_signing_key**](KeyLinkApi.md#update_signing_key) | **PATCH** /key_link/signing_keys/{keyId} | Modify the signing keyId



## create_signing_key

> models::SigningKeyDto create_signing_key(create_signing_key_dto, idempotency_key)
Add a new signing key

Adds a new signing key to the workspace. The added key will be linked to the specific Fireblocks agent user ID. The same user will receive the proof of ownership message to be signed, and upon successful proof, the key will become enabled. Please note that this endpoint is available only for Key Link enabled workspaces. </br>Endpoint Permission: Admin and Non-Signing Admin.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**create_signing_key_dto** | [**CreateSigningKeyDto**](CreateSigningKeyDto.md) |  | [required] |
**idempotency_key** | Option<**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. |  |

### Return type

[**models::SigningKeyDto**](SigningKeyDto.md)

### Authorization

No authorization required

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## create_validation_key

> models::CreateValidationKeyResponseDto create_validation_key(create_validation_key_dto, idempotency_key)
Add a new validation key

Adds a new validation key used to validate signing keys. The new validation key will undergo an approval process by the workspace quorum. Please note that this endpoint is available only for Key Link enabled workspaces. </br>Endpoint Permission: Admin and Non-Signing Admin.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**create_validation_key_dto** | [**CreateValidationKeyDto**](CreateValidationKeyDto.md) |  | [required] |
**idempotency_key** | Option<**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. |  |

### Return type

[**models::CreateValidationKeyResponseDto**](CreateValidationKeyResponseDto.md)

### Authorization

No authorization required

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## disable_validation_key

> models::ValidationKeyDto disable_validation_key(key_id, modify_validation_key_dto)
Disables a validation key

Allows disabling validation key even if it has not expired yet. It is not allowed to enable the validation key back. Another key has to be used for future validations. Please note that this endpoint is available only for Key Link enabled workspaces. </br>Endpoint Permission: Admin and Non-Signing Admin.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**key_id** | **String** | The unique identifier for the validation key provided by Fireblocks | [required] |
**modify_validation_key_dto** | [**ModifyValidationKeyDto**](ModifyValidationKeyDto.md) |  | [required] |

### Return type

[**models::ValidationKeyDto**](ValidationKeyDto.md)

### Authorization

No authorization required

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_signing_key

> models::SigningKeyDto get_signing_key(key_id)
Get a signing key by `keyId`

Returns a signing key if it exists, identified by the specified Fireblocks provided `keyId`. Please note that this endpoint is available only for Key Link enabled workspaces. </br>Endpoint Permission: Admin and Non-Signing Admin.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**key_id** | **String** | The unique identifier for the signing key provided by Fireblocks | [required] |

### Return type

[**models::SigningKeyDto**](SigningKeyDto.md)

### Authorization

No authorization required

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_signing_keys_list

> models::GetSigningKeyResponseDto get_signing_keys_list(page_cursor, page_size, sort_by, order, vault_account_id, agent_user_id, algorithm, enabled, available)
Get list of signing keys

Returns the list of signing keys in the workspace Please note that this endpoint is available only for Key Link enabled workspaces. </br>Endpoint Permission: Admin and Non-Signing Admin.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**page_cursor** | Option<**String**> | Cursor to the next page |  |
**page_size** | Option<**f64**> | Amount of results to return in the next page |  |[default to 10]
**sort_by** | Option<**String**> | Field(s) to use for sorting |  |[default to createdAt]
**order** | Option<**String**> | Is the order ascending or descending |  |[default to ASC]
**vault_account_id** | Option<**f64**> | Return keys assigned to a specific vault |  |
**agent_user_id** | Option<**String**> | Return keys associated with a specific agent user |  |
**algorithm** | Option<**String**> | Return only keys with a specific algorithm |  |
**enabled** | Option<**bool**> | Return keys that have been proof of ownership |  |
**available** | Option<**bool**> | Return keys that are proof of ownership but not assigned. Available filter can be used only when vaultAccountId and enabled filters are not set |  |

### Return type

[**models::GetSigningKeyResponseDto**](GetSigningKeyResponseDto.md)

### Authorization

No authorization required

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_validation_key

> models::ValidationKeyDto get_validation_key(key_id)
Get a validation key by `keyId`

Returns a validation key if it exists, identified by the specified `keyId`. Please note that this endpoint is available only for Key Link enabled workspaces. </br>Endpoint Permission: Admin and Non-Signing Admin.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**key_id** | **String** |  | [required] |

### Return type

[**models::ValidationKeyDto**](ValidationKeyDto.md)

### Authorization

No authorization required

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_validation_keys_list

> models::GetValidationKeyResponseDto get_validation_keys_list(page_cursor, page_size, sort_by, order)
Get list of registered validation keys

Returns the list of validation keys in the workspace Please note that this endpoint is available only for Key Link enabled workspaces. </br>Endpoint Permission: Admin and Non-Signing Admin.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**page_cursor** | Option<**String**> | Cursor to the next page |  |
**page_size** | Option<**f64**> | Amount of results to return in the next page |  |[default to 10]
**sort_by** | Option<**String**> | Field(s) to use for sorting |  |[default to createdAt]
**order** | Option<**String**> | Is the order ascending or descending |  |[default to ASC]

### Return type

[**models::GetValidationKeyResponseDto**](GetValidationKeyResponseDto.md)

### Authorization

No authorization required

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## set_agent_id

> set_agent_id(key_id, modify_signing_key_agent_id_dto)
Set agent user id

Can modify existing signing key id if the key is not enabled. The change done in background and will be visible once applied. If key is already enabled (after proof of ownership) the user cannot be changed. Please note that this endpoint is available only for Key Link enabled workspaces. </br>Endpoint Permission: Admin and Non-Signing Admin.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**key_id** | **String** | The unique identifier for the signing key provided by Fireblocks | [required] |
**modify_signing_key_agent_id_dto** | [**ModifySigningKeyAgentIdDto**](ModifySigningKeyAgentIdDto.md) |  | [required] |

### Return type

 (empty response body)

### Authorization

No authorization required

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## update_signing_key

> models::SigningKeyDto update_signing_key(key_id, modify_signing_key_dto)
Modify the signing keyId

Allows assigning the signing key to a vault account, if it hasn't been assigned to any other vault accounts yet. Please note that this endpoint is available only for Key Link enabled workspaces. </br>Endpoint Permission: Admin and Non-Signing Admin.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**key_id** | **String** | The unique identifier for the signing key provided by Fireblocks | [required] |
**modify_signing_key_dto** | [**ModifySigningKeyDto**](ModifySigningKeyDto.md) |  | [required] |

### Return type

[**models::SigningKeyDto**](SigningKeyDto.md)

### Authorization

No authorization required

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)