PUT /api/sam/admin/target/{id}

Update an instance’s information

Description

Update the metadata for this target in the %SAM.Target table and targets.json file.

To use this endpoint, you must log in as a user with access to the %SAM.Admin resource.

Request Example

PUT http://localhost:8080/api/sam/admin/target/4

Parameters

id	Required path variable. The id of the target instance to update.

Example JSON Request Packet (SAM 1.0 and 1.1)

{
    "instance": "iris:52773",
    "name": "IRIS3",
    "description": "Local IRIS3",
    "cluster": 1,
}

Example JSON Request Packet (SAM 2.0 and later)

Starting with SAM version 2.0, a JSON request packet for SAM 2.0 must also include dashboardId and urlPrefix properties. If the instance has no URL prefix, specify the value of urlPrefix as an empty string (""). For example:

{
    "instance": "iris:52773",
    "name": "IRIS3",
    "description": "Local IRIS3",
    "cluster": 1,
    "urlPrefix": "/local3",
    "dashboardId": "HTIxx8IVz"
}