Generate object storage S3 access key credentials
POSThttps://api.katapult.io/core/v1/object_storage/access_keys/access_key/generate_credentials
Returns new S3 credentials for an object storage access key. Existing credentials cannot be retrieved. Credentials may take a few minutes to become active.
Scopes
object_storage
OAuth2 Scopes
When using OAuth2 authentication, scopes are prefixed with api.katapult.io/core/v1/
.
Request
- application/json
Body
access_key
object
required
Responses
- 200
- 400
- 403
- 404
- 406
- 422
- 429
- 503
Returns new S3 credentials for an object storage access key. Existing credentials cannot be retrieved. Credentials may take a few minutes to become active.
- application/json
- Schema
- Example (from schema)
Schema
object_storage_access_key
object
required
{
"object_storage_access_key": {
"id": "string",
"name": "string",
"created_at": 0,
"region": "string",
"state": "pending",
"all_buckets_read": true,
"all_objects_read": true,
"all_objects_write": true,
"read_buckets": [
"string"
],
"write_buckets": [
"string"
],
"server_url": "string",
"s3_access_key_id": "string",
"s3_secret_access_key": "string"
}
}
No API token was provided in the Authorization header. Ensure a token is provided prefixed with Bearer
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [missing_api_token
]
{
"code": "missing_api_token",
"description": "string",
"detail": {}
}
403 error response
- application/json
- Schema
- Example (from schema)
Schema
- UnauthorizedNetworkForAPITokenSchema
- InvalidAPITokenSchema
- InvalidCapabilitiesTokenSchema
- ScopeNotGrantedErrorSchema
- PermissionDeniedSchema
oneOf
Network is not allowed to access the API with this API token
Possible values: [unauthorized_network_for_api_token
]
detail
object
The API token provided was not valid (it may not exist or have expired)
Possible values: [invalid_api_token
]
detail
object
The capabilities token provided was not valid (either not valid, expired or not signed by the correct key)
Possible values: [invalid_capabilities_token
]
The scope required for this endpoint has not been granted to the authenticating identity
Possible values: [scope_not_granted
]
detail
ScopeNotGrantedError
The authenticated identity is not permitted to perform this action
Possible values: [permission_denied
]
detail
object
{}
No object storage access key was found matching any of the criteria provided in the arguments.
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [object_storage_access_key_not_found
]
{
"code": "object_storage_access_key_not_found",
"description": "string",
"detail": {}
}
This error means that a background task that was needed to complete your request could not be queued
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [task_queueing_error
]
detail
object
{
"code": "task_queueing_error",
"description": "string",
"detail": {
"details": "string"
}
}
Provisioning is in progress. Please try again later.
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [object_storage_provisioning_error
]
{
"code": "object_storage_provisioning_error",
"description": "string",
"detail": {}
}
You have reached the rate limit for this type of request
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [rate_limit_reached
]
detail
object
{
"code": "rate_limit_reached",
"description": "string",
"detail": {
"total_permitted": 0
}
}
The service is currently unavailable, please try again later
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [service_unavailable
]
{
"code": "service_unavailable",
"description": "string",
"detail": {}
}
- curl
- python
- go
- nodejs
- ruby
- csharp
- php
- java
- powershell
- CURL
curl -L 'https://api.katapult.io/core/v1/object_storage/access_keys/access_key/generate_credentials' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
"access_key": {
"id": "string"
}
}'