Secrets

Download schema

A secret reference is a logical reference to a secret stored in Scaleway Secret Manager, and it can only be managed within the context of a job definition.

List secrets references within a job definition

GET

https://api.scaleway.com

/serverless-jobs/v1alpha2/regions/{region}/secrets

List secrets references within a job definition › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

List secrets references within a job definition › query Parameters

job_definition_id

string · required

UUID of the job definition.

List secrets references within a job definition › Responses

200

scaleway.serverless_jobs.v1alpha2.ListSecretsResponse

scaleway.serverless_jobs.v1alpha2.Secret[]

List of secret references within a job definition.

total_count

integer · uint64

Total count of secret references within a job definition.

Create a secret reference within a job definition

POST

https://api.scaleway.com

/serverless-jobs/v1alpha2/regions/{region}/secrets

Create a secret reference within a job definition › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

Create a secret reference within a job definition › Request Body

job_definition_id

string · required

UUID of the job definition.

scaleway.serverless_jobs.v1alpha2.CreateSecretsRequest.SecretConfig[] · required

List of secrets to inject into the job.

Create a secret reference within a job definition › Responses

200

scaleway.serverless_jobs.v1alpha2.CreateSecretsResponse

scaleway.serverless_jobs.v1alpha2.Secret[]

List of secrets created.

POST/serverless-jobs/v1alpha2/regions/{region}/secrets

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"job_definition_id":"string","secrets":[""]}' \
  "https://api.scaleway.com/serverless-jobs/v1alpha2/regions/{region}/secrets"

Example Request Body

{
  "job_definition_id": "job_definition_id",
  "secrets": [
    {
      "secret_manager_id": "secret_manager_id",
      "secret_manager_version": "secret_manager_version",
      "path": "path",
      "env_var_name": "env_var_name"
    }
  ]
}

json

Example Responses

{
  "secrets": [
    {
      "secret_id": "6170692e-7363-616c-6577-61792e636f6d",
      "secret_manager_id": "6170692e-7363-616c-6577-61792e636f6d",
      "secret_manager_version": "secret_manager_version",
      "job_definition_id": "6170692e-7363-616c-6577-61792e636f6d",
      "file": {
        "path": "path"
      },
      "env_var": {
        "name": "name"
      }
    }
  ]
}

json

application/json

Get a secret references within a job definition

GET

https://api.scaleway.com

/serverless-jobs/v1alpha2/regions/{region}/secrets/{secret_id}

Get a secret references within a job definition › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

secret_id

string · required

UUID of the secret reference within the job.

Get a secret references within a job definition › Responses

200

scaleway.serverless_jobs.v1alpha2.Secret

job_definition_id

string · required

UUID of the job definition. (UUID format)

secret_id

string

UUID of the secret reference within the job. (UUID format)

secret_manager_id

string

UUID of the secret in Secret Manager. (UUID format)

secret_manager_version

string

Version of the secret in Secret Manager.

File secret mounted inside the job.

Environment variable used to expose the secret.

Update a secret reference within a job definition

PATCH

https://api.scaleway.com

/serverless-jobs/v1alpha2/regions/{region}/secrets/{secret_id}

Update a secret reference within a job definition › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

secret_id

string · required

UUID of the secret reference within the job.

Update a secret reference within a job definition › Request Body

secret_manager_version

string | null

Version of the secret in Secret Manager.

path

string | null · pattern: ^/[a-zA-Z0-9/_-]*(\.…

Path of the secret to mount inside the job (either path or env_var_name must be set).

env_var_name

string | null · pattern: [-._a-zA-Z0-9]+

Environment variable name used to expose the secret inside the job (either path or env_var_name must be set).

Update a secret reference within a job definition › Responses

200

scaleway.serverless_jobs.v1alpha2.Secret

job_definition_id

string · required

UUID of the job definition. (UUID format)

secret_id

string

UUID of the secret reference within the job. (UUID format)

secret_manager_id

string

UUID of the secret in Secret Manager. (UUID format)

secret_manager_version

string

Version of the secret in Secret Manager.

File secret mounted inside the job.

Environment variable used to expose the secret.

Delete a secret reference within a job definition

DELETE

https://api.scaleway.com

/serverless-jobs/v1alpha2/regions/{region}/secrets/{secret_id}

Delete a secret reference within a job definition › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

secret_id

string · required

UUID of the secret reference within the job.

Delete a secret reference within a job definition › Responses

No data returned

Job runs triggers