Net3 API Interface for Customer Portal

<back to all web services

ComputeVmNetworks

Requires Authentication
The following routes are available for this service:
PUT/compute/vm/networkConnection
ComputeVmNetworks Parameters:
NameParameterData TypeRequiredDescription
vmidbodystringNo
appbodyAppNo

Allowable Values

  • Acronis
  • AcronisSCS
  • Actifio
  • AWSEC2
  • Billing
  • ChargebackManager
  • GoogleCloudPlatform
  • N3TLoginPortal
  • Onboarding
  • vCloudDirector
  • Zerto
  • ZertoCloudManager
  • MicrosoftAzure
  • ConnectWise
  • Auvik
  • Veeam
  • VROPSMetering
  • Keycloak
  • N3tApi
datacenterLocationbodyDatacenterLocationsNo

Allowable Values

  • ACD
  • GMU
  • SPA
  • LAS
  • DEV
  • VCD
  • AWS
  • GCP
  • UAT
  • AZU
  • CNW
  • AUV
  • ATL
  • EXT
networkConnectionSectionbodyNetworkConnectionSectionNo
ComputeBase Parameters:
NameParameterData TypeRequiredDescription
userIdformstringNo
loginsformList<TypeLogin>No
sessionIdformstringNo
TypeLogin Parameters:
NameParameterData TypeRequiredDescription
MembershipIdformintNo
UserIdformGuidNo
UsernameformstringNo
PasswordformstringNo
DatacenterURLformstringNo
LocationTypeformstringNo
LocationformstringNo
DatacenterLocationformDatacenterLocationsNo
ApplicationNameformstringNo
ApplicationIdformGuidNo
ApplicationLocationIdformGuidNo
CompanyNameformstringNo
CompanyIdformGuidNo
StatusformintNo
RightsformList<string>No
SessionIdformstringNo
RolesformList<string>No
PermissionsformList<string>No
AttributesformList<TypeMembershipAttribute>No
UseTwoFactorAuthformboolNo
PresharedKeyformstringNo
PasscodeformstringNo
IdformstringNo
FirstNameformstringNo
LastNameformstringNo
DatacenterLocations Enum:
GMU
SPA
LAS
DEV
VCD
AWS
GCP
UAT
AZU
AUV
ATL
TypeMembershipAttribute Parameters:
NameParameterData TypeRequiredDescription
AttributeTypeformstringNo
AttributeValueformstringNo
AttributeDataTypeformstringNo
App Enum:
Acronis
AcronisSCS
Actifio
AWSEC2
Billing
ChargebackManager
GoogleCloudPlatform
N3TLoginPortal
Onboarding
vCloudDirector
Zerto
ZertoCloudManager
MicrosoftAzure
ConnectWise
Auvik
Veeam
VROPSMetering
Keycloak
N3tApi
DatacenterLocations Enum:
ACD
GMU
SPA
LAS
DEV
VCD
AWS
GCP
UAT
AZU
CNW
AUV
ATL
EXT
NetworkConnectionSection Parameters:
NameParameterData TypeRequiredDescription
InfoformstringNo
PrimaryNetworkConnectionIndexformintNo
NetworkConnectionformNetworkConnectionNo
LinkformLinkTypeNo
requiredformboolNo
hrefformstringNo
typeformstringNo
NetworkConnection Parameters:
NameParameterData TypeRequiredDescription
NetworkConnectionIndexformintNo
IpAddressformstringNo
ExternalIpAddressformstringNo
IsConnectedformboolNo
MACAddressformstringNo
IpAddressAllocationModeformstringNo
needsCustomizationformboolNo
networkformstringNo
LinkType Parameters:
NameParameterData TypeRequiredDescription
hrefformstringNo
idformstringNo
typeformstringNo
nameformstringNo
relformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /compute/vm/networkConnection HTTP/1.1 
Host: n3tapi.palmettovdc.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	vmid: String,
	app: Acronis,
	datacenterLocation: ACD,
	networkConnectionSection: 
	{
		info: String,
		primaryNetworkConnectionIndex: 0,
		networkConnection: 
		{
			networkConnectionIndex: 0,
			ipAddress: String,
			externalIpAddress: String,
			isConnected: False,
			macAddress: String,
			ipAddressAllocationMode: String,
			needsCustomization: False,
			network: String
		},
		link: 
		{
			href: String,
			id: String,
			type: String,
			name: String,
			rel: String
		},
		required: False,
		href: String,
		type: String
	},
	userId: String,
	logins: 
	[
		{
			membershipId: 0,
			userId: 00000000000000000000000000000000,
			username: String,
			password: String,
			datacenterURL: String,
			locationType: String,
			location: String,
			datacenterLocation: GMU,
			applicationName: String,
			applicationId: 00000000000000000000000000000000,
			applicationLocationId: 00000000000000000000000000000000,
			companyName: String,
			companyId: 00000000000000000000000000000000,
			status: 0,
			rights: 
			[
				String
			],
			sessionId: String,
			roles: 
			[
				String
			],
			permissions: 
			[
				String
			],
			attributes: 
			[
				{
					attributeType: String,
					attributeValue: String,
					attributeDataType: String
				}
			],
			useTwoFactorAuth: False,
			presharedKey: String,
			passcode: String,
			id: String,
			firstName: String,
			lastName: String
		}
	],
	sessionId: String
}