Get an object storage bucket

GET 
/object_storage/object_storage_cluster/buckets/bucket

Returns object storage bucket details

Scopes

• object_storage:read

OAuth2 Scopes

When using OAuth2 authentication, scopes are prefixed with api.katapult.io/core/v1/.

Request

Query Parameters

object_storage_cluster[region] string

The object storage cluster region for the bucket.

bucket[name] string

The name of the object storage bucket.

Responses

200

Returns object storage bucket details

application/json

Schema

Schema

object_storage_bucket

object

required

name string

label stringnullable

created_at integer

state ObjectStorageBucketStateEnum (string)

Possible values: [pending, configured]

custom_domain stringnullable

object_count integernullable

size integernullable

serve_static_site boolean

static_site_index stringnullable

static_site_error stringnullable

public_url string

access_control_list

object

public_read boolean

public_list boolean

all_keys_read boolean

all_keys_write boolean

read_key_ids string[]

write_key_ids string[]

Example (from schema)

{
  "object_storage_bucket": {
    "name": "string",
    "label": "string",
    "created_at": 0,
    "state": "pending",
    "custom_domain": "string",
    "object_count": 0,
    "size": 0,
    "serve_static_site": true,
    "static_site_index": "string",
    "static_site_error": "string",
    "public_url": "string",
    "access_control_list": {
      "public_read": true,
      "public_list": true,
      "all_keys_read": true,
      "all_keys_write": true,
      "read_key_ids": [
        "string"
      ],
      "write_key_ids": [
        "string"
      ]
    }
  }
}

400

No API token was provided in the Authorization header. Ensure a token is provided prefixed with Bearer

application/json

Schema

Schema

code MissingAPITokenEnum (string)

Possible values: [missing_api_token]

description string
detail object

Example (from schema)

{
  "code": "missing_api_token",
  "description": "string",
  "detail": {}
}

403

403 error response

application/json

Schema

Schema

oneOf

UnauthorizedNetworkForAPITokenSchema

Network is not allowed to access the API with this API token

code UnauthorizedNetworkForAPITokenEnum (string)

Possible values: [unauthorized_network_for_api_token]

description string

detail

object

ip_address string

The IP address the request was received from

InvalidAPITokenSchema

The API token provided was not valid (it may not exist or have expired)

code InvalidAPITokenEnum (string)

Possible values: [invalid_api_token]

description string

detail

object

details stringnullable

InvalidCapabilitiesTokenSchema

The capabilities token provided was not valid (either not valid, expired or not signed by the correct key)

code InvalidCapabilitiesTokenEnum (string)

Possible values: [invalid_capabilities_token]

description string

detail object

ScopeNotGrantedErrorSchema

The scope required for this endpoint has not been granted to the authenticating identity

code ScopeNotGrantedErrorEnum (string)

Possible values: [scope_not_granted]

description string

detail

ScopeNotGrantedError

scopes string[]

PermissionDeniedSchema

The authenticated identity is not permitted to perform this action

code PermissionDeniedEnum (string)

Possible values: [permission_denied]

description string

detail

object

details stringnullable

Additional information regarding the reason why permission was denied

Example (from schema)

{}

404

404 error response

application/json

Schema

Schema

oneOf

ObjectStorageClusterNotFoundSchema

No object storage cluster was found matching any of the criteria provided in the arguments

code ObjectStorageClusterNotFoundEnum (string)

Possible values: [object_storage_cluster_not_found]

description string

detail object

ObjectStorageBucketNotFoundSchema

No object storage bucket was found matching any of the criteria provided in the arguments

code ObjectStorageBucketNotFoundEnum (string)

Possible values: [object_storage_bucket_not_found]

description string

detail object

Example (from schema)

{}

406

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.

application/json

Schema

Schema

code ObjectInTrashEnum (string)

Possible values: [object_in_trash]

description string

detail

object

trash_object

object

nullable

id string

keep_until integer

object_id string

object_type string

Example (from schema)

{
  "code": "object_in_trash",
  "description": "string",
  "detail": {
    "trash_object": {
      "id": "string",
      "keep_until": 0,
      "object_id": "string",
      "object_type": "string"
    }
  }
}

429

You have reached the rate limit for this type of request

application/json

Schema

Schema

code RateLimitReachedEnum (string)

Possible values: [rate_limit_reached]

description string

detail

object

total_permitted integer

The total number of requests per minute that are permitted

Example (from schema)

{
  "code": "rate_limit_reached",
  "description": "string",
  "detail": {
    "total_permitted": 0
  }
}

500

Multiple object storage buckets were found matching the criteria provided in the arguments

application/json

Schema

Schema

code MultipleObjectStorageBucketsFoundEnum (string)

Possible values: [multiple_object_storage_buckets_found]

description string
detail object

Example (from schema)

{
  "code": "multiple_object_storage_buckets_found",
  "description": "string",
  "detail": {}
}

503

The service is currently unavailable, please try again later

application/json

Schema

Schema

code ServiceUnavailableEnum (string)

Possible values: [service_unavailable]

description string
detail object

Example (from schema)

{
  "code": "service_unavailable",
  "description": "string",
  "detail": {}
}

Loading...