Retrieves a list of available storage regions within OSF. Regions define geographical or cloud storage locations for storing files uploaded through OSF Storage.

Returns

A JSON:API-compliant response containing an array of regions under the data key, including region attributes such as id and name.

Supports standard pagination and sorting by name.

Errors

If unsuccessful, returns an errors object. Refer to the Errors and Error Codes section for details.

{
  "data": [
    {
      "id": "us-east-1",
      "type": "regions",
      "attributes": {
        "name": "US East"
      },
      "links": {
        "self": "https://api.osf.io/v2/regions/us-east-1/"
      }
    }
  ],
  "meta": {
    "total": 1,
    "per_page": 10
  },
  "links": {
    "self": "https://api.osf.io/v2/regions/"
  }
}