keys

Overview

Name	Datatype	Description
`id`	`integer`	This keypair's unique ID
`access_key`	`string`	This keypair's access key. This is not secret.
`bucket_access`	`array`	Defines this key as a Limited Access Key. Limited Access Keys restrict this Object Storage key's access to only the bucket(s) declared in this array and define their bucket-level permissions. Limited Access Keys can: list all buckets available on this Account, but cannot perform any actions on a bucket unless it has access to the bucket. create new buckets, but do not have any access to the buckets it creates, unless explicitly given access to them. Note: You can create an Object Storage Limited Access Key without access to any buckets. This is achieved by sending a request with an empty `bucket_access` array. Note: If this field is omitted, a regular unlimited access key is issued.
`label`	`string`	The label given to this key. For display purposes only.
`limited`	`boolean`	Whether or not this key is a limited access key. Will return `false` if this key grants full access to all buckets on the user's account.
`secret_key`	`string`	This keypair's secret key. Only returned on key creation.

Name	Accessible by	Required Params	Description
`getObjectStorageKey`	`SELECT`	`keyId`	Returns a single Object Storage Key provisioned for your account.
`getObjectStorageKeys`	`SELECT`		Returns a paginated list of Object Storage Keys for authenticating to the Object Storage S3 API.
`createObjectStorageKeys`	`INSERT`		Provisions a new Object Storage Key on your account. Accounts with negative balances cannot access this command. To create a Limited Access Key with specific permissions, send a `bucket_access` array. To create a Limited Access Key without access to any buckets, send an empty `bucket_access` array. * To create an Access Key with unlimited access to all clusters and all buckets, omit the `bucket_access` array.
`deleteObjectStorageKey`	`DELETE`	`keyId`	Revokes an Object Storage Key. This keypair will no longer be usable by third-party clients.
`_getObjectStorageKey`	`EXEC`	`keyId`	Returns a single Object Storage Key provisioned for your account.
`_getObjectStorageKeys`	`EXEC`		Returns a paginated list of Object Storage Keys for authenticating to the Object Storage S3 API.
`updateObjectStorageKey`	`EXEC`	`keyId`	Updates an Object Storage Key on your account.