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
}
}
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
}
},
"/dns_zones/{zone_id}": {
"parameters": [
{
"name": "zone_id",
"type": "string",
"in": "path",
"required": true
}
],
"get": {
"operationId": "getDnsZone",
"tags": [
"dnsZone"
],
"responses": {
"200": {
"description": "get a single DNS zone",
"schema": {
"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
}
}
}
}
}
},
"delete": {
"operationId": "deleteDnsZone",
"tags": [
"dnsZone"
],
"responses": {
"204": {
"description": "delete a single DNS zone"
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
}
},
"/dns_zones/{zone_id}/transfer": {
"parameters": [
{
"name": "zone_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "account_id",
"type": "string",
"in": "query",
"description": "the account of the dns zone",
"required": true
},
{
"name": "transfer_account_id",
"type": "string",
"in": "query",
"description": "the account you want to transfer the dns zone to",
"required": true
},
{
"name": "transfer_user_id",
"type": "string",
"in": "query",
"description": "the user you want to transfer the dns zone to",
"required": true
}
],
"put": {
"operationId": "transferDnsZone",
"tags": [
"dnsZone"
],
"responses": {
"200": {
"description": "transfer a DNS zone to another account",
"schema": {
"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
}
}
}
}
}
}
},
"/dns_zones/{zone_id}/dns_records": {
"parameters": [
{
"name": "zone_id",
"type": "string",
"in": "path",
"required": true
}
],
"get": {
"operationId": "getDnsRecords",
"tags": [
"dnsZone"
],
"responses": {
"200": {
"description": "get all DNS records for a single DNS zone",
"schema": {
"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"
}
}
}
}
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
},
"post": {
"operationId": "createDnsRecord",
"tags": [
"dnsZone"
],
"consumes": [
"application/json"
],
"parameters": [
{
"name": "dns_record",
"in": "body",
"required": true,
"schema": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"hostname": {
"type": "string"
},
"value": {
"type": "string"
},
"ttl": {
"type": "integer",
"format": "int64"
},
"priority": {
"type": "integer",
"format": "int64"
},
"weight": {
"type": "integer",
"format": "int64"
},
"port": {
"type": "integer",
"format": "int64"
},
"flag": {
"type": "integer",
"format": "int64"
},
"tag": {
"type": "string"
}
}
}
}
],
"responses": {
"201": {
"description": "Created",
"schema": {
"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"
}
}
}
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
}
},
"/dns_zones/{zone_id}/dns_records/{dns_record_id}": {
"parameters": [
{
"name": "zone_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "dns_record_id",
"type": "string",
"in": "path",
"required": true
}
],
"get": {
"operationId": "getIndividualDnsRecord",
"tags": [
"dnsZone"
],
"responses": {
"200": {
"description": "get a single DNS record",
"schema": {
"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"
}
}
}
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
},
"delete": {
"operationId": "deleteDnsRecord",
"tags": [
"dnsZone"
],
"responses": {
"204": {
"description": "record deleted"
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
}
},
"/sites/{site_id}/dev_servers": {
"parameters": [
{
"name": "site_id",
"type": "string",
"in": "path",
"required": true
}
],
"get": {
"operationId": "listSiteDevServers",
"tags": [
"devServer"
],
"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"
},
"branch": {
"type": "string"
},
"url": {
"type": "string"
},
"state": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "dateTime"
},
"updated_at": {
"type": "string",
"format": "dateTime"
},
"starting_at": {
"type": "string",
"format": "dateTime"
},
"error_at": {
"type": "string",
"format": "dateTime"
},
"live_at": {
"type": "string",
"format": "dateTime"
},
"done_at": {
"type": "string",
"format": "dateTime"
},
"title": {
"type": "string"
}
}
}
}
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
},
"post": {
"operationId": "createSiteDevServer",
"tags": [
"devServer"
],
"parameters": [
{
"name": "branch",
"type": "string",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"site_id": {
"type": "string"
},
"branch": {
"type": "string"
},
"url": {
"type": "string"
},
"state": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "dateTime"
},
"updated_at": {
"type": "string",
"format": "dateTime"
},
"starting_at": {
"type": "string",
"format": "dateTime"
},
"error_at": {
"type": "string",
"format": "dateTime"
},
"live_at": {
"type": "string",
"format": "dateTime"
},
"done_at": {
"type": "string",
"format": "dateTime"
},
"title": {
"type": "string"
}
}
}
}
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
},
"delete": {
"operationId": "deleteSiteDevServers",
"tags": [
"devServer"
],
"parameters": [
{
"name": "branch",
"type": "string",
"in": "query"
}
],
"responses": {
"202": {
"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}/dev_servers/{dev_server_id}": {
"parameters": [
{
"name": "site_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "dev_server_id",
"type": "string",
"in": "path",
"required": true
}
],
"get": {
"operationId": "getSiteDevServer",
"tags": [
"devServer"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"site_id": {
"type": "string"
},
"branch": {
"type": "string"
},
"url": {
"type": "string"
},
"state": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "dateTime"
},
"updated_at": {
"type": "string",
"format": "dateTime"
},
"starting_at": {
"type": "string",
"format": "dateTime"
},
"error_at": {
"type": "string",
"format": "dateTime"
},
"live_at": {
"type": "string",
"format": "dateTime"
},
"done_at": {
"type": "string",
"format": "dateTime"
},
"title": {
"type": "string"
}
}
}
}
}
}
},
"/sites/{site_id}/dev_servers/{dev_server_id}/activity": {
"parameters": [
{
"name": "site_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "dev_server_id",
"type": "string",
"in": "path",
"required": true
}
],
"post": {
"x-internal": true,
"operationId": "markDevServerActivity",
"tags": [
"devServer"
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/sites/{site_id}/dev_servers/{dev_server_id}/state": {
"parameters": [
{
"name": "site_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "dev_server_id",
"type": "string",
"in": "path",
"required": true
}
],
"post": {
"operationId": "updateDevServerState",
"tags": [
"devServer"
],
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"type": "object",
"required": [
"state"
],
"properties": {
"state": {
"type": "string",
"enum": [
"starting",
"live",
"error",
"done"
]
},
"task_id": {
"type": "string"
},
"error": {
"type": "string"
}
}
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"site_id": {
"type": "string"
},
"branch": {
"type": "string"
},
"url": {
"type": "string"
},
"state": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "dateTime"
},
"updated_at": {
"type": "string",
"format": "dateTime"
},
"starting_at": {
"type": "string",
"format": "dateTime"
},
"error_at": {
"type": "string",
"format": "dateTime"
},
"live_at": {
"type": "string",
"format": "dateTime"
},
"done_at": {
"type": "string",
"format": "dateTime"
},
"title": {
"type": "string"
}
}
}
},
"409": {
"description": "Conflict"
}
}
}
},
"/sites/{site_id}/dev_server_hooks": {
"parameters": [
{
"name": "site_id",
"type": "string",
"in": "path",
"required": true
}
],
"get": {
"operationId": "listSiteDevServerHooks",
"tags": [
"devServerHook"
],
"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"
},
"type": {
"type": "string",
"enum": [
"new_dev_server",
"content_refresh"
]
}
}
}
}
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
},
"post": {
"operationId": "createSiteDevServerHook",
"tags": [
"devServerHook"
],
"consumes": [
"application/json"
],
"parameters": [
{
"name": "devServerHook",
"in": "body",
"schema": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"branch": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"new_dev_server",
"content_refresh"
]
}
}
},
"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"
},
"type": {
"type": "string",
"enum": [
"new_dev_server",
"content_refresh"
]
}
}
}
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
}
},
"/sites/{site_id}/dev_server_hooks/{id}": {
"parameters": [
{
"name": "site_id",
"type": "string",
"in": "path",
"required": true
},
{
"name": "id",
"type": "string",
"in": "path",
"required": true
}
],
"get": {
"operationId": "getSiteDevServerHook",
"tags": [
"devServerHook"
],
"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"
},
"type": {
"type": "string",
"enum": [
"new_dev_server",
"content_refresh"
]
}
}
}
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
},
"put": {
"operationId": "updateSiteDevServerHook",
"tags": [
"devServerHook"
],
"consumes": [
"application/json"
],
"parameters": [
{
"name": "devServerHook",
"in": "body",
"schema": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"branch": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"new_dev_server",
"content_refresh"
]
}
}
},
"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": "deleteSiteDevServerHook",
"tags": [
"devServerHook"
],
"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}/agent_runner_hooks": {
"parameters": [
{
"name": "site_id",
"type": "string",
"in": "path",
"required": true
}
],
"get": {
"x-internal": true,
"operationId": "listSiteAgentRunnerHooks",
"tags": [
"agentRunnerHook"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"site_id": {
"type": "string"
},
"title": {
"type": "string"
},
"branch": {
"type": "string"
},
"prompt": {
"type": "string"
},
"agent": {
"type": "string"
},
"url": {
"type": "string"
},
"msg": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "dateTime"
}
}
}