Fetch a list of project deployments.
/accounts/{account_identifier}/pages/projects/{project_name}/deployments
get
Pages Deployment
pages-deployment-get-deployments
nullnull[
{
"in": "path",
"name": "project_name",
"required": true,
"schema": {
"description": "Name of the project.",
"example": "this-is-my-project-01",
"pattern": "^[a-z0-9][a-z0-9-]*$",
"type": "string"
}
},
{
"in": "path",
"name": "account_identifier",
"required": true,
"schema": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"readOnly": true,
"type": "string"
}
}
]null{
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result_info": {
"properties": {
"count": {
"example": 1
},
"page": {
"example": 1
},
"per_page": {
"example": 100
},
"total_count": {
"example": 1
}
},
"type": "object"
}
}
},
{
"properties": {
"result": {
"items": {
"properties": {
"aliases": {
"description": "A list of alias URLs pointing to this deployment.",
"example": [
"https://branchname.projectname.pages.dev"
],
"items": {},
"nullable": true,
"readOnly": true,
"type": "array"
},
"build_config": {
"readOnly": true
},
"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": {
"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": {
"readOnly": true
},
"modified_on": {
"description": "When the deployment was last modified.",
"example": "2021-03-09T00: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": {
"readOnly": true
},
"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": {
"description": "The status of the deployment.",
"properties": {
"ended_on": {
"description": "When the stage ended.",
"example": "2021-03-09T00:58:59.045655",
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"name": {
"description": "The current build stage.",
"example": "deploy",
"pattern": "queued|initialize|clone_repo|build|deploy",
"type": "string"
},
"started_on": {
"description": "When the stage started.",
"example": "2021-03-09T00:55:03.923456Z",
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"status": {
"description": "State of the current stage.",
"example": "success",
"pattern": "success|idle|active|failure|canceled",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
},
"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"
},
"type": "array"
}
}
}
]
}
}
},
"description": "Get deployments response."
},
"4XX": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result_info": {
"properties": {
"count": {
"example": 1
},
"page": {
"example": 1
},
"per_page": {
"example": 100
},
"total_count": {
"example": 1
}
},
"type": "object"
}
}
},
{
"properties": {
"result": {
"items": {
"properties": {
"aliases": {
"description": "A list of alias URLs pointing to this deployment.",
"example": [
"https://branchname.projectname.pages.dev"
],
"items": {},
"nullable": true,
"readOnly": true,
"type": "array"
},
"build_config": {
"readOnly": true
},
"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": {
"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": {
"readOnly": true
},
"modified_on": {
"description": "When the deployment was last modified.",
"example": "2021-03-09T00: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": {
"readOnly": true
},
"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": {
"description": "The status of the deployment.",
"properties": {
"ended_on": {
"description": "When the stage ended.",
"example": "2021-03-09T00:58:59.045655",
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"name": {
"description": "The current build stage.",
"example": "deploy",
"pattern": "queued|initialize|clone_repo|build|deploy",
"type": "string"
},
"started_on": {
"description": "When the stage started.",
"example": "2021-03-09T00:55:03.923456Z",
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"status": {
"description": "State of the current stage.",
"example": "success",
"pattern": "success|idle|active|failure|canceled",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
},
"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"
},
"type": "array"
}
}
}
]
},
{
"properties": {
"errors": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": [
{
"code": 7003,
"message": "No route for the URI."
}
],
"minLength": 1
},
"messages": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": []
},
"result": {
"nullable": true,
"type": "object"
},
"success": {
"description": "Whether the API call was successful.",
"enum": [
false
],
"example": false,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
}
]
}
}
},
"description": "Get deployments response failure."
}
}[
{
"api_email": [],
"api_key": []
}
]