{ "opencollection": "1.0.0", "info": { "name": "Qovery Account Info Project Environment Variable API", "version": "1.0.4" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Project Environment Variable", "type": "folder" }, "items": [ { "info": { "name": "List project environment variables", "type": "http" }, "http": { "method": "GET", "url": "https://api.qovery.com/project/:projectId/environmentVariable", "params": [ { "name": "projectId", "value": "", "type": "path", "description": "Project ID" } ] }, "docs": "List project environment variables" }, { "info": { "name": "Add an environment variable to the project", "type": "http" }, "http": { "method": "POST", "url": "https://api.qovery.com/project/:projectId/environmentVariable", "params": [ { "name": "projectId", "value": "", "type": "path", "description": "Project ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "- Add an environment variable to the project.\n - If the environment variable key already exists, then it will be replaced by the new one.\n - If the environment variable value points toward an existing environment variable key, it will be considered as an alias.\n" }, { "info": { "name": "Edit an environment variable belonging to the project", "type": "http" }, "http": { "method": "PUT", "url": "https://api.qovery.com/project/:projectId/environmentVariable/:environmentVariableId", "params": [ { "name": "projectId", "value": "", "type": "path", "description": "Project ID" }, { "name": "environmentVariableId", "value": "", "type": "path", "description": "Environment Variable ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "- You can't edit a BUILT_IN variable\n- For an override, you can't edit the key\n- For an alias, you can't edit the value\n- An override can only have a scope lower to the variable it is overriding (hierarchy is BUILT_IN > PROJECT > ENVIRONMENT > APPLICATION)\n" }, { "info": { "name": "Delete an environment variable from a project", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.qovery.com/project/:projectId/environmentVariable/:environmentVariableId", "params": [ { "name": "projectId", "value": "", "type": "path", "description": "Project ID" }, { "name": "environmentVariableId", "value": "", "type": "path", "description": "Environment Variable ID" } ] }, "docs": "- To delete an environment variable you must have the project user permission\n- You can't delete a BUILT_IN variable\n- If you delete a variable having override or alias, the associated override/alias will be deleted as well\n" }, { "info": { "name": "Create an environment variable override at the project level", "type": "http" }, "http": { "method": "POST", "url": "https://api.qovery.com/project/:projectId/environmentVariable/:environmentVariableId/override", "params": [ { "name": "projectId", "value": "", "type": "path", "description": "Project ID" }, { "name": "environmentVariableId", "value": "", "type": "path", "description": "Environment Variable ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "- Allows you to override at project level an environment variable that has a higher scope.\n- You only have to specify a value in the request body\n- The system will create a new environment variable at project level with the same key as the one corresponding to the variable id in the path\n- The response body will contain the newly created variable\n- Information regarding the overridden_variable will be exposed in the \"overridden_variable\" field of the newly created variable\n" }, { "info": { "name": "Create an environment variable alias at the project level", "type": "http" }, "http": { "method": "POST", "url": "https://api.qovery.com/project/:projectId/environmentVariable/:environmentVariableId/alias", "params": [ { "name": "projectId", "value": "", "type": "path", "description": "Project ID" }, { "name": "environmentVariableId", "value": "", "type": "path", "description": "Environment Variable ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "- Allows you to add an alias at project level on an existing environment variable having higher scope, in order to customize its key.\n- You only have to specify a key in the request body\n- The system will create a new environment variable at project level with the same value as the one corresponding to the variable id in the path\n- The response body will contain the newly created variable\n- Information regarding the aliased_variable will be exposed in the \"aliased_variable\" field of the newly cr" } ] } ], "bundled": true }