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
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"deploy_id": {
"type": "string"
},
"sha": {
"type": "string"
},
"done": {
"type": "boolean"
},
"error": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "dateTime"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
}
},
"/sites/{site_id}/deployed-branches": {
"parameters": [
{
"name": "site_id",
"type": "string",
"in": "path",
"required": true
}
],
"get": {
"operationId": "listSiteDeployedBranches",
"tags": [
"deployedBranch"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"deploy_id": {
"type": "string"
},
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"url": {
"type": "string"
},
"ssl_url": {
"type": "string"
}
}
}
}
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
}
},
"/sites/{site_id}/unlink_repo": {
"parameters": [
{
"name": "site_id",
"type": "string",
"in": "path",
"required": true
}
],
"put": {
"operationId": "unlinkSiteRepo",
"tags": [
"site"
],
"description": "[Beta] Unlinks the repo from the site.\n\nThis action will also:\n- Delete associated deploy keys\n- Delete outgoing webhooks for the repo\n- Delete the site's build hooks",
"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
}
}
}
},
"404": {
"description": "Site not found"
}
}
}
},
"/sites/{site_id}/enable": {
"parameters": [
{
"name": "site_id",
"type": "string",
"in": "path",
"required": true
}
],
"put": {
"operationId": "enableSite",
"tags": [
"site"
],
"description": "Re-enables a site that was previously disabled by the user. Sites that were disabled for usage exceeded or marked as spam cannot be re-enabled via this endpoint.",
"responses": {
"204": {
"description": "No content"
},
"422": {
"description": "Cannot enable this site",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
}
},
"/sites/{site_id}/disable": {
"parameters": [
{
"name": "site_id",
"type": "string",
"in": "path",
"required": true
}
],
"put": {
"operationId": "disableSite",
"tags": [
"site"
],
"description": "Disables a site, preventing it from serving content. The site can be re-enabled later using the enable endpoint.",
"parameters": [
{
"name": "reason",
"type": "string",
"in": "query",
"required": true,
"description": "Reason for disabling the site"
}
],
"responses": {
"204": {
"description": "No content"
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
}
},
"/builds/{build_id}": {
"parameters": [
{
"name": "build_id",
"type": "string",
"in": "path",
"required": true
}
],
"get": {
"operationId": "getSiteBuild",
"tags": [
"build"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"deploy_id": {
"type": "string"
},
"sha": {
"type": "string"
},
"done": {
"type": "boolean"
},
"error": {
"type": "string"
},
"created_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
}
}
}
}
}
}
},
"/builds/{build_id}/log": {
"parameters": [
{
"name": "build_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "msg",
"in": "body",
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"error": {
"type": "boolean"
},
"section": {
"type": "string",
"enum": [
"initializing",
"building",
"deploying",
"cleanup",
"postprocessing"
]
}
}
},
"required": true
}
],
"post": {
"operationId": "updateSiteBuildLog",
"tags": [
"buildLogMsg"
],
"responses": {
"204": {
"description": "No content"
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
}
},
"/builds/{build_id}/start": {
"parameters": [
{
"name": "build_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "buildbot_version",
"type": "string",
"in": "query",
"required": false
},
{
"name": "build_version",
"type": "string",
"in": "query",
"required": false
},
{
"name": "task_id",
"type": "string",
"in": "query",
"required": false
}
],
"post": {
"operationId": "notifyBuildStart",
"tags": [
"build"
],
"responses": {
"204": {
"description": "No content"
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
}
},
"/{account_id}/builds/status": {
"parameters": [
{
"name": "account_id",
"type": "string",
"in": "path",
"required": true
}
],
"get": {
"operationId": "getAccountBuildStatus",
"tags": [
"build"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"active": {
"type": "integer"
},
"pending_concurrency": {
"type": "integer"
},
"enqueued": {
"type": "integer"
},
"build_count": {
"type": "integer"
},
"minutes": {
"type": "object",
"properties": {
"current": {
"type": "integer"
},
"current_average_sec": {
"type": "integer"
},
"previous": {
"type": "integer"
},
"period_start_date": {
"type": "string",
"format": "dateTime"
},
"period_end_date": {
"type": "string",
"format": "dateTime"
},
"last_updated_at": {
"type": "string",
"format": "dateTime"
},
"included_minutes": {
"type": "string"
},
"included_minutes_with_packs": {
"type": "string"
}
}
}
}
}
}
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
}
},
"/sites/{site_id}/dns": {
"parameters": [
{
"name": "site_id",
"type": "string",
"in": "path",
"required": true
}
],
"get": {
"operationId": "getDNSForSite",
"tags": [
"dnsZone"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"errors": {
"type": "array",
"items": {
"type": "string"
}
},
"supported_record_types": {
"type": "array",
"items": {
"type": "string"
}
},
"user_id": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "dateTime"
},
"updated_at": {
"type": "string",
"format": "dateTime"
},
"records": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"hostname": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": "integer",
"format": "int64"
},
"priority": {
"type": "integer",
"format": "int64"
},
"dns_zone_id": {
"type": "string"
},
"site_id": {
"type": "string"
},
"flag": {
"type": "integer"
},
"tag": {
"type": "string"
},
"managed": {
"type": "boolean"
}
}
}
},
"dns_servers": {
"type": "array",
"items": {
"type": "string"
}
},
"account_id": {
"type": "string"
},
"site_id": {
"type": "string"
},
"account_slug": {
"type": "string"
},
"account_name": {
"type": "string"
},
"domain": {
"type": "string"
},
"ipv6_enabled": {
"type": "boolean"
},
"dedicated": {
"type": "boolean"
}
}
}
}
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
},
"put": {
"operationId": "configureDNSForSite",
"tags": [
"dnsZone"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"errors": {
"type": "array",
"items": {
"type": "string"
}
},
"supported_record_types": {
"type": "array",
"items": {
"type": "string"
}
},
"user_id": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "dateTime"
},
"updated_at": {
"type": "string",
"format": "dateTime"
},
"records": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"hostname": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": "integer",
"format": "int64"
},
"priority": {
"type": "integer",
"format": "int64"
},
"dns_zone_id": {
"type": "string"
},
"site_id": {
"type": "string"
},
"flag": {
"type": "integer"
},
"tag": {
"type": "string"
},
"managed": {
"type": "boolean"
}
}
}
},
"dns_servers": {
"type": "array",
"items": {
"type": "string"
}
},
"account_id": {
"type": "string"
},
"site_id": {
"type": "string"
},
"account_slug": {
"type": "string"
},
"account_name": {
"type": "string"
},
"domain": {
"type": "string"
},
"ipv6_enabled": {
"type": "boolean"
},
"dedicated": {
"type": "boolean"
}
}
}
}
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
}
},
"/sites/{site_id}/rollback": {
"parameters": [
{
"name": "site_id",
"type": "string",
"in": "path",
"required": true
}
],
"put": {
"operationId": "rollbackSiteDeploy",
"tags": [
"deploy"
],
"responses": {
"204": {
"description": "No content"
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
}
},
"/deploys/{deploy_id}": {
"get": {
"operationId": "getDeploy",
"tags": [
"deploy"
],
"parameters": [
{
"name": "deploy_id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"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"
}
}
}
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
},
"delete": {
"operationId": "deleteDeploy",
"tags": [
"deploy"
],
"parameters": [
{
"name": "deploy_id",
"type": "string",
"in": "path",
"required": true
}
],
"responses": {
"204": {
"description": "No content"
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
}
},
"/deploys/{deploy_id}/validations_report": {
"patch": {
"operationId": "updateDeployValidations",
"tags": [
"deploy"
],
"description": "Updates the deploy validations report for a deploy.",
"x-internal": true,
"x-controller": "api/v1/deploys",
"x-action": "validations_report",
"parameters": [
{
"name": "deploy_id",
"description": "The ID of the deploy",
"type": "string",
"in": "path",
"required": true
},
{
"name": "report",
"in": "body",
"required": true,
"schema": {
"type": "object",
"properties": {
"secrets_scan": {
"type": "object"
}
}
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The id of the deploy validations report"
},
"deploy_id": {
"type": "string",
"description": "The id of the deploy"
},
"secret_scan_result": {
"type": "object",
"properties": {
"scannedFilesCount": {
"type": "integer",
"description": "The number of files scanned"
},
"secretsScanMatches": {
"type": "array",
"items": {
"type": "string"
},
"description": "The list of secrets scan matches"
}
}