Skip to content

JobEnvironmentVariableApi.md

Latest commit

 

History

History
232 lines (131 loc) · 9.53 KB

JobEnvironmentVariableApi.md

File metadata and controls

232 lines (131 loc) · 9.53 KB

\JobEnvironmentVariableApi

All URIs are relative to https://api.qovery.com

Method HTTP request Description
create_job_environment_variable POST /job/{jobId}/environmentVariable Add an environment variable to the job
create_job_environment_variable_alias POST /job/{jobId}/environmentVariable/{environmentVariableId}/alias Create an environment variable alias at the job level
create_job_environment_variable_override POST /job/{jobId}/environmentVariable/{environmentVariableId}/override Create an environment variable override at the job level
delete_job_environment_variable DELETE /job/{jobId}/environmentVariable/{environmentVariableId} Delete an environment variable from a job
edit_job_environment_variable PUT /job/{jobId}/environmentVariable/{environmentVariableId} Edit an environment variable belonging to the job
import_job_environment_variable POST /job/{jobId}/environmentVariable/import Import variables
list_job_environment_variable GET /job/{jobId}/environmentVariable List environment variables

create_job_environment_variable

models::EnvironmentVariable create_job_environment_variable(job_id, environment_variable_request) Add an environment variable to the job

  • Add an environment variable to the job.

Parameters

Name Type Description Required Notes
job_id uuid::Uuid Job ID [required]
environment_variable_request Option<EnvironmentVariableRequest>

Return type

models::EnvironmentVariable

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_job_environment_variable_alias

models::EnvironmentVariable create_job_environment_variable_alias(job_id, environment_variable_id, key) Create an environment variable alias at the job level

  • Allows you to add an alias at job level on an existing environment variable having higher scope, in order to customize its key. - You only have to specify a key in the request body - The system will create a new environment variable at job level with the same value as the one corresponding to the variable id in the path - The response body will contain the newly created variable - Information regarding the aliased_variable will be exposed in the "aliased_variable" field of the newly created variable - You can't create an alias on an alias

Parameters

Name Type Description Required Notes
job_id uuid::Uuid Job ID [required]
environment_variable_id uuid::Uuid Environment Variable ID [required]
key Option<Key>

Return type

models::EnvironmentVariable

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_job_environment_variable_override

models::EnvironmentVariable create_job_environment_variable_override(job_id, environment_variable_id, value) Create an environment variable override at the job level

  • Allows you to override at job level an environment variable that has a higher scope. - You only have to specify a value in the request body - The system will create a new environment variable at job level with the same key as the one corresponding to the variable id in the path - The response body will contain the newly created variable - Information regarding the overridden_variable will be exposed in the "overridden_variable" field of the newly created variable

Parameters

Name Type Description Required Notes
job_id uuid::Uuid Job ID [required]
environment_variable_id uuid::Uuid Environment Variable ID [required]
value Option<Value>

Return type

models::EnvironmentVariable

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_job_environment_variable

delete_job_environment_variable(job_id, environment_variable_id) Delete an environment variable from a job

  • To delete an environment variable from an job you must have the project user permission - You can't delete a BUILT_IN variable - If you delete a variable having override or alias, the associated override/alias will be deleted as well

Parameters

Name Type Description Required Notes
job_id uuid::Uuid Job ID [required]
environment_variable_id uuid::Uuid Environment Variable ID [required]

Return type

(empty response body)

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

edit_job_environment_variable

models::EnvironmentVariable edit_job_environment_variable(job_id, environment_variable_id, environment_variable_edit_request) Edit an environment variable belonging to the job

  • You can't edit a BUILT_IN variable - For an override, you can't edit the key - For an alias, you can't edit the value - An override can only have a scope lower to the variable it is overriding (hierarchy is BUILT_IN > PROJECT > ENVIRONMENT > CONTAINER)

Parameters

Name Type Description Required Notes
job_id uuid::Uuid Job ID [required]
environment_variable_id uuid::Uuid Environment Variable ID [required]
environment_variable_edit_request EnvironmentVariableEditRequest [required]

Return type

models::EnvironmentVariable

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

import_job_environment_variable

models::VariableImport import_job_environment_variable(job_id, variable_import_request) Import variables

Import environment variables in a defined scope, with a defined visibility.

Parameters

Name Type Description Required Notes
job_id uuid::Uuid Job ID [required]
variable_import_request Option<VariableImportRequest>

Return type

models::VariableImport

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_job_environment_variable

models::EnvironmentVariableResponseList list_job_environment_variable(job_id) List environment variables

Parameters

Name Type Description Required Notes
job_id uuid::Uuid Job ID [required]

Return type

models::EnvironmentVariableResponseList

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]