Delete multiple deployment records by ID list

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Deletes all deployment records specified in deploymentIDs.

Request URL

https://{server-hostname}:8383/emsapi/osdeployer/deployments

Scope

OSDDeployment.DELETECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory
application/deploymentIDs.v1+jsonapplication/deploymentIDs.v1+jsonCopied!
AcceptstringMandatory
application/deploymentDeleteStatus.v1+jsonapplication/deploymentDeleteStatus.v1+jsonCopied!

- Request Body

application/deploymentIDs.v1+json
JSON Object
Hide Sub-Attributes
deploymentIDsarrayMandatory

IDs of OS Deployer deployment records to delete.

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request DELETE \
  --url https://appdomain/emsapi/osdeployer/deployments \
  --header 'Accept: application/deploymentDeleteStatus.v1+json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/deploymentIDs.v1+json' \
  --data '{"deploymentIDs":[5001,5002,5003]}'

Sample Request Body

Delete three deployment records

Copied!
  {
    "deploymentIDs": [
      5001,
      5002,
      5003
    ]
  }
                
Show full

Response Parameters

- HTTP code 200

Response Body - application/deploymentDeleteStatus.v1+json
JSON Object
Hide Sub-Attributes
deploymentDeleteStatusboolean

True if the deployments were successfully deleted.

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

All deployment records deleted

Copied!
  {
    "deploymentDeleteStatus": true
  }
                
Show full

Duration: 1 minute | Threshold: 50 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.