Deleting an application -- synthetic API
The DELETE method of the applications API deletes an application.
Before you begin
You must obtain an authToken by using the login API. The token authenticates the user performing the operation. For details, see TSWS authentication.
Synthetic configuration APIs
API | Method | Description |
|---|---|---|
Applications | GET | Retrieve the details of one application or all applications |
PUT | Update an existing application | |
POST | Create a new application | |
DELETE | Delete an application | |
Execution Plans | GET | Retrieve the details of one or more Execution Plans |
PUT | ||
DELETE | Delete an Execution Plan | |
Scripts | GET | Retrieve the details of one script or all scripts |
Locations | GET | Retrieve the details of all locations |
To delete an application
The applications API uses the DELETE method to delete an application.
Request syntax
Request parameters
Element | Description |
|---|---|
authToken | Value of authToken |
Query parameter | |
applicationId | ID of the application that you want to delete |
Sample request with REST client
After accessing the REST client, perform the following steps:
Enter the URLAPI.
The generic format is as follows:https://localhost/tsws/10.0/api/appvis/synthetic/api/applications/delete?applicationId=4
- Add a new header row and select Authorization as the header type.
Enter the text authToken followed by the authToken generated through the login API.
- Click Send.
Response
If the delete operation is successful, the response is empty.
If the delete operation is not successful, the response is an error object.