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
},
"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 [getEnvVars](#tag/environmentVariables/operation/getEnvVars) to retrieve site environment variables."
}
},
"/{account_slug}/members": {
"parameters": [
{
"name": "account_slug",
"in": "path",
"type": "string",
"required": true
}
],
"get": {
"operationId": "listMembersForAccount",
"tags": [
"member"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"full_name": {
"type": "string"
},
"email": {
"type": "string"
},
"avatar": {
"type": "string"
},
"role": {
"type": "string"
}
}
}
}
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
},
"post": {
"operationId": "addMemberToAccount",
"tags": [
"member"
],
"consumes": [
"application/json"
],
"parameters": [
{
"name": "accountAddMemberSetup",
"in": "body",
"schema": {
"type": "object",
"properties": {
"role": {
"type": "string",
"enum": [
"Owner",
"Developer",
"Billing Admin",
"Reviewer"
]
},
"email": {
"type": "string"
}
}
},
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"full_name": {
"type": "string"
},
"email": {
"type": "string"
},
"avatar": {
"type": "string"
},
"role": {
"type": "string"
}
}
}
}
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
}
},
"/{account_slug}/members/{member_id}": {
"parameters": [
{
"name": "account_slug",
"in": "path",
"type": "string",
"required": true
},
{
"name": "member_id",
"in": "path",
"type": "string",
"required": true
}
],
"get": {
"operationId": "getAccountMember",
"tags": [
"member"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"full_name": {
"type": "string"
},
"email": {
"type": "string"
},
"avatar": {
"type": "string"
},
"role": {
"type": "string"
}
}
}
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
},
"put": {
"operationId": "updateAccountMember",
"tags": [
"member"
],
"consumes": [
"application/json"
],
"parameters": [
{
"name": "accountUpdateMemberSetup",
"in": "body",
"schema": {
"type": "object",
"properties": {
"role": {
"type": "string",
"enum": [
"Owner",
"Developer",
"Billing Admin",
"Reviewer"
]
},
"site_access": {
"type": "string",
"enum": [
"all",
"none",
"selected"
]
},
"site_ids": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"full_name": {
"type": "string"
},
"email": {
"type": "string"
},
"avatar": {
"type": "string"
},
"role": {
"type": "string"
}
}
}
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
},
"delete": {
"operationId": "removeAccountMember",
"tags": [
"member"
],
"responses": {
"204": {
"description": "Not Content"
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
}
},
"/billing/payment_methods": {
"get": {
"operationId": "listPaymentMethodsForUser",
"tags": [
"paymentMethod"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"method_name": {
"type": "string"
},
"type": {
"type": "string"
},
"state": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"card_type": {
"type": "string"
},
"last4": {
"type": "string"
},
"email": {
"type": "string"
}
}
},
"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
}
}
}
}
}
}
},
"/accounts/types": {
"get": {
"operationId": "listAccountTypesForUser",
"tags": [
"accountType"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"capabilities": {
"type": "object"
},
"monthly_dollar_price": {
"type": "integer"
},
"yearly_dollar_price": {
"type": "integer"
},
"monthly_seats_addon_dollar_price": {
"type": "integer"
},
"yearly_seats_addon_dollar_price": {
"type": "integer"
}
}
}
}
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
}
},
"/accounts": {
"get": {
"operationId": "listAccountsForUser",
"tags": [
"accountMembership"
],
"parameters": [
{
"name": "minimal",
"x-internal": true,
"type": "boolean",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"type": {
"type": "string"
},
"capabilities": {
"type": "object",
"properties": {
"sites": {
"type": "object",
"properties": {
"included": {
"type": "integer"
},
"used": {
"type": "integer"
}
}
},
"collaborators": {
"type": "object",
"properties": {
"included": {
"type": "integer"
},
"used": {
"type": "integer"
}
}
}
}
},
"billing_name": {
"type": "string"
},
"billing_email": {
"type": "string"
},
"billing_details": {
"type": "string"
},
"billing_period": {
"type": "string"
},
"payment_method_id": {
"type": "string"
},
"type_name": {
"type": "string"
},
"type_id": {
"type": "string"
},
"owner_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"roles_allowed": {
"type": "array",
"items": {
"type": "string"
}
},
"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
}
}
}
}
}
},
"post": {
"operationId": "createAccount",
"tags": [
"accountMembership"
],
"parameters": [
{
"name": "accountSetup",
"in": "body",
"schema": {
"type": "object",
"required": [
"name",
"type_id"
],
"properties": {
"name": {
"type": "string"
},
"type_id": {
"type": "string"
},
"payment_method_id": {
"type": "string"
},
"period": {
"type": "string",
"enum": [
"monthly",
"yearly"
]
},
"extra_seats_block": {
"type": "integer"
}
}
},
"required": true
}
],
"responses": {
"201": {
"description": "Created",
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"type": {
"type": "string"
},
"capabilities": {
"type": "object",
"properties": {
"sites": {
"type": "object",
"properties": {
"included": {
"type": "integer"
},
"used": {
"type": "integer"
}
}
},
"collaborators": {
"type": "object",
"properties": {
"included": {
"type": "integer"
},
"used": {
"type": "integer"
}
}
}
}
},
"billing_name": {
"type": "string"
},
"billing_email": {
"type": "string"
},
"billing_details": {
"type": "string"
},
"billing_period": {
"type": "string"
},
"payment_method_id": {
"type": "string"
},
"type_name": {
"type": "string"
},
"type_id": {
"type": "string"
},
"owner_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"roles_allowed": {
"type": "array",
"items": {
"type": "string"
}
},
"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
}
}
}
}
}
}
},
"/accounts/{account_id}": {
"parameters": [
{
"name": "account_id",
"type": "string",
"in": "path",
"required": true
}
],
"get": {
"operationId": "getAccount",
"tags": [
"accountMembership"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"type": {
"type": "string"
},
"capabilities": {
"type": "object",
"properties": {
"sites": {
"type": "object",
"properties": {
"included": {
"type": "integer"
},
"used": {
"type": "integer"
}
}
},
"collaborators": {
"type": "object",
"properties": {
"included": {
"type": "integer"
},
"used": {
"type": "integer"
}
}
}
}
},
"billing_name": {
"type": "string"
},
"billing_email": {
"type": "string"
},
"billing_details": {
"type": "string"
},
"billing_period": {
"type": "string"
},
"payment_method_id": {
"type": "string"
},
"type_name": {
"type": "string"
},
"type_id": {
"type": "string"
},
"owner_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"roles_allowed": {
"type": "array",
"items": {
"type": "string"
}
},
"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": "updateAccount",
"tags": [
"accountMembership"
],
"parameters": [
{
"name": "accountUpdateSetup",
"in": "body",
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"type_id": {
"type": "string"
},
"extra_seats_block": {
"type": "integer"
},
"billing_name": {
"type": "string"
},
"billing_email": {
"type": "string"
},
"billing_details": {
"type": "string"
}
}
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"type": {
"type": "string"
},
"capabilities": {
"type": "object",
"properties": {
"sites": {
"type": "object",
"properties": {
"included": {
"type": "integer"
},
"used": {
"type": "integer"
}
}
},
"collaborators": {
"type": "object",
"properties": {
"included": {
"type": "integer"
},
"used": {
"type": "integer"
}
}
}
}
},
"billing_name": {
"type": "string"
},
"billing_email": {
"type": "string"
},
"billing_details": {
"type": "string"
},
"billing_period": {
"type": "string"
},
"payment_method_id": {
"type": "string"
},
"type_name": {
"type": "string"
},
"type_id": {
"type": "string"
},
"owner_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"roles_allowed": {
"type": "array",
"items": {
"type": "string"
}
},
"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": "cancelAccount",
"tags": [
"accountMembership"
],
"responses": {
"204": {
"description": "Not Content"
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
}
},
"/accounts/{account_id}/audit": {
"parameters": [
{
"name": "account_id",
"type": "string",
"in": "path",
"required": true
}
],
"get": {
"operationId": "listAccountAuditEvents",
"tags": [
"auditLog"
],
"parameters": [
{
"name": "query",
"type": "string",
"in": "query"
},
{
"name": "log_type",
"type": "string",
"in": "query"
},
{
"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"
},
"account_id": {
"type": "string"
},
"payload": {
"type": "object",
"properties": {
"actor_id": {
"type": "string"
},
"actor_name": {
"type": "string"
},
"actor_email": {
"type": "string"
},
"action": {
"type": "string"
},
"timestamp": {
"type": "string",
"format": "dateTime"
},
"log_type": {
"type": "string"
}
},
"additionalProperties": {
"type": "object"
}
}
}
}
}
},
"default": {
"description": "error",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"x-nullable": false
}
}
}
}
}
}
},
"/agent_runners": {
"get": {
"operationId": "listAgentRunners",
"tags": [
"agentRunner"
],
"parameters": [
{
"name": "account_id",
"type": "string",
"in": "query",
"required": true
},
{
"name": "site_id",
"type": "string",
"in": "query",
"required": true
},
{
"type": "integer",
"format": "int32",
"name": "page",
"required": false,
"in": "query"
},
{
"type": "integer",
"format": "int32",
"name": "per_page",
"required": false,
"in": "query"
},
{
"name": "state",
"type": "string",
"in": "query",
"enum": [
"live",
"error"
]
},
{
"name": "title",
"type": "string",
"in": "query"
},
{
"name": "branch",
"type": "string",
"in": "query"
},
{
"name": "result_branch",
"type": "string",
"in": "query"
},
{
"name": "from",
"type": "integer",
"in": "query"
},
{
"name": "to",
"type": "integer",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"site_id": {
"type": "string"
},
"parent_agent_runner_id": {
"type": "string"
},
"state": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "dateTime"
},
"updated_at": {
"type": "string",
"format": "dateTime"
},
"done_at": {
"type": "string",
"format": "dateTime"
},
"title": {
"type": "string"
},
"branch": {
"type": "string"
},
"result_branch": {
"type": "string"
},
"pr_url": {
"type": "string"
},
"pr_branch": {
"type": "string"
},
"pr_state": {
"type": "string"
},
"pr_number": {
"type": "integer"
},
"pr_is_being_created": {
"type": "boolean"
},
"pr_error": {
"type": "string"
},
"current_task": {
"type": "string"
},
"result_diff": {
"type": "string"
},
"sha": {
"type": "string"
},
"merge_commit_sha": {
"type": "string"
},
"merge_commit_error": {
"type": "string"
},
"merge_commit_is_being_created": {
"type": "boolean"
},
"base_deploy_id": {
"type": "string"
},
"attached_file_keys": {
"type": "array",
"items": {
"type": "string"
}