Skip to navigation
VOS APIUplink Hub

Create uplink

Create new uplink.

Authentication

AuthorizationBearer

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

Request

param0
idstringRequired
Id of the uplink
ipAddressstringRequired
IP address of the uplink
namestringRequired
Display name of a uplink
publicIpAddressstringRequired
Public IP address of the uplink
currentVersionstringOptional
Current version of cloudlink.
isInitializedbooleanOptional

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

needToBeUpgradedbooleanOptional

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

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

Response

OK

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error