Regions

IONOS Cloud object storage regions they define the location of the bucket, can also be used as LocationConstraint for bucket creation.

This tag groups all operations for regions.

Retrieve all Regions

get

This endpoint enables retrieving all Regions using pagination and optional filters.

Authorizations
Query parameters
offsetinteger · int32Optional

The first element (of the total list of elements) to include in the response. Use together with limit for pagination.

Default: 0Example: 0
limitinteger · int32 · min: 1 · max: 1000Optional

The maximum number of elements to return. Use together with offset for pagination.

Default: 100Example: 100
Responses
200
Returned all requested Regions successfully.
application/json
Responseall of
and
get
GET /regions HTTP/1.1
Host: s3.ionos.com
Authorization: Bearer JWT
Accept: */*
{
  "id": "1bcda4f5-f78b-532d-976d-183e3437af91",
  "type": "collection",
  "href": "/regions",
  "items": [
    {
      "id": "eu-central-3",
      "type": "region",
      "href": "/regions/eu-central-3",
      "metadata": {},
      "properties": {
        "version": 1,
        "endpoint": "s3.eu-central-3.ionoscloud.com",
        "website": "s3-website-de-central.profitbricks.com",
        "capability": {
          "iam": false,
          "s3select": true
        },
        "storageClasses": [
          "standard",
          "standardInfrequentAccess"
        ],
        "location": "de/fra",
        "bucketOwnership": "user-owned"
      }
    }
  ],
  "offset": 0,
  "limit": 42,
  "_links": {
    "prev": "http://PREVIOUS-PAGE-URI",
    "self": "http://THIS-PAGE-URI",
    "next": "http://NEXT-PAGE-URI"
  }
}

Retrieve Region

get

Returns the Region by Region.

Authorizations
Path parameters
regionstringRequired

The Region of the Region.

Example: eu-central-3
Responses
200
Getting Region was successful.
application/json
get
GET /regions/{region} HTTP/1.1
Host: s3.ionos.com
Authorization: Bearer JWT
Accept: */*
{
  "id": "eu-central-3",
  "type": "region",
  "href": "/regions/eu-central-3",
  "metadata": {},
  "properties": {
    "version": 1,
    "endpoint": "s3.eu-central-3.ionoscloud.com",
    "website": "s3-website-de-central.profitbricks.com",
    "capability": {
      "iam": false,
      "s3select": true
    },
    "storageClasses": [
      "standard",
      "standardInfrequentAccess"
    ],
    "location": "de/fra",
    "bucketOwnership": "user-owned"
  }
}

Was this helpful?