diff --git a/index.html b/index.html index 79279065..0e3b3064 100644 --- a/index.html +++ b/index.html @@ -5756,13 +5756,13 @@
Authorizations:
bearerAuthApiKeyAuth
path Parameters
variableId
required
string <uuid>

Variable ID

Request Body schema: application/json
key
required
string

the key of the environment variable

value
string or null

the value of the environment variable

-
description
string or null <= 255 characters

optional variable description (255 characters maximum)

-

Responses

description
string or null <= 255 characters

optional variable description (255 characters maximum)

+
enable_interpolation_in_file
boolean or null

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "value": "string",
  • "mount_path": "string",
  • "overridden_variable": {
    },
  • "aliased_variable": {
    },
  • "scope": "APPLICATION",
  • "variable_type": "VALUE",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION",
  • "owned_by": "string",
  • "is_secret": true,
  • "description": "string",
  • "enable_interpolation_in_file": true
}

Import variables

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

+

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": "string",
  • "description": "string",
  • "enable_interpolation_in_file": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "value": "string",
  • "mount_path": "string",
  • "overridden_variable": {
    },
  • "aliased_variable": {
    },
  • "scope": "APPLICATION",
  • "variable_type": "VALUE",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION",
  • "owned_by": "string",
  • "is_secret": true,
  • "description": "string",
  • "enable_interpolation_in_file": true
}

Import variables

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

Authorizations:
bearerAuthApiKeyAuth
query Parameters
service_id
required
string <uuid>

service id

service_type
required
string (ServiceTypeForVariableEnum)
Enum: "APPLICATION" "CONTAINER" "JOB" "HELM"

service type

Request Body schema: application/json
overwrite
required
boolean
Default: false
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "first_name": "string",
  • "last_name": "string",
  • "user_email": "string",
  • "type_of_use": "PERSONAL",
  • "qovery_usage": "string",
  • "company_name": "string",
  • "company_size": "1-10",
  • "user_role": "string",
  • "qovery_usage_other": "string",
  • "user_questions": "string",
  • "current_step": "string",
  • "dx_auth": true,
  • "infrastructure_hosting": "string"
}