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
}
}
}
}
}
},
"/sites/{site_id}/assets/{asset_id}": {
"parameters": [
{
"name": "site_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "asset_id",
"type": "string",
"in": "path",
"required": true
}
],
"get": {
"operationId": "getSiteAssetInfo",
"tags": [
"asset"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"site_id": {
"type": "string"
},
"creator_id": {
"type": "string"
},
"name": {
"type": "string"
},
"state": {
"type": "string"
},
"content_type": {
"type": "string"
},
"url": {
"type": "string"
},
"key": {
"type": "string"
},
"visibility": {
"type": "string"
},
"size": {
"type": "integer",
"format": "int64"
},
"created_at": {
"type": "string",
"format": "dateTime"
},
"updated_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
}
}
}
}
}
},
"put": {
"operationId": "updateSiteAsset",
"tags": [
"asset"
],
"parameters": [
{
"name": "state",
"type": "string",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "Updated",
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"site_id": {
"type": "string"
},
"creator_id": {
"type": "string"
},
"name": {
"type": "string"
},
"state": {
"type": "string"
},
"content_type": {
"type": "string"
},
"url": {
"type": "string"
},
"key": {
"type": "string"
},
"visibility": {
"type": "string"
},
"size": {
"type": "integer",
"format": "int64"
},
"created_at": {
"type": "string",
"format": "dateTime"
},
"updated_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
}
}
}
}
}
},
"delete": {
"operationId": "deleteSiteAsset",
"tags": [
"asset"
],
"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}/assets/{asset_id}/public_signature": {
"parameters": [
{
"name": "site_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "asset_id",
"type": "string",
"in": "path",
"required": true
}
],
"get": {
"operationId": "getSiteAssetPublicSignature",
"tags": [
"assetPublicSignature"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"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}/files/{file_path}": {
"get": {
"operationId": "getSiteFileByPathName",
"tags": [
"file"
],
"parameters": [
{
"name": "site_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "file_path",
"type": "string",
"in": "path",
"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
}
}
}
}
}
}
},
"/purge": {
"post": {
"operationId": "purgeCache",
"description": "Purges cached content from Netlify's CDN. Supports purging by Cache-Tag.",
"tags": [
"purge"
],
"consumes": [
"application/json"
],
"parameters": [
{
"name": "payload",
"in": "body",
"schema": {
"type": "object",
"properties": {
"site_id": {
"type": "string"
},
"site_slug": {
"type": "string"
},
"cache_tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"required": true
}
],
"responses": {
"202": {
"description": "OK"
},
"400": {
"description": "Invalid request parameters"
},
"404": {
"description": "Site not found"
}
}
}
},
"/sites/{site_id}/snippets": {
"parameters": [
{
"name": "site_id",
"type": "string",
"in": "path",
"required": true
}
],
"get": {
"operationId": "listSiteSnippets",
"tags": [
"snippet"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"site_id": {
"type": "string"
},
"title": {
"type": "string"
},
"general": {
"type": "string"
},
"general_position": {
"type": "string"
},
"goal": {
"type": "string"
},
"goal_position": {
"type": "string"
}
}
}
}
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
},
"post": {
"operationId": "createSiteSnippet",
"tags": [
"snippet"
],
"consumes": [
"application/json"
],
"parameters": [
{
"name": "snippet",
"in": "body",
"schema": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"site_id": {
"type": "string"
},
"title": {
"type": "string"
},
"general": {
"type": "string"
},
"general_position": {
"type": "string"
},
"goal": {
"type": "string"
},
"goal_position": {
"type": "string"
}
}
},
"required": true
}
],
"responses": {
"201": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"site_id": {
"type": "string"
},
"title": {
"type": "string"
},
"general": {
"type": "string"
},
"general_position": {
"type": "string"
},
"goal": {
"type": "string"
},
"goal_position": {
"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}/snippets/{snippet_id}": {
"parameters": [
{
"name": "site_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "snippet_id",
"type": "string",
"in": "path",
"required": true
}
],
"get": {
"operationId": "getSiteSnippet",
"tags": [
"snippet"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"site_id": {
"type": "string"
},
"title": {
"type": "string"
},
"general": {
"type": "string"
},
"general_position": {
"type": "string"
},
"goal": {
"type": "string"
},
"goal_position": {
"type": "string"
}
}
}
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
},
"put": {
"operationId": "updateSiteSnippet",
"tags": [
"snippet"
],
"consumes": [
"application/json"
],
"parameters": [
{
"name": "snippet",
"in": "body",
"schema": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"site_id": {
"type": "string"
},
"title": {
"type": "string"
},
"general": {
"type": "string"
},
"general_position": {
"type": "string"
},
"goal": {
"type": "string"
},
"goal_position": {
"type": "string"
}
}
},
"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
}
}
}
}
}
},
"delete": {
"operationId": "deleteSiteSnippet",
"tags": [
"snippet"
],
"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
}
}
}
}
}
}
},
"/sites/{site_id}/metadata": {
"parameters": [
{
"name": "site_id",
"type": "string",
"in": "path",
"required": true
}
],
"get": {
"operationId": "getSiteMetadata",
"tags": [
"metadata"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
},
"put": {
"operationId": "updateSiteMetadata",
"tags": [
"metadata"
],
"parameters": [
{
"name": "metadata",
"in": "body",
"schema": {
"type": "object"
},
"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
}
}
}
}
}
}
},
"/sites/{site_id}/build_hooks": {
"parameters": [
{
"name": "site_id",
"type": "string",
"in": "path",
"required": true
}
],
"get": {
"operationId": "listSiteBuildHooks",
"tags": [
"buildHook"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"branch": {
"type": "string"
},
"url": {
"type": "string"
},
"site_id": {
"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
}
}
}
}
}
},
"post": {
"operationId": "createSiteBuildHook",
"tags": [
"buildHook"
],
"consumes": [
"application/json"
],
"parameters": [
{
"name": "buildHook",
"in": "body",
"schema": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"branch": {
"type": "string"
}
}
},
"required": true
}
],
"responses": {
"201": {
"description": "Created",
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"branch": {
"type": "string"
},
"url": {
"type": "string"
},
"site_id": {
"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
}
}
}
}
}
}
},
"/sites/{site_id}/build_hooks/{id}": {
"parameters": [
{
"name": "site_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"get": {
"operationId": "getSiteBuildHook",
"tags": [
"buildHook"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"branch": {
"type": "string"
},
"url": {
"type": "string"
},
"site_id": {
"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
}
}
}
}
}
},
"put": {
"operationId": "updateSiteBuildHook",
"tags": [
"buildHook"
],
"consumes": [
"application/json"
],
"parameters": [
{
"name": "buildHook",
"in": "body",
"schema": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"branch": {
"type": "string"
}
}
},
"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
}
}
}
}
}
},
"delete": {
"operationId": "deleteSiteBuildHook",
"tags": [
"buildHook"
],
"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
}
}
}
}
}
}
},
"/sites/{site_id}/deploys": {
"parameters": [
{
"name": "site_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "deploy-previews",
"type": "boolean",
"in": "query"
},
{
"name": "production",
"type": "boolean",
"in": "query"
},
{
"name": "state",
"type": "string",
"enum": [
"new",
"pending_review",
"accepted",
"rejected",
"enqueued",
"building",
"uploading",
"uploaded",
"preparing",
"prepared",
"processing",
"processed",
"ready",
"error",
"retrying"
],
"in": "query"
},
{
"name": "branch",
"type": "string",
"in": "query"
},
{
"name": "latest-published",
"type": "boolean",
"in": "query"
}
],
"get": {
"operationId": "listSiteDeploys",
"tags": [
"deploy"
],
"parameters": [
{
"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"
},
"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
}
}
}
}
}
},
"post": {
"operationId": "createSiteDeploy",
"tags": [
"deploy"
],
"parameters": [
{
"name": "title",
"type": "string",
"in": "query"
},
{
"name": "deploy",
"in": "body",
"schema": {
"type": "object",
"description": "Deploy files can be provided in two ways:\n1. As a JSON object using 'files' (a hash mapping file paths to SHA1 digests), OR\n2. As a zip file using one of these methods:\n - Set Content-Type to 'application/zip' and send the zip file as the raw request body\n - Include the zip file content in the 'zip' field of this JSON object with Content-Type 'application/json'\n",
"properties": {
"files": {
"type": "object",
"description": "A hash mapping file paths to SHA1 digests of the file contents."
},
"zip": {
"type": "string",
"format": "binary",
"description": "A zip file containing the site files to deploy. Alternative to 'files'.\nTo use this field, set Content-Type to 'application/json' and include the zip content here.\nAlternatively, you can set Content-Type to 'application/zip' and send the zip as the raw request body (not as JSON).\n"
},
"draft": {
"type": "boolean"
},
"async": {
"type": "boolean"
},
"functions": {
"type": "object"
},
"edge_functions": {
"type": "object",
"description": "A hash mapping edge-function bundle formats to the code_sha of each bundle. The\nresponse's required_edge_functions lists which of these still need to be uploaded.\n"
},
"server": {
"type": "object",
"description": "The deploy's Netlify Server. A deploy has at most one. The response's\nrequired_server says whether it still needs to be uploaded.\n",
"required": [
"sha"
],
"properties": {
"sha": {
"type": "string",
"description": "The SHA256 digest of the server bundle."
},
"region": {
"type": "string",
"description": "Where the server runs. Defaults to the region configured at the site level\nwhen absent.\n"
}
}
},
"function_schedules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"cron": {
"type": "string"
}
}
}
},
"functions_config": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"display_name": {
"type": "string"
},
"generator": {
"type": "string"
},
"build_data": {
"type": "object"
},
"memory": {
"type": "integer",
"description": "The function's memory allocation in MB. Mutually exclusive with `vcpu`.\n"
},
"routes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"pattern": {
"type": "string"
},
"literal": {
"type": "string"
},
"expression": {
"type": "string"
},
"methods": {
"type": "array",
"items": {
"type": "string",
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS"
]
}
},
"prefer_static": {
"type": "boolean"
}
}
}
},
"excluded_routes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"pattern": {
"type": "string"
},
"literal": {
"type": "string"
},
"expression": {
"type": "string"
}
}
}
},
"priority": {
"type": "integer"
},
"region": {
"type": "string"
},
"traffic_rules": {
"type": "object",
"properties": {
"action": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"config": {
"type": "object",
"properties": {
"to": {
"type": "string"
},
"rate_limit_config": {
"type": "object",