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
}
}
}
}
}
}
},
"/deploys/{deploy_id}/lock": {
"post": {
"operationId": "lockDeploy",
"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
}
}
}
}
}
}
},
"/deploys/{deploy_id}/unlock": {
"post": {
"operationId": "unlockDeploy",
"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
}
}
}
}
}
}
},
"/deploys/{deploy_id}/files/{path}": {
"put": {
"operationId": "uploadDeployFile",
"tags": [
"file"
],
"consumes": [
"application/octet-stream"
],
"parameters": [
{
"name": "deploy_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "path",
"type": "string",
"in": "path",
"required": true
},
{
"name": "size",
"type": "integer",
"in": "query"
},
{
"name": "file_body",
"in": "body",
"schema": {
"type": "string",
"format": "binary"
},
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"path": {
"type": "string"
},
"sha": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"size": {
"type": "integer",
"format": "int64"
}
}
}
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
}
},
"/deploys/{deploy_id}/functions/{name}": {
"put": {
"operationId": "uploadDeployFunction",
"tags": [
"function"
],
"consumes": [
"application/octet-stream"
],
"parameters": [
{
"name": "deploy_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "name",
"type": "string",
"in": "path",
"required": true
},
{
"name": "runtime",
"type": "string",
"in": "query"
},
{
"name": "invocation_mode",
"in": "query",
"type": "string"
},
{
"name": "timeout",
"in": "query",
"type": "integer"
},
{
"name": "size",
"type": "integer",
"in": "query"
},
{
"name": "file_body",
"in": "body",
"schema": {
"type": "string",
"format": "binary"
},
"required": true
},
{
"name": "X-Nf-Retry-Count",
"type": "integer",
"in": "header"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"sha": {
"type": "string"
},
"region": {
"type": "string"
}
}
}
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
}
},
"/deploys/{deploy_id}/server/{code_sha}": {
"put": {
"operationId": "uploadDeployServer",
"tags": [
"deploy"
],
"consumes": [
"application/octet-stream"
],
"description": "Uploads the deploy's Netlify Server bundle, addressed by the digest the deploy\ndeclared in its `server` property.\n",
"parameters": [
{
"name": "deploy_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "code_sha",
"type": "string",
"in": "path",
"required": true
},
{
"name": "size",
"type": "integer",
"in": "query"
},
{
"name": "file_body",
"in": "body",
"schema": {
"type": "string",
"format": "binary"
},
"required": true
},
{
"name": "X-Nf-Retry-Count",
"type": "integer",
"in": "header"
}
],
"responses": {
"200": {
"description": "OK"
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
}
},
"/deploys/{deploy_id}/edge_functions/{code_sha}": {
"put": {
"operationId": "uploadDeployEdgeFunction",
"tags": [
"edgeFunction"
],
"consumes": [
"application/octet-stream"
],
"parameters": [
{
"name": "deploy_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "code_sha",
"type": "string",
"in": "path",
"required": true
},
{
"name": "file_body",
"in": "body",
"schema": {
"type": "string",
"format": "binary"
},
"required": true
},
{
"name": "X-Nf-Retry-Count",
"type": "integer",
"in": "header"
}
],
"responses": {
"200": {
"description": "OK"
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
}
},
"/sites/{site_id}/plugins/{package}": {
"put": {
"x-internal": true,
"operationId": "updatePlugin",
"tags": [
"x-internal"
],
"description": "This is an internal-only endpoint.",
"parameters": [
{
"name": "site_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "package",
"type": "string",
"in": "path",
"required": true
},
{
"name": "plugin_params",
"in": "body",
"schema": {
"type": "object",
"properties": {
"pinned_version": {
"type": "string"
}
}
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"package": {
"type": "string"
},
"pinned_version": {
"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}/plugin_runs/latest": {
"get": {
"x-internal": true,
"operationId": "getLatestPluginRuns",
"tags": [
"x-internal"
],
"description": "This is an internal-only endpoint.",
"parameters": [
{
"name": "site_id",
"in": "path",
"type": "string",
"required": true
},
{
"name": "packages",
"in": "query",
"type": "array",
"items": {
"type": "string"
},
"required": true
},
{
"name": "state",
"in": "query",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"package": {
"type": "string"
},
"version": {
"type": "string"
},
"state": {
"type": "string"
},
"reporting_event": {
"type": "string"
},
"title": {
"type": "string"
},
"summary": {
"type": "string"
},
"text": {
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"deploy_id": {
"type": "string"
}
}
}
]
}
}
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
}
},
"/deploys/{deploy_id}/plugin_runs": {
"post": {
"x-internal": true,
"operationId": "createPluginRun",
"tags": [
"x-internal"
],
"description": "This is an internal-only endpoint.",
"parameters": [
{
"name": "deploy_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "plugin_run",
"in": "body",
"schema": {
"type": "object",
"properties": {
"package": {
"type": "string"
},
"version": {
"type": "string"
},
"state": {
"type": "string"
},
"reporting_event": {
"type": "string"
},
"title": {
"type": "string"
},
"summary": {
"type": "string"
},
"text": {
"type": "string"
}
}
}
}
],
"responses": {
"201": {
"description": "CREATED",
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"package": {
"type": "string"
},
"version": {
"type": "string"
},
"state": {
"type": "string"
},
"reporting_event": {
"type": "string"
},
"title": {
"type": "string"
},
"summary": {
"type": "string"
},
"text": {
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"deploy_id": {
"type": "string"
}
}
}
]
}
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
}
},
"/forms/{form_id}/submissions": {
"get": {
"operationId": "listFormSubmissions",
"tags": [
"submission"
],
"parameters": [
{
"name": "form_id",
"type": "string",
"in": "path",
"required": true
},
{
"type": "integer",
"format": "int32",
"name": "page",
"required": false,
"in": "query"
},
{
"type": "integer",
"format": "int32",
"name": "per_page",
"required": false,
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"number": {
"type": "integer",
"format": "int32"
},
"email": {
"type": "string"
},
"name": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"company": {
"type": "string"
},
"summary": {
"type": "string"
},
"body": {
"type": "string"
},
"data": {
"type": "object"
},
"created_at": {
"type": "string",
"format": "dateTime"
},
"site_url": {
"type": "string"
}
}
}
}
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
}
},
"/hooks": {
"get": {
"operationId": "listHooksBySiteId",
"tags": [
"hook"
],
"parameters": [
{
"name": "site_id",
"in": "query",
"type": "string",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"site_id": {
"type": "string"
},
"type": {
"type": "string"
},
"event": {
"type": "string"
},
"data": {
"type": "object"
},
"created_at": {
"type": "string",
"format": "dateTime"
},
"updated_at": {
"type": "string",
"format": "dateTime"
},
"disabled": {
"type": "boolean"
}
}
}
}
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
},
"post": {
"operationId": "createHookBySiteId",
"tags": [
"hook"
],
"consumes": [
"application/json"
],
"parameters": [
{
"name": "site_id",
"type": "string",
"in": "query",
"required": true
},
{
"name": "hook",
"in": "body",
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"site_id": {
"type": "string"
},
"type": {
"type": "string"
},
"event": {
"type": "string"
},
"data": {
"type": "object"
},
"created_at": {
"type": "string",
"format": "dateTime"
},
"updated_at": {
"type": "string",
"format": "dateTime"
},
"disabled": {
"type": "boolean"
}
}
},
"required": true
}
],
"responses": {
"201": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"site_id": {
"type": "string"
},
"type": {
"type": "string"
},
"event": {
"type": "string"
},
"data": {
"type": "object"
},
"created_at": {
"type": "string",
"format": "dateTime"
},
"updated_at": {
"type": "string",
"format": "dateTime"
},
"disabled": {
"type": "boolean"
}
}
}
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
}
},
"/hooks/{hook_id}": {
"parameters": [
{
"name": "hook_id",
"type": "string",
"in": "path",
"required": true
}
],
"get": {
"operationId": "getHook",
"tags": [
"hook"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"site_id": {
"type": "string"
},
"type": {
"type": "string"
},
"event": {
"type": "string"
},
"data": {
"type": "object"
},
"created_at": {
"type": "string",
"format": "dateTime"
},
"updated_at": {
"type": "string",
"format": "dateTime"
},
"disabled": {
"type": "boolean"
}
}
}
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
},
"put": {
"operationId": "updateHook",
"tags": [
"hook"
],
"parameters": [
{
"name": "hook",
"in": "body",
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"site_id": {
"type": "string"
},
"type": {
"type": "string"
},
"event": {
"type": "string"
},
"data": {
"type": "object"
},
"created_at": {
"type": "string",
"format": "dateTime"
},
"updated_at": {
"type": "string",
"format": "dateTime"
},
"disabled": {
"type": "boolean"
}
}
},
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"site_id": {
"type": "string"
},
"type": {
"type": "string"
},
"event": {
"type": "string"
},
"data": {
"type": "object"
},
"created_at": {
"type": "string",
"format": "dateTime"
},
"updated_at": {
"type": "string",
"format": "dateTime"
},
"disabled": {
"type": "boolean"
}
}
}
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
},
"delete": {
"operationId": "deleteHook",
"tags": [
"hook"
],
"responses": {
"204": {
"description": "No content"
}
}
}
},
"/hooks/{hook_id}/enable": {
"parameters": [
{
"name": "hook_id",
"type": "string",
"in": "path",
"required": true
}
],
"post": {
"operationId": "enableHook",
"tags": [
"hook"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"site_id": {
"type": "string"
},
"type": {
"type": "string"
},
"event": {
"type": "string"
},
"data": {
"type": "object"
},
"created_at": {
"type": "string",
"format": "dateTime"
},
"updated_at": {
"type": "string",
"format": "dateTime"
},
"disabled": {
"type": "boolean"
}
}
}
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [