API docs by Redocly

IONOS Cloud - S3 Management API (0.1.0)

Download OpenAPI specification:Download

S3 Management API is a RESTful API that manages the S3 service configuration for IONOS Cloud.

Accesskeys

Per user access key.

This tag groups all operations for accesskeys.

Retrieve all Accesskeys

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

Authorizations:
tokenAuth
query Parameters
offset
integer <int32> >= 0
Default: 0

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

limit
integer <int32> [ 1 .. 1000 ]
Default: 100
Example: limit=100

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

filter.accesskeyId
string

The accesskey ID to filter by.

Responses

Response samples

Content type
application/json
{
  • "id": "5cd907ee-6b6a-5e3a-abaf-5c2edd01d78c",
  • "type": "collection",
  • "href": "/accesskeys",
  • "items": [
    ],
  • "offset": 0,
  • "limit": 42,
  • "_links": {}
}

Create AccessKey

Creates a new AccessKey.

The full AccessKey needs to be provided to create the object. Optional data will be filled with defaults or left empty.

Authorizations:
tokenAuth
Request Body schema: application/json

AccessKey to create.

object

Metadata

required
object (AccessKey)

Per user access key.

Responses

Request samples

Content type
application/json
{
  • "metadata": { },
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "id": "fb68d39a-5706-51b4-b2b2-7b4bf9cbf0af",
  • "type": "accesskey",
  • "href": "/accesskeys/fb68d39a-5706-51b4-b2b2-7b4bf9cbf0af",
  • "metadata": {
    },
  • "properties": {
    }
}

Retrieve AccessKey

Returns the AccessKey by ID.

Authorizations:
tokenAuth
path Parameters
accesskeyId
required
string <uuid>
Example: fb68d39a-5706-51b4-b2b2-7b4bf9cbf0af

The ID (UUID) of the AccessKey.

Responses

Response samples

Content type
application/json
{
  • "id": "fb68d39a-5706-51b4-b2b2-7b4bf9cbf0af",
  • "type": "accesskey",
  • "href": "/accesskeys/fb68d39a-5706-51b4-b2b2-7b4bf9cbf0af",
  • "metadata": {
    },
  • "properties": {
    }
}

Ensure AccessKey

Ensures that the AccessKey with the provided ID is created or modified. The full AccessKey needs to be provided to ensure (either update or create) the AccessKey. Non present data will only be filled with defaults or left empty, but not take previous values into consideration.

Authorizations:
tokenAuth
path Parameters
accesskeyId
required
string <uuid>
Example: fb68d39a-5706-51b4-b2b2-7b4bf9cbf0af

The ID (UUID) of the AccessKey.

Request Body schema: application/json

update AccessKey

id
required
string <uuid>

The ID (UUID) of the AccessKey.

object

Metadata

required
object (AccessKey)

Per user access key.

Responses

Request samples

Content type
application/json
{
  • "id": "fb68d39a-5706-51b4-b2b2-7b4bf9cbf0af",
  • "metadata": { },
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "id": "fb68d39a-5706-51b4-b2b2-7b4bf9cbf0af",
  • "type": "accesskey",
  • "href": "/accesskeys/fb68d39a-5706-51b4-b2b2-7b4bf9cbf0af",
  • "metadata": {
    },
  • "properties": {
    }
}

Delete AccessKey

Deletes the specified AccessKey.

Authorizations:
tokenAuth
path Parameters
accesskeyId
required
string <uuid>
Example: fb68d39a-5706-51b4-b2b2-7b4bf9cbf0af

The ID (UUID) of the AccessKey.

Responses

Response samples

Content type
application/json
{
  • "httpStatus": 400,
  • "messages": [
    ]
}

Ensure AccessKey

Renew will replace the existing secret access key with a new one.

Authorizations:
tokenAuth
path Parameters
accesskeyId
required
string <uuid>
Example: fb68d39a-5706-51b4-b2b2-7b4bf9cbf0af

The ID (UUID) of the AccessKey that should be ensured.

Responses

Response samples

Content type
application/json
{
  • "id": "fb68d39a-5706-51b4-b2b2-7b4bf9cbf0af",
  • "type": "accesskey",
  • "href": "/accesskeys/fb68d39a-5706-51b4-b2b2-7b4bf9cbf0af",
  • "metadata": {
    },
  • "properties": {
    }
}

Regions

IONOS Cloud S3 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

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

Authorizations:
tokenAuth
query Parameters
offset
integer <int32> >= 0
Default: 0

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

limit
integer <int32> [ 1 .. 1000 ]
Default: 100
Example: limit=100

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

Responses

Response samples

Content type
application/json
{
  • "id": "1bcda4f5-f78b-532d-976d-183e3437af91",
  • "type": "collection",
  • "href": "/regions",
  • "items": [
    ],
  • "offset": 0,
  • "limit": 42,
  • "_links": {}
}

Retrieve Region

Returns the Region by Region.

Authorizations:
tokenAuth
path Parameters
region
required
string
Example: eu-central-3

The Region of the Region.

Responses

Response samples

Content type
application/json
{
  • "id": "eu-central-3",
  • "type": "region",
  • "href": "/regions/eu-central-3",
  • "metadata": { },
  • "properties": {
    }
}