Internet Explorer is no longer supported. Many things will still work, but your experience will be degraded and some things won't function. Please use a modern browser such as Edge, Chrome, or Firefox.
 
No matching results found

Purge Application Endpoint

view on GitHub

The Purge Application is an endpoint in BuildMaster's Application Management API that will purge an application.

🚀 Quick Example: Purging an Application with Curl

This example purges an application myApp, authenticating with the API key abc12345:

curl -X POST --header "X-ApiKey: abc12345" https://proget.corp.local/api/purge?application=myApp
Deactivating an Application

Note that you may choose to simply deactivate the application instead of completely purging it by using the Update Application Endpoint

Request Specification

To purge an existing application, simply POST to the URL with an appropriate API Key and querystring parameter application of the name or id to purge.

POST /api/applications/purge?«querystring-parameters»

An empty body is acceptable, but you can post key/value pairs in the body instead of the querystring.

Purging an application requires the name (e.g. myApp) or id (e.g. 2):

POST /api/applications/purge?application=myApp

POST /api/applications/purge?application=3

Purging an application with a body requires the name (e.g. myApp) or id (e.g. 2):

POST /api/applications/purge
{
    "name": "myApp"
}

Response Specification

Response Details
200 (Success) the application will be purged. The body will be empty
400 (Invalid Input) indicates application parameter is missing
403 (Unauthorized API Key) indicates a missing, unknown, or unauthorized API Key; the body will be empty
500 (Server Error) indicates an unexpected error; the body will contain the message and stack trace, and this will also be logged
In this article

inedo.com | Support | MyInedo

docs © 2024 Inedo, LLC