pages_deployments

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/pages_deployments",
  "title": "pages_deployments",
  "properties": {
    "aliases": {
      "description": "A list of alias URLs pointing to this deployment.",
      "example": [
        "https://branchname.projectname.pages.dev"
      ],
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true,
      "type": "array"
    },
    "build_config": {
      "$ref": "#/components/schemas/pages_build_config"
    },
    "created_on": {
      "description": "When the deployment was created.",
      "example": "2021-03-09T00:55:03.923456Z",
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "deployment_trigger": {
      "description": "Info about what caused the deployment.",
      "properties": {
        "metadata": {
          "description": "Additional info about the trigger.",
          "properties": {
            "branch": {
              "description": "Where the trigger happened.",
              "example": "main",
              "readOnly": true,
              "type": "string"
            },
            "commit_hash": {
              "description": "Hash of the deployment trigger commit.",
              "example": "ad9ccd918a81025731e10e40267e11273a263421",
              "readOnly": true,
              "type": "string"
            },
            "commit_message": {
              "description": "Message of the deployment trigger commit.",
              "example": "Update index.html",
              "readOnly": true,
              "type": "string"
            }
          },
          "type": "object"
        },
        "type": {
          "description": "What caused the deployment.",
          "example": "ad_hoc",
          "pattern": "push|ad_hoc",
          "readOnly": true,
          "type": "string"
        }
      },
      "readOnly": true,
      "type": "object"
    },
    "env_vars": {
      "additionalProperties": {
        "description": "Environment variable.",
        "nullable": true,
        "properties": {
          "type": {
            "description": "The type of environment variable.",
            "type": "string"
          },
          "value": {
            "description": "Environment variable value.",
            "type": "string"
          }
        },
        "required": [
          "value"
        ],
        "type": "object"
      },
      "description": "A dict of env variables to build this deploy.",
      "example": {
        "BUILD_VERSION": {
          "value": "3.3"
        },
        "ENV": {
          "value": "STAGING"
        }
      },
      "readOnly": true,
      "type": "object"
    },
    "environment": {
      "description": "Type of deploy.",
      "example": "preview",
      "pattern": "preview|production",
      "readOnly": true,
      "type": "string"
    },
    "id": {
      "description": "Id of the deployment.",
      "example": "f64788e9-fccd-4d4a-a28a-cb84f88f6",
      "readOnly": true,
      "type": "string"
    },
    "is_skipped": {
      "description": "If the deployment has been skipped.",
      "example": true,
      "readOnly": true,
      "type": "boolean"
    },
    "latest_stage": {
      "$ref": "#/components/schemas/pages_stage"
    },
    "modified_on": {
      "description": "When the deployment was last modified.",
      "example": "2021-03-09 00:58:59.045655",
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "project_id": {
      "description": "Id of the project.",
      "example": "7b162ea7-7367-4d67-bcde-1160995d5",
      "readOnly": true,
      "type": "string"
    },
    "project_name": {
      "description": "Name of the project.",
      "example": "ninjakittens",
      "readOnly": true,
      "type": "string"
    },
    "short_id": {
      "description": "Short Id (8 character) of the deployment.",
      "example": "f64788e9",
      "readOnly": true,
      "type": "string"
    },
    "source": {
      "$ref": "#/components/schemas/pages_source"
    },
    "stages": {
      "description": "List of past stages.",
      "example": [
        {
          "ended_on": "2021-06-03T15:39:03.134378Z",
          "name": "queued",
          "started_on": "2021-06-03T15:38:15.608194Z",
          "status": "active"
        },
        {
          "ended_on": null,
          "name": "initialize",
          "started_on": null,
          "status": "idle"
        },
        {
          "ended_on": null,
          "name": "clone_repo",
          "started_on": null,
          "status": "idle"
        },
        {
          "ended_on": null,
          "name": "build",
          "started_on": null,
          "status": "idle"
        },
        {
          "ended_on": null,
          "name": "deploy",
          "started_on": null,
          "status": "idle"
        }
      ],
      "items": {
        "$ref": "#/components/schemas/pages_stage"
      },
      "readOnly": true,
      "type": "array"
    },
    "url": {
      "description": "The live URL to view this deployment.",
      "example": "https://f64788e9.ninjakittens.pages.dev",
      "readOnly": true,
      "type": "string"
    }
  },
  "type": "object"
}