Rollback deployment - Cloudflare

Rollback the production deployment to a previous deploy. You can only rollback to succesful builds on production.

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Rollback deployment response

application/json

Body

errors

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

messages

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

result

deployments

required

Any of

object

allOf {2}

aliases

array | null

read-onlyoptional

A list of alias URLs pointing to this deployment.

Example:

["https://branchname.projectname.pages.dev"]

build_config

read-onlyoptional

created_on

string <date-time>

read-onlyoptional

When the deployment was created.

Example:

2021-03-09T00:55:03.923456Z

deployment_trigger

object

read-onlyoptional

Info about what caused the deployment.

env_vars

object

read-onlyoptional

A dict of env variables to build this deploy.

Example:

{"BUILD_VERSION":{"value":"3.3"},"ENV":{"value":"STAGING"}}

environment

string

read-onlyoptional

Type of deploy.

Example:

preview

Match pattern:

preview|production

string

read-onlyoptional

Id of the deployment.

Example:

f64788e9-fccd-4d4a-a28a-cb84f88f6

is_skipped

boolean

read-onlyoptional

If the deployment has been skipped.

Example:

true

latest_stage

read-onlyoptional

modified_on

string <date-time>

read-onlyoptional

When the deployment was last modified.

Example:

2021-03-09T00:58:59.045655

project_id

string

read-onlyoptional

Id of the project.

Example:

7b162ea7-7367-4d67-bcde-1160995d5

project_name

string

read-onlyoptional

Name of the project.

Example:

ninjakittens

short_id

string

read-onlyoptional

Short Id (8 character) of the deployment.

Example:

f64788e9

source

read-onlyoptional

stages

array[object (stage) {4}]

read-onlyoptional

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"}]

url

string

read-onlyoptional

The live URL to view this deployment.

Example:

https://f64788e9.ninjakittens.pages.dev

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

Example

{
    "errors": [],
    "messages": [],
    "result": {
        "aliases": [
            "https://branchname.projectname.pages.dev"
        ],
        "build_config": null,
        "created_on": "2021-03-09T00:55:03.923456Z",
        "deployment_trigger": {
            "metadata": {
                "branch": "main",
                "commit_hash": "ad9ccd918a81025731e10e40267e11273a263421",
                "commit_message": "Update index.html"
            },
            "type": "ad_hoc"
        },
        "env_vars": {
            "BUILD_VERSION": {
                "value": "3.3"
            },
            "ENV": {
                "value": "STAGING"
            }
        },
        "environment": "preview",
        "id": "f64788e9-fccd-4d4a-a28a-cb84f88f6",
        "is_skipped": true,
        "latest_stage": null,
        "modified_on": "2021-03-09T00:58:59.045655",
        "project_id": "7b162ea7-7367-4d67-bcde-1160995d5",
        "project_name": "ninjakittens",
        "short_id": "f64788e9",
        "source": null,
        "stages": [
            {
                "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"
            }
        ],
        "url": "https://f64788e9.ninjakittens.pages.dev"
    },
    "success": true
}

🟢200Rollback deployment response failure