Reset or Complete reset a specified deployment.

1 min

POST

https://paasportal.episerver.net/api/v1.0/projects/{projectId}/deployments/{deploymentId}/reset

Operation is available after start deployment has finished during the verification stage or reset-verification stage of the deployment. This will abort deployment and reset the staging slot to allow for a new deployment. This will also complete the on-going reset progress if maintenance mode was applied for the deployment.

Path Parameters

projectIdstring<uuid>required
Description
Project ID
Format
uuid
deploymentIdstring<uuid>required
Description
Deployment ID
Format
uuid

Body Parameters

bodyResetDeploymentRequestParametersrequired
Example
```
{
  "resetWithDbRollback": true,
  "validateBeforeSwap": true,
  "complete": false
}
```
Description
The reset deployment parameters
- validateBeforeSwapboolean
- completeboolean
- resetWithDbRollbackboolean

Responses

200OK

ResetDeploymentResponse
- errorsstring[]
- resultDeploymentApiResponseModel
  - projectIdstring<uuid>
    Format
    uuid
  - statusstring
  - startTimestring<date-time>
    Format
    date-time
  - endTimestring<date-time>
    Format
    date-time
  - percentCompleteinteger<int32>
    Format
    int32
  - validationLinksstring[]
  - deploymentWarningsstring[]
  - deploymentErrorsstring[]
  - parametersCodeDeploymentRequest
    - maintenancePageboolean
    - zeroDowntimeModestring
    - targetEnvironmentstring
  - idstring<uuid>
    Format
    uuid
- successboolean

400BadRequest

BadRequestApiErrorResponseExample

401Unauthorized

UnauthorizedApiErrorResponseExample

404NotFound

NotFoundApiErrorResponseExample

500InternalServerError

InternalServerErrorApiErrorResponseExample

curl

curl --request POST \
     --url https://paasportal.episerver.net/api/v1.0/projects/{projectId}/deployments/{deploymentId}/reset \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://paasportal.episerver.net/api/v1.0/projects/{projectId}/deployments/{deploymentId}/reset", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://paasportal.episerver.net/api/v1.0/projects/{projectId}/deployments/{deploymentId}/reset")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://paasportal.episerver.net/api/v1.0/projects/{projectId}/deployments/{deploymentId}/reset"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

200

// OK
{
  "errors": [
    ""
  ],
  "result": {
    "projectId": "",
    "status": "",
    "startTime": "",
    "endTime": "",
    "percentComplete": "",
    "validationLinks": [
      ""
    ],
    "deploymentWarnings": [
      ""
    ],
    "deploymentErrors": [
      ""
    ],
    "parameters": {
      "maintenancePage": false,
      "zeroDowntimeMode": "",
      "targetEnvironment": ""
    },
    "id": ""
  },
  "success": false
}

GENERATED

// OK
{
  "errors": [
    ""
  ],
  "result": {
    "projectId": "",
    "status": "",
    "startTime": "",
    "endTime": "",
    "percentComplete": "",
    "validationLinks": [
      ""
    ],
    "deploymentWarnings": [
      ""
    ],
    "deploymentErrors": [
      ""
    ],
    "parameters": {
      "maintenancePage": false,
      "zeroDowntimeMode": "",
      "targetEnvironment": ""
    },
    "id": ""
  },
  "success": false
}

response

{
  "success": true,
  "errors": [],
  "result": {
    "id": "a9d75c10-56a1-4d1a-b58d-fe9e9b8dfd00",
    "projectId": "a695406b-f24f-4d82-908a-aaa4009e514f",
    "status": "AwaitingVerification",
    "startTime": "2019-10-29T08:00:00Z",
    "endTime": null,
    "percentComplete": 100,
    "validationLinks": [
      "https://episite.dxcloud.episerver.net/"
    ],
    "deploymentWarnings": [],
    "deploymentErrors": [],
    "parameters": null
  }
}

400

// BadRequest
{}

GENERATED

// BadRequest
{}

response

{
  "success": false,
  "errors": [
    "Project Id is a required field."
  ],
  "result": null
}

401

// Unauthorized
{}

GENERATED

// Unauthorized
{}

response

{
  "success": false,
  "errors": [
    "Access is denied for project c943975b-d468-4b85-8e62-5967b9eeeece or environment Preproduction."
  ],
  "result": null
}

404

// NotFound
{}

GENERATED

// NotFound
{}

response

{
  "success": false,
  "errors": [
    "There is no active project found for project id: c943975b-d468-4b85-8e62-5967b9eeeece."
  ],
  "result": null
}

500

// InternalServerError
{}

GENERATED

// InternalServerError
{}

response

{
  "success": false,
  "errors": [
    "An error occurred while processing the request; Try again later."
  ],
  "result": null
}