An API key is a unique identifier, used to authenticate requests made to the Scaleway API. An API key consists of an access key and a secret key. The access key is like a unique ID or username, and not a sensitive piece of information. The secret key however is more sensitive, as it is like a password to authenticate the access key.
Previously, an API key was associated with a single Scaleway ProjectOpen in new context. The API key therefore had full read/write access to all resources on this Project, and only this Project.
With IAM, an API key is now associated with an IAM userOpen in new context or applicationOpen in new context. This allows fine-grained access to be defined for the IAM user bearing the API key across different Organizations, Projects, and resources.
List API keys
List API keys. By default, the API keys listed are ordered by creation date in ascending order. This can be modified via the order_by field. You can define additional parameters for your query such as editable, expired, access_key and bearer_id.
query Parameters
order_byCriteria for sorting results.
pagePage number. Value must be greater or equal to 1.
page_sizeNumber of results per page. Value must be between 1 and 100.
organization_idID of Organization.
editableDefines whether to filter out editable API keys or not.
expiredDefines whether to filter out expired API keys or not.
access_keyFilter by access key (deprecated in favor of access_keys).
descriptionFilter by description.
bearer_idFilter by bearer ID.
bearer_typeFilter by type of bearer.
access_keysFilter by a list of access keys.
List API keys › Responses
List of API keys.
total_countTotal count of API Keys.
Create an API key
Create an API key. You must specify the application_id or the user_id and the description. You can also specify the default_project_id, which is the Project ID of your preferred Project, to use with Object Storage. The access_key and secret_key values are returned in the response. Note that the secret key is only shown once. Make sure that you copy and store both keys somewhere safe.
Create an API key › Request Body
application_idID of the application.
user_idID of the user.
expires_atExpiration date of the API key. (RFC 3339 format)
default_project_idDefault Project ID to use with Object Storage.
descriptionDescription of the API key (max length is 200 characters).
Create an API key › Responses
access_keyAccess key of the API key.
secret_keySecret key of the API Key.
application_idID of application that bears the API key.
user_idID of user that bears the API key.
descriptionDescription of API key.
created_atDate and time of API key creation. (RFC 3339 format)
updated_atDate and time of last API key update. (RFC 3339 format)
expires_atDate and time of API key expiration. (RFC 3339 format)
default_project_idDefault Project ID specified for this API key.
editableDefines whether or not the API key is editable.
deletableDefines whether or not the API key is deletable.
managedDefines whether or not the API key is managed.
creation_ipIP address of the device that created the API key.
Get an API key
Retrieve information about an API key, specified by the access_key parameter. The API key's details, including either the user_id or application_id of its bearer are returned in the response. Note that the string value for the secret_key is nullable, and therefore is not displayed in the response. The secret_key value is only displayed upon API key creation.
path Parameters
access_keyAccess key to search for.
Get an API key › Responses
access_keyAccess key of the API key.
secret_keySecret key of the API Key.
application_idID of application that bears the API key.
user_idID of user that bears the API key.
descriptionDescription of API key.
created_atDate and time of API key creation. (RFC 3339 format)
updated_atDate and time of last API key update. (RFC 3339 format)
expires_atDate and time of API key expiration. (RFC 3339 format)
default_project_idDefault Project ID specified for this API key.
editableDefines whether or not the API key is editable.
deletableDefines whether or not the API key is deletable.
managedDefines whether or not the API key is managed.
creation_ipIP address of the device that created the API key.
Update an API key
Update the parameters of an API key, including default_project_id and description.
path Parameters
access_keyAccess key to update.
Update an API key › Request Body
default_project_idNew default Project ID to set.
descriptionNew description to update.
expires_atNew expiration date of the API key. (RFC 3339 format)
Update an API key › Responses
access_keyAccess key of the API key.
secret_keySecret key of the API Key.
application_idID of application that bears the API key.
user_idID of user that bears the API key.
descriptionDescription of API key.
created_atDate and time of API key creation. (RFC 3339 format)
updated_atDate and time of last API key update. (RFC 3339 format)
expires_atDate and time of API key expiration. (RFC 3339 format)
default_project_idDefault Project ID specified for this API key.
editableDefines whether or not the API key is editable.
deletableDefines whether or not the API key is deletable.
managedDefines whether or not the API key is managed.
creation_ipIP address of the device that created the API key.