Get Info

Get Info

This API provides information like build number, version and UUID of the Usage Meter appliance.

Request
URI
GET
https://{api_host}/agent_info
COPY
Query Parameters
um_build_number
Optional

Include UM build number

um_version
Optional

Include UM version

um_uuid
Optional

Include UM UUID

Header Parameters
string
sessionid
Required

The authentication token obtained from login API response


Responses
200

OK

Returns GetAgentInfoResponse of type(s) application/json
{
    "hotfix_version": 0,
    "major_version": 1,
    "build_number": 16269725,
    "patch_version": 0,
    "uuid": "a51e735f-836c-4019-820f-772036abe551",
    "minor_version": 5
}
integer As int32 As int32
build_number
Optional

build_number

integer As int16 As int16
major_version
Optional

major_version

integer As int16 As int16
minor_version
Optional

minor_version

integer As int16 As int16
patch_version
Optional

patch_version

integer As int16 As int16
hotfix_version
Optional

hotfix_version

string As uuid As uuid
uuid
Optional

uuid

string
login_banner
Optional

login_banner


401
Returns 401Unauthorized_sessionID of type(s) application/json
{
    "errCode": "GW_LOGIN_REQUIRED",
    "errMessage": "Your session not found or already expired. Please login"
}
string
errCode
Optional

errCode

string
errMessage
Optional

errMessage