https://api.katapult.io/core/v1/organizations/organization/object_storage/object_storage_cluster
| Code | Error | When it happens |
|---|---|---|
|
|
missing_api_token
|
No API token was provided in the Authorization header. Ensure a token is provided prefixed with Bearer |
|
|
unauthorized_network_for_api_token
|
Network is not allowed to access the API with this API token |
|
|
invalid_api_token
|
The API token provided was not valid (it may not exist or have expired) |
|
|
token_owner_suspended
|
The user that owns the API token has been suspended |
|
|
invalid_capabilities_token
|
The capabilities token provided was not valid (either not valid, expired or not signed by the correct key) |
|
|
scope_not_granted
|
The scope required for this endpoint has not been granted to the authenticating identity |
|
|
organization_suspended
|
An organization was found from the arguments provided but it was suspended |
|
|
organization_not_activated
|
An organization was found from the arguments provided but it wasn't activated yet |
|
|
permission_denied
|
The authenticated identity is not permitted to perform this action |
|
|
object_storage_account_not_provisioned
|
An object storage account was found but it is not provisioned. If the problem persists, try re-creating the account. |
|
|
object_storage_account_suspended
|
An object storage account was found from the arguments provided but it is suspended |
|
|
organization_not_found
|
No organization was found matching any of the criteria provided in the arguments |
|
|
object_storage_cluster_not_found
|
No object storage cluster was found matching any of the criteria provided in the arguments |
|
|
object_storage_account_not_found
|
No object storage account was found matching any of the criteria provided in the arguments |
|
|
object_in_trash
|
The object found is in the trash and therefore cannot be manipulated through the API. It should be restored in order to run this operation. |
|
|
validation_error
|
A validation error occurred with the object that was being created/updated/deleted |
|
|
rate_limit_reached
|
You have reached the rate limit for this type of request |
|
|
service_unavailable
|
The service is currently unavailable, please try again later |
organization
object
required
body
All 'organization[]' params are mutually exclusive, only one can be provided.
id
string
sub_domain
string
object_storage_cluster
object
required
body
region
string
trash_object
object
id
string
keep_until
integer
purge_after
integer
When the item becomes eligible for automatic purging under the current retention setting: the later of keep_until and the time it was trashed plus the retention period. Actual removal may be up to an hour later.
object_type
string
object_storage_account
object
region
string
created_at
integer
provisioning_state
string
size
integer
The total storage used in bytes (updated periodically)
bucket_count
integer
data_center
object
id
string
name
string
permalink
string
country
object
id
string
name
string
iso_code2
string
iso_code3
string
time_zone
string
eu
boolean
{
"trash_object": {
"id": "string",
"keep_until": 0,
"purge_after": 0,
"object_type": "string"
},
"object_storage_account": {
"region": "string",
"created_at": 0,
"provisioning_state": "provisioning",
"size": 0,
"bucket_count": 0,
"data_center": {
"id": "string",
"name": "string",
"permalink": "string",
"country": {
"id": "string",
"name": "string",
"iso_code2": "string",
"iso_code3": "string",
"time_zone": "string",
"eu": true
}
}
}
}Sent to https://api.katapult.io/core/v1 as a bearer token and never to Krystal Documentation. It isn't stored anywhere, so paste it again on each endpoint page.
Pre-filled with the endpoint's shape — declared defaults where it has them, otherwise a placeholder per type. Edit it before executing; the Arguments tab documents every field.