Netlify · Schema

deploy

CDNCloudContinuous DeploymentEdge ComputingJAMstackServerlessServerless FunctionsStatic SitesWeb HostingWebsites

Properties

Name Type Description
id string
site_id string
user_id string
build_id string
state string
name string
url string
ssl_url string
admin_url string
deploy_url string
deploy_ssl_url string
screenshot_url string
review_id number
draft boolean
required array
required_functions array
error_message string
branch string
commit_ref string
commit_url string
skipped boolean
created_at string
updated_at string
published_at string
title string
context string
locked boolean
review_url string
framework string
function_schedules array
View JSON Schema on GitHub

JSON Schema

netlify-deploy-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/deploy",
  "title": "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"
      }
    },
    "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"
    },
    "function_schedules": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/functionSchedule"
      }
    }
  }
}