{
"opencollection": "1.0.0",
"info": {
"name": "Netlify Netlify's API documentation accessToken environmentVariables API",
"version": "2.33.1"
},
"request": {
"auth": {
"type": "oauth2",
"flow": "implicit",
"authorizationUrl": "https://app.netlify.com/authorize",
"credentials": {
"clientId": "{{clientId}}"
}
}
},
"items": [
{
"info": {
"name": "environmentVariables",
"type": "folder"
},
"items": [
{
"info": {
"name": "getEnvVars",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.netlify.com/api/v1/accounts/:account_id/env",
"params": [
{
"name": "account_id",
"value": "",
"type": "path",
"description": "Scope response to account_id"
},
{
"name": "context_name",
"value": "",
"type": "query",
"description": "Filter by deploy context"
},
{
"name": "scope",
"value": "",
"type": "query",
"description": "Filter by scope"
},
{
"name": "site_id",
"value": "",
"type": "query",
"description": "If specified, only return environment variables set on this site"
}
]
},
"docs": "Returns all environment variables for an account or site. An account corresponds to a team in the Netlify UI. To use this endpoint, your site must no longer be using the classic environment variables experience. Migrate now with the Netlify UI."
},
{
"info": {
"name": "createEnvVars",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.netlify.com/api/v1/accounts/:account_id/env",
"params": [
{
"name": "account_id",
"value": "",
"type": "path",
"description": "Scope response to account_id"
},
{
"name": "site_id",
"value": "",
"type": "query",
"description": "If provided, create an environment variable on the site level, not the account level"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates new environment variables. Granular scopes are available on Pro plans and above. To use this endpoint, your site must no longer be using the classic environment variables experience. Migrate now with the Netlify UI."
},
{
"info": {
"name": "getSiteEnvVars",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.netlify.com/api/v1/api/v1/sites/:site_id/env",
"params": [
{
"name": "context_name",
"value": "",
"type": "query",
"description": "Filter by deploy context"
},
{
"name": "scope",
"value": "",
"type": "query",
"description": "Filter by scope"
},
{
"name": "site_id",
"value": "",
"type": "path",
"description": "Scope response to site_id"
}
]
},
"docs": "Returns all environment variables for a site. This convenience method behaves the same as `getEnvVars` but doesn't require an `account_id` as input."
},
{
"info": {
"name": "getEnvVar",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.netlify.com/api/v1/accounts/:account_id/env/:key",
"params": [
{
"name": "account_id",
"value": "",
"type": "path",
"description": "Scope response to account_id"
},
{
"name": "key",
"value": "",
"type": "path",
"description": "The environment variable key (case-sensitive)"
},
{
"name": "site_id",
"value": "",
"type": "query",
"description": "If provided, return the environment variable for a specific site (no merging is performed)"
}
]
},
"docs": "Returns an individual environment variable. To use this endpoint, your site must no longer be using the classic environment variables experience. Migrate now with the Netlify UI."
},
{
"info": {
"name": "updateEnvVar",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.netlify.com/api/v1/accounts/:account_id/env/:key",
"params": [
{
"name": "account_id",
"value": "",
"type": "path",
"description": "Scope response to account_id"
},
{
"name": "key",
"value": "",
"type": "path",
"description": "The existing environment variable key name (case-sensitive)"
},
{
"name": "site_id",
"value": "",
"type": "query",
"description": "If provided, update an environment variable set on this site"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates an existing environment variable and all of its values. Existing values will be replaced by values provided. To use this endpoint, your site must no longer be using the classic environment variables experience. Migrate now with the Netlify UI."
},
{
"info": {
"name": "setEnvVarValue",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.netlify.com/api/v1/accounts/:account_id/env/:key",
"params": [
{
"name": "account_id",
"value": "",
"type": "path",
"description": "Scope response to account_id"
},
{
"name": "key",
"value": "",
"type": "path",
"description": "The existing environment variable key name (case-sensitive)"
},
{
"name": "site_id",
"value": "",
"type": "query",
"description": "If provided, update an environment variable set on this site"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates or creates a new value for an existing environment variable. To use this endpoint, your site must no longer be using the classic environment variables experience. Migrate now with the Netlify UI."
},
{
"info": {
"name": "deleteEnvVar",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.netlify.com/api/v1/accounts/:account_id/env/:key",
"params": [
{
"name": "account_id",
"value": "",
"type": "path",
"description": "Scope response to account_id"
},
{
"name": "key",
"value": "",
"type": "path",
"description": "The environment variable key (case-sensitive)"
},
{
"name": "site_id",
"value": "",
"type": "query",
"description": "If provided, delete the environment variable from this site"
}
]
},
"docs": "Deletes an environment variable. To use this endpoint, your site must no longer be using the classic environment variables experience. Migrate now with the Netlify UI."
},
{
"info": {
"name": "deleteEnvVarValue",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.netlify.com/api/v1/accounts/:account_id/env/:key/value/:id",
"params": [
{
"name": "account_id",
"value": "",
"type": "path",
"description": "Scope response to account_id"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The environment variable value's ID"
},
{
"name": "key",
"value": "",
"type": "path",
"description": "The environment variable key name (case-sensitive)"
},
{
"name": "site_id",
"value": "",
"type": "query",
"description": "If provided, delete the value from an environment variable on this site"
}
]
},
"docs": "Deletes a specific environment variable value. To use this endpoint, your site must no longer be using the classic environment variables experience. Migrate now with the Netlify UI."
}
]
}
],
"bundled": true
}