Regions
Region Detail
Retrieves detailed information for a specific storage region identified by {region_id}. A storage region defines the geographical or cloud-based location used by OSF Storage for storing files.
Returns
A JSON:API-compliant response containing a single region entity under the data key.
Errors
Returns an errors object if unsuccessful:
- 404 Not Found: No region matches the provided region_id.
get/regions/{region_id}/
Path parameters
region_idstring required
The unique identifier for the region.
Response
Successfully retrieved region details.
Example response
{
"data": {
"id": "us-east-1",
"type": "regions",
"attributes": {
"name": "US East"
},
"links": {
"self": "https://api.osf.io/v2/regions/us-east-1/"
}
}
}