Key Manager API

Scaleway's Key Manager allows you to create, manage and use cryptographic keys in a centralized and secure service. All your cryptographic operations can be delegated to the Key Manager, which in turn ensures the security and availability of your keys.

Key Manager supports the following cryptographic operations: data encryption, data decryption, and data encryption key generation.

Concepts

Refer to our dedicated concepts pageOpen in new context to find definitions of the different terms referring to Key Manager.

Quickstart

1. Configure your environment variables.

   Note

   This is an optional step that seeks to simplify your usage of the API.

   Code
   export SCW_ACCESS_KEY="<API access key>"
   export SCW_SECRET_KEY="<API secret key>"
   export SCW_PROJECT_ID="<Scaleway Project ID>"

2. Create a key. Run the following command to create a key that you can use to encrypt and decrypt your data:

   Code
   curl "https://api.scaleway.com/key-manager/v1alpha1/regions/$REGION/keys" \
     -H "Content-Type: application/json" \
     -H "X-Auth-Token: $SCW_SECRET_KEY" \
     -d '{
       "project_id": "$PROJECT_ID",
       "name": "my-key",
       "usage": {
           "symmetric_encryption": "aes_256_gcm"
       }
      }'

3. Rotate your key. Run the following command to generate a new version of your key. This operation renders your previous key version obsolete.

   Code
   curl "https://api.scaleway.com/key-manager/v1alpha1/regions/$REGION/keys/<KEY_ID>/rotate" \
     -H "X-Auth-Token: $SCW_SECRET_KEY" \
     -d '{
       "key_id": "$KEY_ID"
     }'

4. Encrypt data. Run the following command to encrypt data with the key you have created in step 2:

   Code
   curl "https://api.scaleway.com/key-manager/v1alpha1/regions/$REGION/keys/<KEY_ID>/encrypt" \
     -H "X-Auth-Token: $SCW_SECRET_KEY" \
     -d '{
       "key_id": "$KEY_ID",
       "plaintext": "'"$(echo -n "plaintext-data" | base64)"'"
     }'

5. Generate a data encryption key. Run the following command to generate a data encryption key that you can use for cryptographic operations outside of Key Manager:

   Code
   curl "https://api.scaleway.com/key-manager/v1alpha1/regions/$REGION/keys/<KEY_ID>/generate-data-key" \
     -H "X-Auth-Token: $SCW_SECRET_KEY" \
     -d '{
       "key_id": "$KEY_ID",
       "algorithm": "aes_256_gcm"
     }'