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

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
Create a new Execution Plan or
Update an existing Execution Plan
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 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:

  1. 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

  2. Add a new header row and select Authorization as the header type.
  3. Enter the text authToken followed by the authToken generated through the login API. 
  4. Enter the json code in the request body.
  5. 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.

 

{
"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) ID of the application

String representing a numeric value

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*