Net3 API Interface for Customer Portal

Compute

The following routes are available for this service:
POST	/compute	Retrieve all Compute assets for the provided UserId

**Compute** Parameters:
Name	Parameter	Data Type	Required	Description
userId	body	string	Yes	The UserId in GUID format to retrieve compute assets for.
correlationId	body	Guid?	No	The correlationid for the metrics stats associated with the userid

**ComputeResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Result	form	TypeCompute	No
ResponseStatus	form	ResponseStatus	No

**TypeCompute** Parameters:
Name	Parameter	Data Type	Required
result	form	List<TypeVDC>	No
CountVDCs	form	int	No
CountVApps	form	int	No
CountVMs	form	int	No

**TypeVDC** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
AllocationModel	form	string	No
Href	form	string	No
Id	form	string	No
Type	form	string	No
DatacenterLocation	form	DatacenterLocations	No
VApps	form	List<TypeVApp>	No
VAppsCount	form	int	No
VMCount	form	int	No
OrgName	form	string	No
isEnabled	form	bool	No
isEnabledSpecified	form	bool	No
cpuAllocationMhz	form	long	No
cpuAllocationMhzSpecified	form	bool	No
cpuLimitMhz	form	long	No
cpuLimitMhzSpecified	form	bool	No
cpuUsedMhz	form	long	No
cpuUsedMhzSpecified	form	bool	No
memoryAllocationMB	form	long	No
memoryAllocationMBSpecified	form	bool	No
memoryLimitMB	form	long	No
memoryLimitMBSpecified	form	bool	No
memoryUsedMB	form	long	No
memoryUsedMBSpecified	form	bool	No
storageAllocationMB	form	long	No
storageAllocationMBSpecified	form	bool	No
storageLimitMB	form	long	No
storageLimitMBSpecified	form	bool	No
storageUsedMB	form	long	No
storageUsedMBSpecified	form	bool	No
NetworkQuota	form	int	No
UsedNetworkQuota	form	int	No
NicQuota	form	int	No
VmQuota	form	int	No
StorageProfiles	form	List<TypeStorageProfile>	No
Networks	form	List<TypeNetworkConfiguration>	No
EdgeGateways	form	List<TypeEdgeGateway>	No
Region	form	string	No

**DatacenterLocations** Enum:
GMU
SPA
LAS
DEV
VCD
AWS
GCP
UAT
AZU
AUV
ATL

**TypeVApp** Parameters:
Name	Parameter	Data Type	Required
href	form	string	No
id	form	string	No
name	form	string	No
type	form	string	No
DatacenterLocation	form	DatacenterLocations	No
vms	form	List<TypeVM>	No
VMsCount	form	int	No
cpuAllocationMhz	form	int	No
creationDate	form	DateTime	No
isBusy	form	bool	No
isDeployed	form	bool	No
isEnabled	form	bool	No
isExpired	form	bool	No
isInMaintenanceMode	form	bool	No
isVdcEnabled	form	bool	No
memoryAllocationMB	form	int	No
numberOfVMs	form	int	No
org	form	string	No
ownerName	form	string	No
status	form	string	No
storageKB	form	long	No
storageKBSpecified	form	bool	No
vdc	form	string	No
vdcName	form	string	No

**TypeVM** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
NameLong	form	string	No
Status	form	string	No
CPU	form	int	No
Memory	form	ulong	No
DiskSize	form	List<ulong>	No
Href	form	string	No
Id	form	string	No
DiskCount	form	int	No
catalogName	form	string	No
container	form	string	No
containerName	form	string	No
guestOs	form	string	No
hardwareVersion	form	int	No
hardwareVersionSpecified	form	bool	No
isBusy	form	bool	No
isBusySpecified	form	bool	No
isDeleted	form	bool	No
isDeletedSpecified	form	bool	No
isDeployed	form	bool	No
isDeployedSpecified	form	bool	No
isInMaintenanceMode	form	bool	No
isInMaintenanceModeSpecified	form	bool	No
isPublished	form	bool	No
isPublishedSpecified	form	bool	No
isVAppTemplate	form	bool	No
isVAppTemplateSpecified	form	bool	No
memoryMB	form	int	No
memoryMBSpecified	form	bool	No
numberOfCpus	form	int	No
numberOfCpusSpecified	form	bool	No
storageProfileName	form	string	No
vdc	form	string	No
hasDR	form	bool	No
isDRActive	form	bool	No
CpuHotAddEnabledSpecified	form	bool	No
CpuHotAddEnabled	form	bool	No
MemoryHotAddEnabledSpecified	form	bool	No
MemoryHotAddEnabled	form	bool	No
vmToolsVersion	form	int	No
vmToolsVersionSpecified	form	bool	No
vc	form	string	No
moref	form	string	No
hostName	form	string	No
vmHostType	form	string	No
networkInfoRaw	form	string	No
vmInstanceType	form	string	No
Metric	form	SimpleMetricType[]	No
Disks	form	List<TypeDisk>	No
Nics	form	List<TypeNic>	No
NetworkConnectionSection	form	NetworkConnectionSection	No

