Generate object storage S3 access key credentials

POST 
/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

id string

Responses

200

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

Schema

object_storage_access_key

object

required

id string

name string

created_at integer

region string

state ObjectStorageAccessKeyStateEnum (string)

Possible values: [pending, configured]

all_buckets_read boolean

Global access to list all buckets

all_objects_read boolean

Global read access for objects in all buckets

all_objects_write boolean

Global write access to create and delete objects in all buckets

read_buckets string[]

write_buckets string[]

server_url stringnullable

The server URL for the S3 credentials

s3_access_key_id stringnullable

The S3 access key ID

s3_secret_access_key stringnullable

Only available when using the generate credentials endpoint

Example (from schema)

{
  "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"
  }
}

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

No object storage access key was found matching any of the criteria provided in the arguments.

application/json

Schema

Schema

code ObjectStorageAccessKeyNotFoundEnum (string)

Possible values: [object_storage_access_key_not_found]

description string
detail object

Example (from schema)

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

406

This error means that a background task that was needed to complete your request could not be queued

application/json

Schema

Schema

code TaskQueueingErrorEnum (string)

Possible values: [task_queueing_error]

description string

detail

object

details string

Example (from schema)

{
  "code": "task_queueing_error",
  "description": "string",
  "detail": {
    "details": "string"
  }
}

422

Provisioning is in progress. Please try again later.

application/json

Schema

Schema

code ObjectStorageProvisioningErrorEnum (string)

Possible values: [object_storage_provisioning_error]

description string
detail object

Example (from schema)

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

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
  }
}

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...