Skip to main content

GET /api/sam/target/state/

Get information for all instances


Reports the system state and metadata for all InterSystems IRIS® data platform instances monitored by SAM.

Request Example

GET http://localhost:8080/api/sam/target/state/

cluster Optional query parameter. Filters target instances by cluster id.

This endpoint supports a cluster query parameter that filters the results by cluster. For example:

GET http://localhost:8080/api/sam/target/state/?cluster=2

Response Example

The response is a JSON array of JSON objects for each configured instance, such as:

        "instance": "",
        "name": "IRIS_primary",
        "description": "Primary Mirror Member",
        "clustername": "local",
        "id": 1,
        "clusterid": 1,
        "urlPrefix": "/mirror1",
        "dashboardId": "2",
        "state": 0
        "instance": "",
        "name": "IRIS_backup",
        "description": "Backup Mirror Member",
        "clustername": "local",
        "id": "2",
        "clusterid": 1,
        "urlPrefix": "/mirror2",
        "dashboardId": "HTIxx8IVz",
        "state": 1

The urlPrefix and dashboardId properties were added in SAM version 2.0.

The possible values for state are:

  • -1: Unreachable

  • 0: OK

  • 1: Warning

  • 2: Critical

FeedbackOpens in a new tab