Skip to navigation
VOS APIUplink Hub

Get Uplink by ID

Get a Uplink by specifying a uplink Id.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired
id

Response

OK
idstring
Id of the uplink
ipAddressstring
IP address of the uplink
namestring
Display name of a uplink
publicIpAddressstring
Public IP address of the uplink
clientIdstringOptional
clientSecretstringOptional
currentVersionstringOptional
Current version of cloudlink.
isInitializedbooleanOptional

[Obsoleted]whether the uplink is ready to be used by properly assigned the rank and name.

needToBeUpgradedbooleanOptional
If the uplink is needed to be upgraded.
rankintegerOptional
Priority of Uplink. Auto assigned when uplink is created. It can be updated afterwards.
versionstringOptional
Version which need to be upgraded to.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
410
Gone Error