Skip to main content
Previous section   Next section

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

Get cluster of a specific instance

Description

This method returns the cluster and metadata of the target InterSystems IRIS® data platform instance.

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

Note:

This endpoint returns a subset of the information returned by GET /api/sam/target/state/{id}

Request Example

GET /api/sam/admin/target/3

Parameters
id Required path variable. The id of the target instance.

Response Example

The format of the JSON response body is a simple object with a cluster field. For example:

{
    "name": "IRIS3",
    "description": "Local IRIS3",
    "cluster": 1,
    "instance": "iris:52773"
}
Copy code to clipboard
Previous section   Next section