Create object storage access key

POST 
/organizations/organization/object_storage/object_storage_cluster/access_keys

Create a new access key in an object storage account

Scopes

• object_storage

OAuth2 Scopes

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

Request

application/json

Body

organization

object

required

All 'organization[]' params are mutually exclusive, only one can be provided.

id string

sub_domain string

object_storage_cluster

object

required

region string

properties

object

required

name stringrequired

The name of the access key

all_buckets_read boolean

Some S3 clients require this permission to successfully connect to your account.

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

Responses

201

Create a new access key in an object storage account

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[]

OrganizationSuspendedSchema

An organization was found from the arguments provided but it was suspended

code OrganizationSuspendedEnum (string)

Possible values: [organization_suspended]

description string

detail object

OrganizationNotActivatedSchema

An organization was found from the arguments provided but it wasn't activated yet

code OrganizationNotActivatedEnum (string)

Possible values: [organization_not_activated]

description string

detail object

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

ObjectStorageAccountNotProvisionedSchema

An object storage account was found but it is not provisioned. If the problem persists, try re-creating the account.

code ObjectStorageAccountNotProvisionedEnum (string)

Possible values: [object_storage_account_not_provisioned]

description string

detail object

ObjectStorageAccountSuspendedSchema

An object storage account was found from the arguments provided but it is suspended

code ObjectStorageAccountSuspendedEnum (string)

Possible values: [object_storage_account_suspended]

description string

detail object

Example (from schema)

{}

404

404 error response

application/json

Schema

Schema

oneOf

OrganizationNotFoundSchema

No organization was found matching any of the criteria provided in the arguments

code OrganizationNotFoundEnum (string)

Possible values: [organization_not_found]

description string

detail object

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

ObjectStorageAccountNotFoundSchema

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

code ObjectStorageAccountNotFoundEnum (string)

Possible values: [object_storage_account_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"
    }
  }
}

422

A validation error occurred with the object that was being created/updated/deleted

application/json

Schema

Schema

code ValidationErrorEnum (string)

Possible values: [validation_error]

description string

detail

ValidationError

errors string[]

Example (from schema)

{
  "code": "validation_error",
  "description": "string",
  "detail": {
    "errors": [
      "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
  }
}

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