Get a storage space
GET
spaces/{spaceId}
Get information about the storage space specified by the spaceId.
Resource Information
Method and URI | GET https://developer.api.autodesk.com/flow/storage/v1/spaces/{spaceId} |
Authentication Context | user context optional |
Required OAuth Scopes | data:read |
Data Format | JSON |
Request
Headers
Authorization* string | Must be Bearer <token> , where <token> is obtained via either a two-legged or three-legged OAuth flow. |
region string | The region targeted by the request. The usage of this header is recommended for faster processing. The region specified must match the region in which the targeted storage space was created or else the request will fail. |
* Required
Request
URI Parameters
spaceId string | The ID of the storage space, specified as <storage provider>:<storage space key>. For example scratch:@default indicates the @default storage space for the Scratch storage provider. |
Response
HTTP Status Code Summary
200 OK | OK |
400 Bad Request | Bad request - indicates an incorrectly structure or otherwise incorrect request. |
401 Unauthorized | Unauthorized - credentials are invalid or not provided in the request |
403 Forbidden | Forbidden - the user/entity does not have the required privileges to access this resource |
404 Not Found | The specified resource was not found |
429 Too Many Requests | Too Many Requests |
Response
Header (429)
Retry-After integer | Specifies how many seconds to wait before making a new request. |
Response
Body Structure (200)
id string | A unique ID for a specific storage space |
provider string | The name of a storage provider.
Max length: 100 |
spaceKey string | A provider-specific unique ID for a storage space. |
Example
This example get information for the default storage space on the scratch storage provider
Request
curl -v 'https://developer.api.autodesk.com/flow/storage/v1/spaces/scratch:@default' \
-X 'GET' \
-H 'Authorization: Bearer eyJhbGciOiJ...' \
Response
{
"id": "scratch:@default",
"provider": "scratch",
"spaceKey": "@default"
}