API for Explorer
Table of Contents
The Explorer API allows you check the tags and incoming data of your production environment in real-time.
API Methods
The following methods are provided
| Method | URL | Description |
|---|---|---|
GET |
/instance/{vmId} |
Get VM instance |
GET |
/instance/{vmId}/annotations |
Get VM instance annotations |
DELETE |
/instance/{vmId}/tags |
Delete VM instance tags |
GET |
/instance/{vmId}/tags |
Get VM instance tags |
POST |
/instance/{vmId}/tags |
Add tag to VM instance |
PUT |
/instance/{vmId}/tags |
Set VM instance tags |
DELETE |
/instance/{vmId}/tags/{tag} |
Delete VM instance tag |
Example Request
curl -X 'GET' \
'https://YOUR_ENDPOINT.azul.com/public/instance/<VM_ID>' \
-H 'accept: application/json' \
-H 'x-api-key: ' \
-H 'Content-Type: application/json'
Example Response
{
"vmId": "5f5f591d-6f16-...",
"agentVersion": "1.0.79",
"agentRevision": "3525bad",
"inventory": {
"systemProperties": {
"java.specification.version": "17",
"sun.management.compiler": "Zing 64-Bit Tiered VM",
"sun.jnu.encoding": "UTF-8",
"java.runtime.version": "17.0.10+7-LTS",
"user.name": "luceneunittests",
"java.class.path": "/usr/share/ant/lib/ant-launcher.jar:/src/.ant/lib/ivy-2.4.0....",
"java.vm.vendor": "Azul Systems, Inc.",
"path.separator": ":",
...
},
"hostName": "4ae92b2d57d6",
"osEnvironment": {},
"mainMethod": "org/apache/tools/ant/launch/Launcher.main",
"cpuInfo": {
"Number of Processors": 16,
"Number of Assigned Logical Cores": 16,
"CPU Vendor": "AuthenticAMD",
"CPU Model Name": "AMD EPYC-Rome Processor",
"Number of Physical Cores": 1
}
},
"startTime": 1712080780851,
"lastHeardTime": 1712081055072,
"mailbox": "mailbox@crs",
"state": "TERMINATED",
"jvmInfo": {}
}