Object Store Locators
Blockvault Object Store Locators (v1.0.0)
Download OpenAPI specification:Download
API Documentation for Blockvault Object Store Locators
OSLocatorsByScope
OSLocatorsByScope returns all ObjectStoreLocator entries for a for all signer's present in the specified scope.
Authorizations:
path Parameters
| scope_id required | string (scope_id) (proto string) |
query Parameters
| includeRequest | boolean (include_request) include_request is a flag for whether to include this request in your result. |
Responses
Response samples
- 200
{- "locators": [
- {
- "owner": "string",
- "locatorUri": "string",
- "encryptionKey": "string"
}
], - "request": {
- "scopeId": "string",
- "includeRequest": true
}
}OSLocator
OSLocator returns an ObjectStoreLocator by its owner's address.
Authorizations:
path Parameters
| owner required | string (owner) (proto string) |
query Parameters
| includeRequest | boolean (include_request) include_request is a flag for whether to include this request in your result. |
Responses
Response samples
- 200
{- "locator": {
- "owner": "string",
- "locatorUri": "string",
- "encryptionKey": "string"
}, - "request": {
- "owner": "string",
- "includeRequest": true
}
}OSAllLocators
OSAllLocators returns all ObjectStoreLocator entries.
Authorizations:
query Parameters
| includeRequest | boolean (include_request) include_request is a flag for whether to include this request in your result. |
| pagination.key | string <byte> (key) key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set. |
| pagination.offset | integer or string <int64> (offset) offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set. |
| pagination.limit | integer or string <int64> (limit) limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app. |
| pagination.countTotal | boolean (count_total) count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set. |
| pagination.reverse | boolean (reverse) reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
Response samples
- 200
{- "locators": [
- {
- "owner": "string",
- "locatorUri": "string",
- "encryptionKey": "string"
}
], - "request": {
- "includeRequest": true,
- "pagination": {
- "key": "string",
- "offset": 0,
- "limit": 0,
- "countTotal": true,
- "reverse": true
}
}, - "pagination": {
- "nextKey": "string",
- "total": 0
}
}