Secrets
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
path Parameters
regionThe region you want to target
query Parameters
job_definition_idUUID of the job definition.
List secrets references within a job definition › Responses
List of secret references within a job definition.
total_countTotal count of secret references within a job definition.
Create a secret reference within a job definition
path Parameters
regionThe region you want to target
Create a secret reference within a job definition › Request Body
job_definition_idUUID of the job definition.
List of secrets to inject into the job.
Create a secret reference within a job definition › Responses
List of secrets created.
Get a secret references within a job definition
path Parameters
regionThe region you want to target
secret_idUUID of the secret reference within the job.
Get a secret references within a job definition › Responses
job_definition_idUUID of the job definition. (UUID format)
secret_idUUID of the secret reference within the job. (UUID format)
srn^srn://jobs\.[^/]+/r…SRN of the secret reference.
secret_manager_idUUID of the secret in Secret Manager. (UUID format)
secret_manager_versionVersion of the secret in Secret Manager.
File secret mounted inside the job. One of file, env_var is required.
Environment variable used to expose the secret. One of file, env_var is required.
regionRegion in which the secret reference exists.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: file | |
| type = object · requires: env_var |
File secret mounted inside the job. One of file, env_var is required.
secret_idUUID of the secret reference within the job. (UUID format)
srn^srn://jobs\.[^/]+/r…SRN of the secret reference.
secret_manager_idUUID of the secret in Secret Manager. (UUID format)
secret_manager_versionVersion of the secret in Secret Manager.
job_definition_idUUID of the job definition. (UUID format)
Environment variable used to expose the secret. One of file, env_var is required.
regionRegion in which the secret reference exists.
Update a secret reference within a job definition
path Parameters
regionThe region you want to target
secret_idUUID of the secret reference within the job.
Update a secret reference within a job definition › Request Body
secret_manager_versionVersion of the secret in Secret Manager.
path^/[a-zA-Z0-9/_-]*(\.…Path of the secret to mount inside the job (either path or env_var_name must be set).
Precisely one of path, env_var_name can be set.
env_var_name[-._a-zA-Z0-9]+Environment variable name used to expose the secret inside the job (either path or env_var_name must be set).
Precisely one of path, env_var_name can be set.
Update a secret reference within a job definition › Responses
job_definition_idUUID of the job definition. (UUID format)
secret_idUUID of the secret reference within the job. (UUID format)
srn^srn://jobs\.[^/]+/r…SRN of the secret reference.
secret_manager_idUUID of the secret in Secret Manager. (UUID format)
secret_manager_versionVersion of the secret in Secret Manager.
File secret mounted inside the job. One of file, env_var is required.
Environment variable used to expose the secret. One of file, env_var is required.
regionRegion in which the secret reference exists.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: file | |
| type = object · requires: env_var |
File secret mounted inside the job. One of file, env_var is required.
secret_idUUID of the secret reference within the job. (UUID format)
srn^srn://jobs\.[^/]+/r…SRN of the secret reference.
secret_manager_idUUID of the secret in Secret Manager. (UUID format)
secret_manager_versionVersion of the secret in Secret Manager.
job_definition_idUUID of the job definition. (UUID format)
Environment variable used to expose the secret. One of file, env_var is required.
regionRegion in which the secret reference exists.