Download OpenAPI specification:Download
S3 Management API is a RESTful API that manages the S3 service configuration for IONOS Cloud.
This endpoint enables retrieving all Accesskeys using pagination and optional filters.
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. |
{- "id": "5cd907ee-6b6a-5e3a-abaf-5c2edd01d78c",
- "type": "collection",
- "href": "/accesskeys",
- "items": [
- {
- "id": "fb68d39a-5706-51b4-b2b2-7b4bf9cbf0af",
- "type": "accesskey",
- "href": "/accesskeys/fb68d39a-5706-51b4-b2b2-7b4bf9cbf0af",
- "metadata": {
- "createdDate": "2020-12-10T13:37:50+01:00",
- "createdBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
- "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
- "lastModifiedDate": "2020-12-11T13:37:50+01:00",
- "lastModifiedBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
- "lastModifiedByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
- "resourceURN": "ionos:<product>:<location>:<contract>:<resource-path>",
- "status": "AVAILABLE",
- "statusMessage": null,
- "administrative": false,
- "supportedRegions": [
- "de",
- "eu-central-2",
- "eu-south-2"
]
}, - "properties": {
- "description": "Access key details",
- "accessKey": "00000Du4KiV8A1tGUbjI2Ky1YmXqXnCpaQpgWw6_1V5fhMPRnAAAAAEIkfcQAAAAAAiR9xAioHCB_FWuNJ4un864Pouw",
- "secretKey": "tFVkUARsoeCdntQs2jVSyGG6TMPfPZ+ghnsWj/gG",
- "canonicalUserId": "a73e086eeaaa03e21e4e932ac8a2ed7a",
- "contractUserId": "11111111:00000000-0000-0000-0000-000000000000"
}
}
], - "offset": 0,
- "limit": 42,
- "_links": {
}
}
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.
AccessKey to create.
object Metadata | |
required | object (AccessKey) Per user access key. |
{- "metadata": { },
- "properties": {
- "description": "Access key details"
}
}
{- "id": "fb68d39a-5706-51b4-b2b2-7b4bf9cbf0af",
- "type": "accesskey",
- "href": "/accesskeys/fb68d39a-5706-51b4-b2b2-7b4bf9cbf0af",
- "metadata": {
- "createdDate": "2020-12-10T13:37:50+01:00",
- "createdBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
- "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
- "lastModifiedDate": "2020-12-11T13:37:50+01:00",
- "lastModifiedBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
- "lastModifiedByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
- "resourceURN": "ionos:<product>:<location>:<contract>:<resource-path>",
- "status": "AVAILABLE",
- "statusMessage": null,
- "administrative": false,
- "supportedRegions": [
- "de",
- "eu-central-2",
- "eu-south-2"
]
}, - "properties": {
- "description": "Access key details",
- "accessKey": "00000Du4KiV8A1tGUbjI2Ky1YmXqXnCpaQpgWw6_1V5fhMPRnAAAAAEIkfcQAAAAAAiR9xAioHCB_FWuNJ4un864Pouw",
- "secretKey": "tFVkUARsoeCdntQs2jVSyGG6TMPfPZ+ghnsWj/gG",
- "canonicalUserId": "a73e086eeaaa03e21e4e932ac8a2ed7a",
- "contractUserId": "11111111:00000000-0000-0000-0000-000000000000"
}
}
Returns the AccessKey by ID.
accesskeyId required | string <uuid> Example: fb68d39a-5706-51b4-b2b2-7b4bf9cbf0af The ID (UUID) of the AccessKey. |
{- "id": "fb68d39a-5706-51b4-b2b2-7b4bf9cbf0af",
- "type": "accesskey",
- "href": "/accesskeys/fb68d39a-5706-51b4-b2b2-7b4bf9cbf0af",
- "metadata": {
- "createdDate": "2020-12-10T13:37:50+01:00",
- "createdBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
- "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
- "lastModifiedDate": "2020-12-11T13:37:50+01:00",
- "lastModifiedBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
- "lastModifiedByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
- "resourceURN": "ionos:<product>:<location>:<contract>:<resource-path>",
- "status": "AVAILABLE",
- "statusMessage": null,
- "administrative": false,
- "supportedRegions": [
- "de",
- "eu-central-2",
- "eu-south-2"
]
}, - "properties": {
- "description": "Access key details",
- "accessKey": "00000Du4KiV8A1tGUbjI2Ky1YmXqXnCpaQpgWw6_1V5fhMPRnAAAAAEIkfcQAAAAAAiR9xAioHCB_FWuNJ4un864Pouw",
- "secretKey": "tFVkUARsoeCdntQs2jVSyGG6TMPfPZ+ghnsWj/gG",
- "canonicalUserId": "a73e086eeaaa03e21e4e932ac8a2ed7a",
- "contractUserId": "11111111:00000000-0000-0000-0000-000000000000"
}
}
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.
accesskeyId required | string <uuid> Example: fb68d39a-5706-51b4-b2b2-7b4bf9cbf0af The ID (UUID) of the AccessKey. |
update AccessKey
id required | string <uuid> The ID (UUID) of the AccessKey. |
object Metadata | |
required | object (AccessKey) Per user access key. |
{- "id": "fb68d39a-5706-51b4-b2b2-7b4bf9cbf0af",
- "metadata": { },
- "properties": {
- "description": "Access key details"
}
}
{- "id": "fb68d39a-5706-51b4-b2b2-7b4bf9cbf0af",
- "type": "accesskey",
- "href": "/accesskeys/fb68d39a-5706-51b4-b2b2-7b4bf9cbf0af",
- "metadata": {
- "createdDate": "2020-12-10T13:37:50+01:00",
- "createdBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
- "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
- "lastModifiedDate": "2020-12-11T13:37:50+01:00",
- "lastModifiedBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
- "lastModifiedByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
- "resourceURN": "ionos:<product>:<location>:<contract>:<resource-path>",
- "status": "AVAILABLE",
- "statusMessage": null,
- "administrative": false,
- "supportedRegions": [
- "de",
- "eu-central-2",
- "eu-south-2"
]
}, - "properties": {
- "description": "Access key details",
- "accessKey": "00000Du4KiV8A1tGUbjI2Ky1YmXqXnCpaQpgWw6_1V5fhMPRnAAAAAEIkfcQAAAAAAiR9xAioHCB_FWuNJ4un864Pouw",
- "secretKey": "tFVkUARsoeCdntQs2jVSyGG6TMPfPZ+ghnsWj/gG",
- "canonicalUserId": "a73e086eeaaa03e21e4e932ac8a2ed7a",
- "contractUserId": "11111111:00000000-0000-0000-0000-000000000000"
}
}
Deletes the specified AccessKey.
accesskeyId required | string <uuid> Example: fb68d39a-5706-51b4-b2b2-7b4bf9cbf0af The ID (UUID) of the AccessKey. |
{- "httpStatus": 400,
- "messages": [
- {
- "errorCode": "err-1234",
- "message": "Error message example"
}
]
}
Renew will replace the existing secret access key with a new one.
accesskeyId required | string <uuid> Example: fb68d39a-5706-51b4-b2b2-7b4bf9cbf0af The ID (UUID) of the AccessKey that should be ensured. |
{- "id": "fb68d39a-5706-51b4-b2b2-7b4bf9cbf0af",
- "type": "accesskey",
- "href": "/accesskeys/fb68d39a-5706-51b4-b2b2-7b4bf9cbf0af",
- "metadata": {
- "createdDate": "2020-12-10T13:37:50+01:00",
- "createdBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
- "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
- "lastModifiedDate": "2020-12-11T13:37:50+01:00",
- "lastModifiedBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
- "lastModifiedByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
- "resourceURN": "ionos:<product>:<location>:<contract>:<resource-path>",
- "status": "AVAILABLE",
- "statusMessage": null,
- "administrative": false,
- "supportedRegions": [
- "de",
- "eu-central-2",
- "eu-south-2"
]
}, - "properties": {
- "description": "Access key details",
- "accessKey": "00000Du4KiV8A1tGUbjI2Ky1YmXqXnCpaQpgWw6_1V5fhMPRnAAAAAEIkfcQAAAAAAiR9xAioHCB_FWuNJ4un864Pouw",
- "secretKey": "tFVkUARsoeCdntQs2jVSyGG6TMPfPZ+ghnsWj/gG",
- "canonicalUserId": "a73e086eeaaa03e21e4e932ac8a2ed7a",
- "contractUserId": "11111111:00000000-0000-0000-0000-000000000000"
}
}
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.
This endpoint enables retrieving all Regions using pagination and optional filters.
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. |
{- "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-1.ionoscloud.com",
- "website": "s3-website-de-central.profitbricks.com",
- "capability": {
- "iam": false,
- "s3select": true
}, - "storageClasses": [
- "standard",
- "standardInfrequentAccess"
], - "location": "de/fra"
}
}
], - "offset": 0,
- "limit": 42,
- "_links": {
}
}
Returns the Region by Region.
region required | string Example: eu-central-3 The Region of the Region. |
{- "id": "eu-central-3",
- "type": "region",
- "href": "/regions/eu-central-3",
- "metadata": { },
- "properties": {
- "version": 1,
- "endpoint": "s3.eu-central-1.ionoscloud.com",
- "website": "s3-website-de-central.profitbricks.com",
- "capability": {
- "iam": false,
- "s3select": true
}, - "storageClasses": [
- "standard",
- "standardInfrequentAccess"
], - "location": "de/fra"
}
}