Net3 API Interface for Customer Portal

<back to all web services

ComputePower

Requires Authentication
The following routes are available for this service:
POST/compute/datacenter/{datacenterLocation}/org/{subscriptionId}/resourcegroup/{resourceGroup}/vm/{vmName}/power/{powerStatus}Enact the desired Power Status change on the VM
ComputePower Parameters:
NameParameterData TypeRequiredDescription
datacenterLocationpathDatacenterLocationsNo

Allowable Values

  • ACD
  • GMU
  • SPA
  • LAS
  • DEV
  • VCD
  • AWS
  • GCP
  • UAT
  • AZU
  • CNW
  • AUV
  • ATL
  • EXT
vmNamepathstringNo
powerStatuspathPowerStatusNo

Allowable Values

  • OFF
  • ON
  • SHUTDOWN
  • SUSPEND
  • RESTART
  • RESUME
subscriptionIdpathstringNo
resourceGrouppathstringNo
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
DatacenterLocations Enum:
ACD
GMU
SPA
LAS
DEV
VCD
AWS
GCP
UAT
AZU
CNW
AUV
ATL
EXT
PowerStatus Enum:
NameValue
OFF0
ON1
SHUTDOWN3
SUSPEND4
RESTART5
RESUME6

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /compute/datacenter/{datacenterLocation}/org/{subscriptionId}/resourcegroup/{resourceGroup}/vm/{vmName}/power/{powerStatus} HTTP/1.1 
Host: n3tapi.palmettovdc.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"datacenterLocation":"ACD","vmName":"String","powerStatus":"OFF","subscriptionId":"String","resourceGroup":"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"}