Get application environment instances (Last 24h)

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

Returns an overview of the instances for the given appName and environment that have received traffic in the last 24 hours.

Request

Path Parameters

appName stringrequired
environment stringrequired

Responses

200

applicationEnvironmentInstancesSchema

application/json

Schema

Schema

instances object[]required
A list of instances
Array [
instanceIdstringrequired
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
Example: b77f3d13-5f48-4a7b-a3f4-a449b97ce43a
sdkVersionstringnullable
An SDK version identifier. Usually formatted as "unleash-client-:"
Example: unleash-client-java:7.0.0
clientIpstring
An IP address identifying the instance of the application running the SDK
Example: 192.168.0.1
lastSeendate-time
The last time the application environment instance was seen
Example: 2023-04-19T08:15:14.000Z
]

Example (auto)

{
  "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"
    }
  ]
}

404

The requested resource was not found.

application/json

Schema

Schema

idstring
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
namestring
The name of the error kind
Example: NotFoundError
messagestring
A description of what went wrong.
Example: Could not find the addon with ID "12345".

Example (auto)

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

Authorization: Authorization

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

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

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

Request Collapse all

Base URL

<your-unleash-url>

Auth

Security Scheme

apiKeybearerToken

apiKey

Parameters

appName — pathrequired

environment — pathrequired

ResponseClear

Click the Send API Request button above and see the response here!