Get Farm Monitor Info

Gets monitoring information related to farm.

Request

URI

GET

https://{api_host}/rest/monitor/v1/farms/{id}

COPY

Path Parameters

string

Required

Authentication

This operation uses the following authentication methods.

Bearer

Responses

200

Returns FarmMonitorInfo of type(s) */*

{
    "application_count": 12,
    "details": {
        "source": "LINKED_CLONE",
        "type": "AUTOMATED"
    },
    "id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50",
    "name": "farm1",
    "rds_server_count": 123,
    "status": "OK"
}

integer As int32 As int32

application_count

Optional

Number of Applications published from the farm.

FarmMonitorDetails

details

Optional

details

string

Optional

Unique ID of the Farm.

string

name

Optional

Farm name.

integer As int32 As int32

rds_server_count

Optional

Number of RDS Servers in the farm.

string

status

Optional

Status of Farm.

OK: Farm is enabled and no servers are in WARNING or ERROR state. One or more server(s) may be DISABLED (including the case where all of them are DISABLED).
WARNING: Farm is enabled. One or more of the following is true:

One or more server(s) is either in WARNING or ERROR (not exceeding the predefined threshold) state.
The RDS Servers in this Farm present a mix of both known and unknown load preferences.

ERROR: Farm is enabled. One or more server(s) (exceeding the predefined threshold) is in ERROR state, or, for Automated Farms, there could be a provisioning error.
DISABLED: Farm is disabled.

Possible values are : OK, WARNING, ERROR, DISABLED,

401

User is not authenticated

Operation doesn't return any data structure

404

Not Found

Operation doesn't return any data structure

On This Page

Description

Request

Path Parameters

Authentication