{ "opencollection": "1.0.0", "info": { "name": "Convex Deployment Platform AccessTokens EnvironmentVariables API", "version": "v1-beta" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "EnvironmentVariables", "type": "folder" }, "items": [ { "info": { "name": "List environment variables", "type": "http" }, "http": { "method": "POST", "url": "https://{deploymentName}.convex.cloud/api/v1/list_environment_variables" }, "docs": "Retrieves all environment variables configured for the deployment. Returns an array of key-value pairs representing the current environment variable configuration. Sensitive values are returned in full and should be handled securely. Authentication requires a deployment key, Team Access Token, or OAuth Application Token formatted as \"Convex {token}\" in the Authorization header." }, { "info": { "name": "Update environment variables", "type": "http" }, "http": { "method": "POST", "url": "https://{deploymentName}.convex.cloud/api/v1/update_environment_variables", "body": { "type": "json", "data": "{}" } }, "docs": "Creates or updates one or more environment variables for the deployment. Existing variables with matching keys are overwritten. Variables not included in the request are left unchanged. Changes take effect after the next deployment push. Authentication requires a deployment key, Team Access Token, or OAuth Application Token formatted as \"Convex {token}\" in the Authorization header." }, { "info": { "name": "Delete environment variables", "type": "http" }, "http": { "method": "POST", "url": "https://{deploymentName}.convex.cloud/api/v1/delete_environment_variables", "body": { "type": "json", "data": "{}" } }, "docs": "Removes one or more environment variables from the deployment by their key names. Deleted variables are no longer accessible to backend functions after the next deployment push. Authentication requires a deployment key, Team Access Token, or OAuth Application Token formatted as \"Convex {token}\" in the Authorization header." } ] } ], "bundled": true }