**ResponseBase** Parameters:
Name	Parameter	Data Type	Required
Content	form	string	No
errorMessage	form	string	No
errorCode	form	int	No
errorStatus	form	bool	No

**SimpleMetricType** Parameters:
Name	Parameter	Data Type	Required
name	form	string	No
unit	form	string	No
value	form	decimal	No

**TypeDisk** Parameters:
Name	Parameter	Data Type	Required
autoDelete	form	bool	No
boot	form	bool	No
deviceName	form	string	No
index	form	int	No
interface__	form	string	No
kind	form	string	No
licenses	form	string[]	No
mode	form	string	No
source	form	string	No
type	form	string	No
size	form	ulong	No

**TypeNic** Parameters:
Name	Parameter	Data Type	Required
VMId	form	string	No
VMName	form	string	No
NicId	form	string	No
NicName	form	string	No
IsConnected	form	bool	No
NetworkName	form	string	No
NetworkId	form	string	No
IsPrimaryNic	form	bool	No
IPMode	form	string	No
IPAddress	form	string	No
MacAddress	form	string	No
NetworkAdapterType	form	string	No

**NetworkConnectionSection** Parameters:
Name	Parameter	Data Type	Required
Info	form	string	No
PrimaryNetworkConnectionIndex	form	int	No
NetworkConnection	form	NetworkConnection	No
Link	form	LinkType	No
required	form	bool	No
href	form	string	No
type	form	string	No

**NetworkConnection** Parameters:
Name	Parameter	Data Type	Required
NetworkConnectionIndex	form	int	No
IpAddress	form	string	No
ExternalIpAddress	form	string	No
IsConnected	form	bool	No
MACAddress	form	string	No
IpAddressAllocationMode	form	string	No
needsCustomization	form	bool	No
network	form	string	No

**LinkType** Parameters:
Name	Parameter	Data Type	Required
href	form	string	No
id	form	string	No
type	form	string	No
name	form	string	No
rel	form	string	No

**TypeStorageProfile** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
AllocationModel	form	string	No
Href	form	string	No
Id	form	string	No
Limit	form	long	No
StorageUsedMB	form	long	No
VDCName	form	string	No

**TypeNetworkConfiguration** Parameters:
Name	Parameter	Data Type	Required
href	form	string	No
id	form	string	No
name	form	string	No
type	form	string	No
Description	form	string	No
Configuration	form	Configuration	No
ProviderInfo	form	string	No

**Configuration** Parameters:
Name	Parameter	Data Type	Required
IpScopes	form	List<IpScope>	No
FenceMode	form	string	No
RetainNetInfoAcrossDeployments	form	bool	No
BackwardCompatibilityMode	form	bool	No
SubInterface	form	bool	No
DistributedInterface	form	bool	No
GuestVlanAllowed	form	bool	No
Connected	form	bool	No
DualStackNetwork	form	bool	No

**IpScope** Parameters:
Name	Parameter	Data Type	Required
IsInherited	form	bool	No
Gateway	form	string	No
Netmask	form	string	No
Dns1	form	string	No
Dns2	form	string	No
DnsSuffix	form	string	No
IsEnabled	form	bool	No
IpRanges	form	List<IpRange>	No

**IpRange** Parameters:
Name	Parameter	Data Type	Required	Description
StartAddress	form	string	No
EndAddress	form	string	No

**TypeEdgeGateway** Parameters:
Name	Parameter	Data Type	Required
id	form	string	No
href	form	string	No
name	form	string	No
status	form	int	No
type	form	string	No
Description	form	string	No
GatewayBackingRef	form	GatewayBackingRef	No
Configuration	form	Configuration	No

