Skip to main content

Generate object storage S3 access key credentials

POST 

https://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

Body

    access_key

    object

    required

    id string

Responses

Returns new S3 credentials for an object storage access key. Existing credentials cannot be retrieved. Credentials may take a few minutes to become active.

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

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"
}
}'
Request Collapse all
Base URL
https://api.katapult.io/core/v1
Auth
Body
{
  "access_key": {
    "id": "string"
  }
}
ResponseClear

Click the Send API Request button above and see the response here!