A continuation of netlify_openapi_swagger.json. The complete source identity, every recorded occurrence, and linked equations are on its first page.
Source transcript · continued
Download complete source text ↓24,715 lines · 705.9 KB
}
}
},
"functions_region": {
"type": "string",
"description": "The functions region for this deploy as an airport code.\n"
},
"functions_region_overrides": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"region": {
"type": "string"
}
}
},
"description": "Functions in the deploy that explicitly specify their own region\n(airport code).\n"
}
}
},
"account_id": {
"type": "string"
},
"account_name": {
"type": "string"
},
"account_slug": {
"type": "string"
},
"git_provider": {
"type": "string"
},
"deploy_hook": {
"type": "string"
},
"capabilities": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"processing_settings": {
"type": "object",
"properties": {
"html": {
"type": "object",
"properties": {
"pretty_urls": {
"type": "boolean"
}
}
}
}
},
"build_settings": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"provider": {
"type": "string"
},
"deploy_key_id": {
"type": "string"
},
"repo_path": {
"type": "string"
},
"repo_branch": {
"type": "string"
},
"dir": {
"type": "string"
},
"functions_dir": {
"type": "string",
"description": "The directory where Netlify can find your compiled functions to deploy them. Defaults to netlify/functions if not set. You can also define and override this setting in your project’s netlify.toml file."
},
"cmd": {
"type": "string",
"description": "The build command to run. This is the command that Netlify runs to build your site. If a site has a netlify.toml file with a build command it will override this value."
},
"allowed_branches": {
"type": "array",
"items": {
"type": "string"
}
},
"public_repo": {
"type": "boolean"
},
"private_logs": {
"type": "boolean"
},
"repo_url": {
"type": "string"
},
"env": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"installation_id": {
"type": "integer"
},
"stop_builds": {
"type": "boolean",
"description": "When true, Netlify will not build your project automatically. You can build locally via the CLI and then publish new deploys manually via the CLI or the API."
}
}
},
"id_domain": {
"type": "string"
},
"default_hooks_data": {
"type": "object",
"properties": {
"access_token": {
"type": "string"
}
}
},
"build_image": {
"type": "string"
},
"prerender": {
"type": "string"
},
"functions_region": {
"type": "string"
},
"prevent_non_git_prod_deploys": {
"type": "boolean",
"default": false
}
}
}
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
},
"description": "**Note:** Environment variable keys and values have moved from `build_settings.env` and `repo.env` to a new endpoint. Please use [getEnvVars](#tag/environmentVariables/operation/getEnvVars) to retrieve site environment variables."
},
"patch": {
"operationId": "updateSite",
"tags": [
"site"
],
"consumes": [
"application/json"
],
"parameters": [
{
"name": "site",
"in": "body",
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"state": {
"type": "string"
},
"plan": {
"type": "string"
},
"name": {
"type": "string"
},
"custom_domain": {
"type": "string"
},
"domain_aliases": {
"type": "array",
"items": {
"type": "string"
}
},
"branch_deploy_custom_domain": {
"type": "string"
},
"deploy_preview_custom_domain": {
"type": "string"
},
"password": {
"type": "string"
},
"notification_email": {
"type": "string"
},
"url": {
"type": "string"
},
"ssl_url": {
"type": "string"
},
"admin_url": {
"type": "string"
},
"screenshot_url": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "dateTime"
},
"updated_at": {
"type": "string",
"format": "dateTime"
},
"user_id": {
"type": "string"
},
"session_id": {
"type": "string"
},
"ssl": {
"type": "boolean"
},
"force_ssl": {
"type": "boolean"
},
"managed_dns": {
"type": "boolean"
},
"deploy_url": {
"type": "string"
},
"published_deploy": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"site_id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"build_id": {
"type": "string"
},
"state": {
"type": "string"
},
"name": {
"type": "string"
},
"url": {
"type": "string"
},
"ssl_url": {
"type": "string"
},
"admin_url": {
"type": "string"
},
"deploy_url": {
"type": "string"
},
"deploy_ssl_url": {
"type": "string"
},
"screenshot_url": {
"type": "string"
},
"review_id": {
"type": "number"
},
"draft": {
"type": "boolean"
},
"required": {
"type": "array",
"items": {
"type": "string"
}
},
"required_functions": {
"type": "array",
"items": {
"type": "string"
}
},
"required_edge_functions": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of code_shas for the edge-function bundles that need to be uploaded to\ncomplete the deploy.\n"
},
"required_server": {
"type": "array",
"items": {
"type": "string"
},
"description": "The SHA256 digest of the deploy's Netlify Server bundle, when it still needs to\nbe uploaded to complete the deploy. A deploy has at most one server, so this\nholds either nothing or a single digest.\n"
},
"error_message": {
"type": "string"
},
"branch": {
"type": "string"
},
"commit_ref": {
"type": "string"
},
"commit_url": {
"type": "string"
},
"skipped": {
"type": "boolean"
},
"created_at": {
"type": "string",
"format": "dateTime"
},
"updated_at": {
"type": "string",
"format": "dateTime"
},
"published_at": {
"type": "string",
"format": "dateTime"
},
"title": {
"type": "string"
},
"context": {
"type": "string"
},
"locked": {
"type": "boolean"
},
"review_url": {
"type": "string"
},
"framework": {
"type": "string"
},
"skew_protection_token": {
"type": "string"
},
"function_schedules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"cron": {
"type": "string"
}
}
}
},
"functions_region": {
"type": "string",
"description": "The functions region for this deploy as an airport code.\n"
},
"functions_region_overrides": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"region": {
"type": "string"
}
}
},
"description": "Functions in the deploy that explicitly specify their own region\n(airport code).\n"
}
}
},
"account_id": {
"type": "string"
},
"account_name": {
"type": "string"
},
"account_slug": {
"type": "string"
},
"git_provider": {
"type": "string"
},
"deploy_hook": {
"type": "string"
},
"capabilities": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"processing_settings": {
"type": "object",
"properties": {
"html": {
"type": "object",
"properties": {
"pretty_urls": {
"type": "boolean"
}
}
}
}
},
"build_settings": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"provider": {
"type": "string"
},
"deploy_key_id": {
"type": "string"
},
"repo_path": {
"type": "string"
},
"repo_branch": {
"type": "string"
},
"dir": {
"type": "string"
},
"functions_dir": {
"type": "string",
"description": "The directory where Netlify can find your compiled functions to deploy them. Defaults to netlify/functions if not set. You can also define and override this setting in your project’s netlify.toml file."
},
"cmd": {
"type": "string",
"description": "The build command to run. This is the command that Netlify runs to build your site. If a site has a netlify.toml file with a build command it will override this value."
},
"allowed_branches": {
"type": "array",
"items": {
"type": "string"
}
},
"public_repo": {
"type": "boolean"
},
"private_logs": {
"type": "boolean"
},
"repo_url": {
"type": "string"
},
"env": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"installation_id": {
"type": "integer"
},
"stop_builds": {
"type": "boolean",
"description": "When true, Netlify will not build your project automatically. You can build locally via the CLI and then publish new deploys manually via the CLI or the API."
}
}
},
"id_domain": {
"type": "string"
},
"default_hooks_data": {
"type": "object",
"properties": {
"access_token": {
"type": "string"
}
}
},
"build_image": {
"type": "string"
},
"prerender": {
"type": "string"
},
"functions_region": {
"type": "string"
},
"prevent_non_git_prod_deploys": {
"type": "boolean",
"default": false
}
}
},
{
"properties": {
"repo": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"provider": {
"type": "string"
},
"deploy_key_id": {
"type": "string"
},
"repo_path": {
"type": "string"
},
"repo_branch": {
"type": "string"
},
"dir": {
"type": "string"
},
"functions_dir": {
"type": "string",
"description": "The directory where Netlify can find your compiled functions to deploy them. Defaults to netlify/functions if not set. You can also define and override this setting in your project’s netlify.toml file."
},
"cmd": {
"type": "string",
"description": "The build command to run. This is the command that Netlify runs to build your site. If a site has a netlify.toml file with a build command it will override this value."
},
"allowed_branches": {
"type": "array",
"items": {
"type": "string"
}
},
"public_repo": {
"type": "boolean"
},
"private_logs": {
"type": "boolean"
},
"repo_url": {
"type": "string"
},
"env": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"installation_id": {
"type": "integer"
},
"stop_builds": {
"type": "boolean",
"description": "When true, Netlify will not build your project automatically. You can build locally via the CLI and then publish new deploys manually via the CLI or the API."
}
}
}
}
}
]
},
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"state": {
"type": "string"
},
"plan": {
"type": "string"
},
"name": {
"type": "string"
},
"custom_domain": {
"type": "string"
},
"domain_aliases": {
"type": "array",
"items": {
"type": "string"
}
},
"branch_deploy_custom_domain": {
"type": "string"
},
"deploy_preview_custom_domain": {
"type": "string"
},
"password": {
"type": "string"
},
"notification_email": {
"type": "string"
},
"url": {
"type": "string"
},
"ssl_url": {
"type": "string"
},
"admin_url": {
"type": "string"
},
"screenshot_url": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "dateTime"
},
"updated_at": {
"type": "string",
"format": "dateTime"
},
"user_id": {
"type": "string"
},
"session_id": {
"type": "string"
},
"ssl": {
"type": "boolean"
},
"force_ssl": {
"type": "boolean"
},
"managed_dns": {
"type": "boolean"
},
"deploy_url": {
"type": "string"
},
"published_deploy": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"site_id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"build_id": {
"type": "string"
},
"state": {
"type": "string"
},
"name": {
"type": "string"
},
"url": {
"type": "string"
},
"ssl_url": {
"type": "string"
},
"admin_url": {
"type": "string"
},
"deploy_url": {
"type": "string"
},
"deploy_ssl_url": {
"type": "string"
},
"screenshot_url": {
"type": "string"
},
"review_id": {
"type": "number"
},
"draft": {
"type": "boolean"
},
"required": {
"type": "array",
"items": {
"type": "string"
}
},
"required_functions": {
"type": "array",
"items": {
"type": "string"
}
},
"required_edge_functions": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of code_shas for the edge-function bundles that need to be uploaded to\ncomplete the deploy.\n"
},
"required_server": {
"type": "array",
"items": {
"type": "string"
},
"description": "The SHA256 digest of the deploy's Netlify Server bundle, when it still needs to\nbe uploaded to complete the deploy. A deploy has at most one server, so this\nholds either nothing or a single digest.\n"
},
"error_message": {
"type": "string"
},
"branch": {
"type": "string"
},
"commit_ref": {
"type": "string"
},
"commit_url": {
"type": "string"
},
"skipped": {
"type": "boolean"
},
"created_at": {
"type": "string",
"format": "dateTime"
},
"updated_at": {
"type": "string",
"format": "dateTime"
},
"published_at": {
"type": "string",
"format": "dateTime"
},
"title": {
"type": "string"
},
"context": {
"type": "string"
},
"locked": {
"type": "boolean"
},
"review_url": {
"type": "string"
},
"framework": {
"type": "string"
},
"skew_protection_token": {
"type": "string"
},
"function_schedules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"cron": {
"type": "string"
}
}
}
},
"functions_region": {
"type": "string",
"description": "The functions region for this deploy as an airport code.\n"
},
"functions_region_overrides": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"region": {
"type": "string"
}
}
},
"description": "Functions in the deploy that explicitly specify their own region\n(airport code).\n"
}
}
},
"account_id": {
"type": "string"
},
"account_name": {
"type": "string"
},
"account_slug": {
"type": "string"
},
"git_provider": {
"type": "string"
},
"deploy_hook": {
"type": "string"
},
"capabilities": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"processing_settings": {
"type": "object",
"properties": {
"html": {
"type": "object",
"properties": {
"pretty_urls": {
"type": "boolean"
}
}
}
}
},
"build_settings": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"provider": {
"type": "string"
},
"deploy_key_id": {
"type": "string"
},
"repo_path": {
"type": "string"
},
"repo_branch": {
"type": "string"
},
"dir": {
"type": "string"
},
"functions_dir": {
"type": "string",
"description": "The directory where Netlify can find your compiled functions to deploy them. Defaults to netlify/functions if not set. You can also define and override this setting in your project’s netlify.toml file."
},
"cmd": {
"type": "string",
"description": "The build command to run. This is the command that Netlify runs to build your site. If a site has a netlify.toml file with a build command it will override this value."
},
"allowed_branches": {
"type": "array",
"items": {
"type": "string"
}
},
"public_repo": {
"type": "boolean"
},
"private_logs": {
"type": "boolean"
},
"repo_url": {
"type": "string"
},
"env": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"installation_id": {
"type": "integer"
},
"stop_builds": {
"type": "boolean",
"description": "When true, Netlify will not build your project automatically. You can build locally via the CLI and then publish new deploys manually via the CLI or the API."
}
}
},
"id_domain": {
"type": "string"
},
"default_hooks_data": {
"type": "object",
"properties": {
"access_token": {
"type": "string"
}
}
},
"build_image": {
"type": "string"
},
"prerender": {
"type": "string"
},
"functions_region": {
"type": "string"
},
"prevent_non_git_prod_deploys": {
"type": "boolean",
"default": false
}
}
}
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
},
"description": "**Note:** Environment variable keys and values have moved from `build_settings.env` and `repo.env` to a new endpoint. Please use [updateEnvVar](#tag/environmentVariables/operation/updateEnvVar) to update a site's environment variables."
},
"delete": {
"operationId": "deleteSite",
"tags": [
"site"
],
"responses": {
"204": {
"description": "Deleted"
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
}
},
"/sites/{site_id}/ssl": {
"post": {
"operationId": "provisionSiteTLSCertificate",
"tags": [
"sniCertificate"
],
"description": "Provisions or updates a TLS certificate for the site.\n\n**Creating a certificate (site has no certificate):**\n- Omit certificate params to initiate Let's Encrypt provisioning\n- Provide certificate, key, and ca_certificates to upload a custom certificate\n\n**Updating a certificate (site already has a certificate):**\n- REQUIRES certificate, key, and ca_certificates to replace with a new custom certificate\n- Use POST /api/v1/sites/{site_id}/ssl/renew to renew an existing Let's Encrypt certificate",
"parameters": [
{
"name": "site_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "certificate",
"type": "string",
"in": "query",
"description": "PEM-encoded certificate. Required when updating an existing certificate."
},
{
"name": "key",
"type": "string",
"in": "query",
"description": "PEM-encoded private key. Required when updating an existing certificate."
},
{
"name": "ca_certificates",
"type": "string",
"in": "query",
"description": "PEM-encoded CA certificate chain. Required when updating an existing certificate."
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"state": {
"type": "string"
},
"domains": {
"type": "array",
"items": {
"type": "string"
}
},
"created_at": {
"type": "string",
"format": "dateTime"
},
"updated_at": {
"type": "string",
"format": "dateTime"
},
"expires_at": {
"type": "string",
"format": "dateTime"
}
}
}
},
"422": {
"description": "Unprocessable Entity. Returns errors such as: \"certificate parameter is required when updating an existing certificate\" (when updating without params), \"No custom domain configured\", or \"bad dns for custom domain\""
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
},
"get": {
"operationId": "showSiteTLSCertificate",
"tags": [
"sniCertificate"
],
"parameters": [
{
"name": "site_id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"state": {
"type": "string"
},
"domains": {
"type": "array",
"items": {
"type": "string"
}
},
"created_at": {
"type": "string",
"format": "dateTime"
},
"updated_at": {
"type": "string",
"format": "dateTime"
},
"expires_at": {
"type": "string",
"format": "dateTime"
}
}
}
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
}
},
"/sites/{site_id}/ssl/certificates": {
"get": {
"operationId": "getAllCertificates",
"tags": [
"sniCertificate"
],
"parameters": [
{
"name": "site_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "domain",
"type": "string",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "Array of SNI Certificates",
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"state": {
"type": "string"
},
"domains": {
"type": "array",
"items": {
"type": "string"
}
},
"created_at": {
"type": "string",
"format": "dateTime"
},
"updated_at": {
"type": "string",
"format": "dateTime"
},
"expires_at": {
"type": "string",
"format": "dateTime"
}
}
}
}
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
}
}
}
},
"/accounts/{account_id}/env": {
"get": {
"tags": [
"environmentVariables"
],
"operationId": "getEnvVars",
"parameters": [
{
"name": "account_id",
"description": "Scope response to account_id",
"type": "string",
"required": true,
"in": "path"
},
{
"name": "context_name",
"description": "Filter by deploy context",
"type": "string",
"enum": [
"all",
"dev",
"dev-server",
"branch-deploy",
"deploy-preview",
"production"
],
"required": false,
"in": "query"
},
{
"name": "scope",
"description": "Filter by scope",
"type": "string",
"enum": [
"builds",
"functions",
"runtime",
"post-processing"
],
"required": false,
"in": "query"
},
{
"name": "site_id",
"description": "If specified, only return environment variables set on this site",
"type": "string",
"required": false,
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "The environment variable key, like ALGOLIA_ID (case-sensitive)",
"x-faker": "commerce.productName"
},
"scopes": {
"type": "array",
"items": {
"type": "string",
"enum": [
"builds",
"functions",
"runtime",
"post-processing"
]
},
"description": "The scopes that this environment variable is set to"
},
"values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The environment variable value's universally unique ID",
"x-faker": "datatype.uuid"
},
"value": {
"type": "string",
"description": "The environment variable's unencrypted value",
"x-faker": "internet.password"
},
"context": {
"type": "string",
"enum": [
"all",
"dev",
"dev-server",
"branch-deploy",
"deploy-preview",
"production",
"branch"
],
"description": "The deploy context in which this value will be used. `dev` refers to local development when running `netlify dev`."
},
"context_parameter": {
"type": "string",
"description": "An additional parameter for custom branches. Currently, this is used for specifying a branch name when `context=branch`."
}
},
"description": "Environment variable value model definition"
},
"description": "An array of Value objects containing values and metadata",
"x-faker": "internet.password"
},
"is_secret": {
"type": "boolean",
"description": "Secret values are only readable by code running on Netlify's systems. With secrets, only the local development context values are readable from the UI, API, and CLI. By default, environment variable values are not secret."
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "The timestamp of when the value was last updated",
"x-faker": "date.past"
},
"updated_by": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The user's unique identifier",
"x-faker": "datatype.number"
},
"full_name": {
"type": "string",
"description": "The user's full name (first and last)",
"x-faker": "name.findName"
},
"email": {
"type": "string",
"description": "The user's email address",
"x-faker": "internet.email"
},
"avatar_url": {
"type": "string",
"description": "A URL pointing to the user's avatar",
"x-faker": "internet.avatar"
}
}
}
},
"description": "Environment variable model definition"
}
}
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
},
"description": "Returns all environment variables for an account or site. An account corresponds to a team in the Netlify UI."
},
"post": {
"tags": [
"environmentVariables"
],
"operationId": "createEnvVars",
"description": "Creates new environment variables. Granular scopes are available on Pro plans and above.",
"parameters": [
{
"in": "body",
"name": "env_vars",
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "The existing or new name of the key, if you wish to rename it (case-sensitive)"
},
"scopes": {
"description": "The scopes that this environment variable is set to (Pro plans and above)",
"type": "array",
"items": {
"type": "string",
"enum": [
"builds",
"functions",
"runtime",
"post-processing"
]
}
},
"values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The environment variable value's universally unique ID",
"x-faker": "datatype.uuid"
},
"value": {
"type": "string",
"description": "The environment variable's unencrypted value",
"x-faker": "internet.password"
},
"context": {
"type": "string",
"enum": [
"all",
"dev",
"dev-server",
"branch-deploy",
"deploy-preview",
"production",
"branch"
],
"description": "The deploy context in which this value will be used. `dev` refers to local development when running `netlify dev`."
},
"context_parameter": {
"type": "string",
"description": "An additional parameter for custom branches. Currently, this is used for specifying a branch name when `context=branch`."
}
},
"description": "Environment variable value model definition"
}
},
"is_secret": {
"type": "boolean",
"description": "Secret values are only readable by code running on Netlify's systems. With secrets, only the local development context values are readable from the UI, API, and CLI. By default, environment variable values are not secret."
}
}
}
}
},
{
"name": "account_id",
"description": "Scope response to account_id",
"type": "string",
"required": true,
"in": "path"
},
{
"name": "site_id",
"description": "If provided, create an environment variable on the site level, not the account level",
"type": "string",
"required": false,
"in": "query"
}
],
"responses": {
"201": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "The environment variable key, like ALGOLIA_ID (case-sensitive)",
"x-faker": "commerce.productName"
},
"scopes": {
"type": "array",
"items": {
"type": "string",
"enum": [
"builds",
"functions",
"runtime",
"post-processing"
]
},
"description": "The scopes that this environment variable is set to"
},