**GatewayBackingRef** Parameters:
Name	Parameter	Data Type	Required	Description
gatewayId	form	string	No
VCRef	form	VCRef	No

**VCRef** Parameters:
Name	Parameter	Data Type	Required
id	form	string	No
name	form	string	No
type	form	string	No

**Configuration** Parameters:
Name	Parameter	Data Type	Required
GatewayBackingConfig	form	string	No
GatewayInterfaces	form	List<GatewayInterface>	No
EdgeGatewayServiceConfiguration	form	EdgeGatewayServiceConfiguration	No
HaEnabled	form	bool	No
UseDefaultRouteForDnsRelay	form	bool	No
AdvancedNetworkingEnabled	form	bool	No
DistributedRoutingEnabled	form	bool	No
FipsModeEnabled	form	bool	No
BackwardCompatibilityMode	form	bool	No

**GatewayInterface** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
DisplayName	form	string	No
Network	form	Network	No
InterfaceType	form	string	No
SubnetParticipation	form	SubnetParticipation	No
ApplyRateLimit	form	bool	No
InRateLimit	form	decimal	No
OutRateLimit	form	decimal	No
UseForDefaultRoute	form	bool	No

**Network** Parameters:
Name	Parameter	Data Type	Required	Description
datacenterLocation	form	DatacenterLocations	No	Allowable Values GMU SPA LAS DEV VCD AWS GCP UAT AZU AUV ATL

**NetworkBase** Parameters:
Name	Parameter	Data Type	Required	Description
userId	form	string	No

**SubnetParticipation** Parameters:
Name	Parameter	Data Type	Required
Gateway	form	string	No
Netmask	form	string	No
IpAddress	form	string	No
IpRanges	form	List<IpRange>	No
ApplyRateLimit	form	bool	No
InRateLimit	form	decimal	No
OutRateLimit	form	decimal	No

**EdgeGatewayServiceConfiguration** Parameters:
Name	Parameter	Data Type	Required
FirewallService	form	FirewallService	No
NatService	form	NatService	No
GatewayIpsecVpnService	form	GatewayIpsecVpnService	No

**FirewallService** Parameters:
Name	Parameter	Data Type	Required
IsEnabled	form	bool	No
DefaultAction	form	string	No
LogDefaultAction	form	bool	No
FirewallRules	form	List<FirewallRule>	No

**FirewallRule** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
IsEnabled	form	bool	No
MatchOnTranslate	form	bool	No
Description	form	string	No
Policy	form	string	No
Protocols	form	List<Proctocol>	No
Port	form	int	No
DestinationPortRange	form	string	No
DestinationIp	form	string	No
SourcePort	form	int	No
SourcePortRange	form	string	No
SourceIp	form	string	No
EnableLogging	form	bool	No

**Proctocol** Parameters:
Name	Parameter	Data Type	Required	Description
Name	form	string	No
IsEnabled	form	bool	No

**NatService** Parameters:
Name	Parameter	Data Type	Required
IsEnabled	form	bool	No
NatType	form	string	No
Policy	form	string	No
NatRules	form	List<NatRule>	No

**NatRule** Parameters:
Name	Parameter	Data Type	Required
Description	form	string	No
RuleType	form	string	No
IsEnabled	form	bool	No
GatewayNatRule	form	GatewayNatRule	No

**GatewayNatRule** Parameters:
Name	Parameter	Data Type	Required
Interface	form	Interface	No
OriginalIp	form	string	No
OriginalPort	form	string	No
TranslatedIp	form	string	No
TranslatedPort	form	string	No
Protocol	form	string	No
IcmpSubType	form	string	No

**Interface** Parameters:
Name	Parameter	Data Type	Required
href	form	string	No
id	form	string	No
type	form	string	No
name	form	string	No

**GatewayIpsecVpnService** Parameters:
Name	Parameter	Data Type	Required	Description
IsEnabled	form	bool	No
Tunnels	form	List<Tunnel>	No

**Tunnel** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
Description	form	string	No
IpsecVpnThirdPartyPeer	form	IpsecVpnThirdPartyPeer	No
PeerIpAddress	form	string	No
PeerId	form	string	No
LocalIpAddress	form	string	No
LocalId	form	string	No
LocalSubnets	form	List<Subnet>	No
PeerSubnets	form	List<Subnet>	No
SharedSecret	form	string	No
SharedSecretEncrypted	form	string	No
EncryptionProtocol	form	string	No
Mtu	form	string	No
IsEnabled	form	bool	No
IsOperational	form	bool	No

