Get application environment instances

GET <your-unleash-url>/api/admin/metrics/instances/:appName/environment/:environment

Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API

Returns an overview of the instances for the given appName and environment that receive traffic.

Request

Path Parameters

• appName string required
• environment string required

Responses

• 200
• 404

---

applicationEnvironmentInstancesSchema

application/json

Schema

Schema

• instances object[]required

  A list of instances

  Array [

  instanceId string required

  A unique identifier identifying the instance of the application running the SDK. Often changes based on execution environment. For instance: two pods in Kubernetes will have two different instanceIds

  sdkVersion string

  An SDK version identifier. Usually formatted as "unleash-client-:"

  clientIp string

  An IP address identifying the instance of the application running the SDK

  lastSeen date-time

  The last time the application environment instance was seen

  ]

Example (from schema)

{
  "instances": [
    {
      "instanceId": "b77f3d13-5f48-4a7b-a3f4-a449b97ce43a",
      "sdkVersion": "unleash-client-java:7.0.0",
      "clientIp": "192.168.0.1",
      "lastSeen": "2023-04-19T08:15:14.000Z"
    }
  ]
}

The requested resource was not found.

application/json

Schema

Schema

• id string

  The ID of the error instance

• name string

  The name of the error kind

• message string

  A description of what went wrong.

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "NotFoundError",
  "message": "Could not find the addon with ID \"12345\"."
}

Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API

Request

Base URL

<your-unleash-url>

Security Scheme

apiKeybearerToken

apiKey

appName — path required

environment — path required

curl / cURL

curl -L -X GET '<your-unleash-url>/api/admin/metrics/instances/:appName/environment/:environment' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

python / requests

curl -L -X GET '<your-unleash-url>/api/admin/metrics/instances/:appName/environment/:environment' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

go / native

curl -L -X GET '<your-unleash-url>/api/admin/metrics/instances/:appName/environment/:environment' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

nodejs / native

curl -L -X GET '<your-unleash-url>/api/admin/metrics/instances/:appName/environment/:environment' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

ruby / Net::HTTP

curl -L -X GET '<your-unleash-url>/api/admin/metrics/instances/:appName/environment/:environment' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

csharp / httpclient

curl -L -X GET '<your-unleash-url>/api/admin/metrics/instances/:appName/environment/:environment' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

php / cURL

curl -L -X GET '<your-unleash-url>/api/admin/metrics/instances/:appName/environment/:environment' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

java / OkHttp

curl -L -X GET '<your-unleash-url>/api/admin/metrics/instances/:appName/environment/:environment' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

powershell / RestMethod

curl -L -X GET '<your-unleash-url>/api/admin/metrics/instances/:appName/environment/:environment' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'