Restore Release
- 11 Mar 2024
- 1 Minute to read
- Print
- DarkLight
- PDF
Restore Release
- Updated on 11 Mar 2024
- 1 Minute to read
- Print
- DarkLight
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
The Restore Release is an endpoint in BuildMaster's Release & Build Deployment API that will restore a release, with the parameters defined in the body of the request.
🚀 Quick Example: Restoring a release with Curl
This example rejects a build with a releaseId of 1 and the applicationName TaxCalculator, authenticating with the API key abc12345:
curl -X POST -H "X-ApiKey: abc12345" -H "Content-Type: application/json" -d "{\"releaseId\": \"1\", \"applicationName\": \"TaxCalculator\"}" "https://proget.corp.local/api/releases/restore"
Request Specification
POST/PUT /api/releases/restore
To restore a release, simply POST or PUT to the URL with an appropriate API Key and a request body, containing the following parameters:
| Input | Parameter Specification |
|---|---|
| Release | Required. Either a key named releaseId with an integer value, or a key named releaseNumber with any value. |
| Application | Required if releaseNumber is specified, otherwise must not be set. Either a key named applicationId with an integer value, or a key named applicationName with any value. |
Restoring a release requires parameters defined in the request body.
POST /api/releases/restore
{
"releaseId": "1",
"applicationName": "TaxCalculator"
}
Response Specification
| Response | Details |
|---|---|
| 200 (Success) | the specified release was restored |
| 400 (Invalid Input) | indicates invalid or missing properties in the request; the body will provide some details as text |
| 403 (Unauthorized API Key) | indicates a missing, unknown, or unauthorized API Key; the body will be empty |
Was this article helpful?
