QOqovery
Project Secret

Add a secret to the project

  • Add a secret to the project.
    • If the secret key already exists, then it will be replaced by the new one.
    • If the secret value points toward an existing secret key, it will be considered as an alias.
post/project/{projectId}/secret

Request

Path parameters

projectIdstring uuid required

Project ID

Request body

keystring required

key is case sensitive

valuestring

value of the secret. Clear value will never be returned

mount_pathstring nullable

should be set for file only. variable mount path make secret a file (where file should be mounted).

descriptionstring nullable

optional variable description (255 character maximum)

enable_interpolation_in_fileboolean nullable

Response

Added a secret

idstring uuid required
created_atstring date-time required
updated_atstring date-time
keystring required

key is case sensitive

scope'APPLICATION' | 'BUILT_IN' | 'ENVIRONMENT' | 'PROJECT' | 'CONTAINER' | 'JOB' | 'HELM' | 'TERRAFORM' required
variable_type'VALUE' | 'ALIAS' | 'OVERRIDE' | 'BUILT_IN' | 'FILE'

type of the environment variable (VALUE, FILE, ALIAS, OVERRIDE or BUIT_IN)

service_idstring uuid
service_namestring
service_type'APPLICATION' | 'CONTAINER' | 'DATABASE' | 'JOB' | 'HELM' | 'TERRAFORM'

type of the service (application, database, job, gateway...)

owned_bystring

Entity that created/own the variable (i.e: Qovery, Doppler)

descriptionstring nullable

optional variable description (255 characters maximum)

enable_interpolation_in_fileboolean nullable

Example response

{
  "aliased_secret": {
    "key": "QOVERY_DATABASE_PSQL_NAME"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.