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.
This endpoint enables retrieving all Regions using pagination and optional filters.
Authorizations
Query parameters
offsetinteger · int32OptionalDefault:
The first element (of the total list of elements) to include in the response. Use together with limit for pagination.
0
Example: 0
limitinteger · int32 · min: 1 · max: 1000OptionalDefault:
The maximum number of elements to return. Use together with offset for pagination.
100
Example: 100
Responses
200
Returned all requested Regions successfully.
application/json
Responseall of
and
400
### Bad Request
The request send to the API was malformed.
application/json
401
### Unauthorized
The request is missing authorization information or the authorization information provided are expired.
application/json
403
### Not Allowed
The user issuing the request does not have the needed permissions.
application/json
429
### Too Many Requests
The user has sent too many requests in a given amount of time.
application/json
500
### Internal Server Error
An internal error occurred. We apologize for the inconvenience!
application/json
503
### Service Unavailable
The server is currently unable to handle the request due to a temporary overloading or maintenance of the server.
application/json
default
### Unexpected Internal Server Error
An unexpected internal error occurred. We apologize for the inconvenience!
application/json
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"
}
}
Returns the Region by Region.
Authorizations
Path parameters
regionstringRequiredExample:
The Region of the Region.
eu-central-3
Responses
200
Getting Region was successful.
application/json
400
### Bad Request
The request send to the API was malformed.
application/json
401
### Unauthorized
The request is missing authorization information or the authorization information provided are expired.
application/json
403
### Not Allowed
The user issuing the request does not have the needed permissions.
application/json
404
### Not Found
The resource that was requested could not be found.
application/json
429
### Too Many Requests
The user has sent too many requests in a given amount of time.
application/json
500
### Internal Server Error
An internal error occurred. We apologize for the inconvenience!
application/json
503
### Service Unavailable
The server is currently unable to handle the request due to a temporary overloading or maintenance of the server.
application/json
default
### Unexpected Internal Server Error
An unexpected internal error occurred. We apologize for the inconvenience!
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?