**IpsecVpnThirdPartyPeer** Parameters:
Name	Parameter	Data Type	Required	Description
PeerId	form	string	No

**Subnet** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
Gateway	form	string	No
Netmask	form	string	No

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.

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

{
	userId: String,
	correlationId: 00000000000000000000000000000000
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	result: 
	{
		result: 
		[
			{
				name: String,
				allocationModel: String,
				href: String,
				id: String,
				type: String,
				datacenterLocation: GMU,
				vApps: 
				[
					{
						href: String,
						id: String,
						name: String,
						type: String,
						datacenterLocation: GMU,
						vms: 
						[
							{
								name: String,
								nameLong: String,
								status: String,
								cpu: 0,
								memory: 0,
								diskSize: 
								[
									0
								],
								href: String,
								id: String,
								diskCount: 1,
								catalogName: String,
								container: String,
								containerName: String,
								guestOs: String,
								hardwareVersion: 0,
								hardwareVersionSpecified: False,
								isBusy: False,
								isBusySpecified: False,
								isDeleted: False,
								isDeletedSpecified: False,
								isDeployed: False,
								isDeployedSpecified: False,
								isInMaintenanceMode: False,
								isInMaintenanceModeSpecified: False,
								isPublished: False,
								isPublishedSpecified: False,
								isVAppTemplate: False,
								isVAppTemplateSpecified: False,
								memoryMB: 0,
								memoryMBSpecified: False,
								numberOfCpus: 0,
								numberOfCpusSpecified: False,
								storageProfileName: String,
								vdc: String,
								hasDR: False,
								isDRActive: False,
								cpuHotAddEnabledSpecified: False,
								cpuHotAddEnabled: False,
								memoryHotAddEnabledSpecified: False,
								memoryHotAddEnabled: False,
								vmToolsVersion: 0,
								vmToolsVersionSpecified: False,
								vc: String,
								moref: String,
								hostName: String,
								vmHostType: String,
								networkInfoRaw: String,
								vmInstanceType: String,
								metric: 
								[
									{
										name: String,
										unit: String,
										value: 0
									}
								],
								disks: 
								[
									{
										autoDelete: False,
										boot: False,
										deviceName: String,
										index: 0,
										interface__: String,
										kind: String,
										licenses: 
										[
											String
										],
										mode: String,
										source: String,
										type: String,
										size: 0,
										content: String,
										errorMessage: String,
										errorCode: 0,
										errorStatus: False
									}
								],
								nics: 
								[
									{
										vmId: String,
										vmName: String,
										nicId: String,
										nicName: String,
										isConnected: False,
										networkName: String,
										networkId: String,
										isPrimaryNic: False,
										ipMode: String,
										ipAddress: String,
										macAddress: String,
										networkAdapterType: String,
										content: String,
										errorMessage: String,
										errorCode: 0,
										errorStatus: False
									}
								],
								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
								},
								content: String,
								errorMessage: String,
								errorCode: 0,
								errorStatus: False
							}
						],
						vMsCount: 1,
						cpuAllocationMhz: 0,
						creationDate: 0001-01-01,
						isBusy: False,
						isDeployed: False,
						isEnabled: False,
						isExpired: False,
						isInMaintenanceMode: False,
						isVdcEnabled: False,
						memoryAllocationMB: 0,
						numberOfVMs: 0,
						org: String,
						ownerName: String,
						status: String,
						storageKB: 0,
						storageKBSpecified: False,
						vdc: String,
						vdcName: String
					}
				],
				vAppsCount: 1,
				vmCount: 1,
				orgName: String,
				isEnabled: False,
				isEnabledSpecified: False,
				cpuAllocationMhz: 0,
				cpuAllocationMhzSpecified: False,
				cpuLimitMhz: 0,
				cpuLimitMhzSpecified: False,
				cpuUsedMhz: 0,
				cpuUsedMhzSpecified: False,
				memoryAllocationMB: 0,
				memoryAllocationMBSpecified: False,
				memoryLimitMB: 0,
				memoryLimitMBSpecified: False,
				memoryUsedMB: 0,
				memoryUsedMBSpecified: False,
				storageAllocationMB: 0,
				storageAllocationMBSpecified: False,
				storageLimitMB: 0,
				storageLimitMBSpecified: False,
				storageUsedMB: 0,
				storageUsedMBSpecified: False,
				networkQuota: 0,
				usedNetworkQuota: 0,
				nicQuota: 0,
				vmQuota: 0,
				storageProfiles: 
				[
					{
						name: String,
						allocationModel: String,
						href: String,
						id: String,
						limit: 0,
						storageUsedMB: 0,
						vdcName: String
					}
				],
				networks: 
				[
					{
						href: String,
						id: String,
						name: String,
						type: String,
						description: String,
						configuration: 
						{
							ipScopes: 
							[
								{
									isInherited: False,
									gateway: String,
									netmask: String,
									dns1: String,
									dns2: String,
									dnsSuffix: String,
									isEnabled: False,
									ipRanges: 
									[
										{
											startAddress: String,
											endAddress: String
										}
									]
								}
							],
							fenceMode: String,
							retainNetInfoAcrossDeployments: False,
							backwardCompatibilityMode: False,
							subInterface: False,
							distributedInterface: False,
							guestVlanAllowed: False,
							connected: False,
							dualStackNetwork: False
						},
						providerInfo: String
					}
				],
				edgeGateways: 
				[
					{
						id: String,
						href: String,
						name: String,
						status: 0,
						type: String,
						description: String,
						gatewayBackingRef: 
						{
							gatewayId: String,
							vcRef: 
							{
								id: String,
								name: String,
								type: String
							}
						},
						configuration: 
						{
							gatewayBackingConfig: String,
							gatewayInterfaces: 
							[
								{
									name: String,
									displayName: String,
									network: 
									{
										href: String,
										name: String,
										type: String
									},
									interfaceType: String,
									subnetParticipation: 
									{
										gateway: String,
										netmask: String,
										ipAddress: String,
										ipRanges: 
										[
											{
												startAddress: String,
												endAddress: String
											}
										],
										applyRateLimit: False,
										inRateLimit: 0,
										outRateLimit: 0
									},
									applyRateLimit: False,
									inRateLimit: 0,
									outRateLimit: 0,
									useForDefaultRoute: False
								}
							],
							edgeGatewayServiceConfiguration: 
							{
								firewallService: 
								{
									isEnabled: False,
									defaultAction: String,
									logDefaultAction: False,
									firewallRules: 
									[
										{
											id: 0,
											isEnabled: False,
											matchOnTranslate: False,
											description: String,
											policy: String,
											protocols: 
											[
												{
													name: String,
													isEnabled: False
												}
											],
											port: 0,
											destinationPortRange: String,
											destinationIp: String,
											sourcePort: 0,
											sourcePortRange: String,
											sourceIp: String,
											enableLogging: False
										}
									]
								},
								natService: 
								{
									isEnabled: False,
									natType: String,
									policy: String,
									natRules: 
									[
										{
											description: String,
											ruleType: String,
											isEnabled: False,
											gatewayNatRule: 
											{
												interface: 
												{
													href: String,
													id: String,
													type: String,
													name: String
												},
												originalIp: String,
												originalPort: String,
												translatedIp: String,
												translatedPort: String,
												protocol: String,
												icmpSubType: String
											}
										}
									]
								},
								gatewayIpsecVpnService: 
								{
									isEnabled: False,
									tunnels: 
									[
										{
											name: String,
											description: String,
											ipsecVpnThirdPartyPeer: 
											{
												peerId: String
											},
											peerIpAddress: String,
											peerId: String,
											localIpAddress: String,
											localId: String,
											localSubnets: 
											[
												{
													name: String,
													gateway: String,
													netmask: String
												}
											],
											peerSubnets: 
											[
												{
													name: String,
													gateway: String,
													netmask: String
												}
											],
											sharedSecret: String,
											sharedSecretEncrypted: String,
											encryptionProtocol: String,
											mtu: String,
											isEnabled: False,
											isOperational: False
										}
									]
								}
							},
							haEnabled: False,
							useDefaultRouteForDnsRelay: False,
							advancedNetworkingEnabled: False,
							distributedRoutingEnabled: False,
							fipsModeEnabled: False,
							backwardCompatibilityMode: False
						}
					}
				],
				region: String
			}
		],
		countVDCs: 1,
		countVApps: 1,
		countVMs: 1
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}

Net3 API Interface for Customer Portal

Compute

Allowable Values

HTTP + JSV