https://api.katapult.io/core/v1/organizations/organization/object_storage/object_storage_cluster/buckets
| 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
properties
object
required
body
name
string
Can only include lowercase alphanumeric characters and hyphens, has to be globally unique.
label
string
Optional alternative name/comment.
serve_static_site
boolean
Whether to serve the bucket as a static website, defaults to false.
static_site_index
string
Optional name of the index html page for a static website (requires public_read).
static_site_error
string
Optional name of the error html page for a static website (requires public_read).
cors_origins
array
access_control_list
object
public_read
boolean
Allow anyone to read objects in the bucket.
public_list
boolean
Allow anyone to list objects in the bucket (requires public_read).
all_keys_read
boolean
Allow any access key to read objects in the bucket.
all_keys_write
boolean
Allow any access key to create or delete objects in the bucket.
read_key_ids
array
write_key_ids
array
object_storage_bucket
object
name
string
label
string
created_at
integer
state
string
custom_domains
array
object_count
integer
size
integer
serve_static_site
boolean
static_site_index
string
static_site_error
string
cors_origins
array
public_url
string
access_control_list
object
public_read
boolean
public_list
boolean
all_keys_read
boolean
all_keys_write
boolean
read_key_ids
array
write_key_ids
array
{
"object_storage_bucket": {
"name": "string",
"label": "string",
"created_at": 0,
"state": "pending",
"custom_domains": [],
"object_count": 0,
"size": 0,
"serve_static_site": true,
"static_site_index": "string",
"static_site_error": "string",
"cors_origins": [],
"public_url": "string",
"access_control_list": {
"public_read": true,
"public_list": true,
"all_keys_read": true,
"all_keys_write": true,
"read_key_ids": [],
"write_key_ids": []
}
}
}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.