Updating an application -- synthetic API

The PUT method of the applications API saves 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

Notes:

If you have upgraded to version 11.3.02, you can access the Synthetic Blackout and Synthetic Time Frames APIs listed in this table.

If you are using version 11.3.01 or earlier, you can continue to use the Execution Plan APIs to access the Blackouts.

API	Method	Description
Applications	GET	Retrieve the details of applications
	PUT	Update an existing application
	POST	Create a new application
	DELETE	Delete an application
Execution Plans	GET	Retrieve the details of Execution Plans
	PUT	Create a new Execution Plan Update an existing Execution Plan
	DELETE	Delete an Execution Plan
Scripts	GET	Retrieve the details of scripts
Locations	GET	Retrieve the details of all locations
Blackouts	POST	Retrieve the details of Blackouts
	PUT	Create a new Blackout Update an existing Blackout
	POST	Activate the Blackout
	POST	Deactivate the Blackout
	POST	Delete a Blackout
Time Frames	POST	Retrieve the details of Time Frames
	PUT	Create a new Time Frames Update an existing Time Frames
	POST	Delete Time Frames

To save an application

The applications API uses the PUT method to update an application.

Request syntax

https://localhost/tsws/10.0/api/appvis/synthetic/api/applications/update

Request with REST client

After accessing the REST client, perform the following steps:

Enter the URL for API.
An example of a request to update an application is:
```
https://localhost/tsws/10.0/api/appvis/synthetic/api/applications/update
```
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.
Enter the json code in the request body.
Click Send.

Request parameters

Element	Description
authToken	Value of authToken

Request body

The following code is an example of the JSON code to send with the request.

Expand source

	{
		"name":"MyApp2",
		"importance":"MEDIUM",
		"description":"",
		"synthetic":"ON",
		"id":"4"
	}

Request body parameters

The following parameters are the parameters that are relevant for synthetic monitoring.

The id parameter is required.
All other parameters are optional. Include them only if you are updating them.

Parameter	Description	Value
name	Name of the application model	String
importance	Importance level of the application	HIGH MEDIUM LOW
description	Description of the application	String
synthetic	Indicates if synthetic monitoring is enabled for the application	ON
id	(Required) The ID of the application on the Presentation Server (not the synthetic application ID)	String representing a numeric value