Net3 API Interface for Customer Portal

<back to all web services

ComputePowerToggle

Requires Authentication
The following routes are available for this service:
POST/compute/powerToggle the power status of the compute object
ComputePowerToggle Parameters:
NameParameterData TypeRequiredDescription
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
computeTypebodyTypeComputeObjectNo

Allowable Values

  • vm
  • vapp
  • vdc
  • template
powerStatusbodyPowerStatusNo

Allowable Values

  • OFF
  • ON
  • SHUTDOWN
  • SUSPEND
  • RESTART
  • RESUME
idbodystringNo
zonebodystringNo
projectbodystringNo
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
TypeComputeObject Enum:
vm
vapp
vdc
template
PowerStatus Enum:
NameValue
OFF0
ON1
SHUTDOWN3
SUSPEND4
RESTART5
RESUME6

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

HTTP + XML

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

POST /compute/power HTTP/1.1 
Host: n3tapi.palmettovdc.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ComputePowerToggle xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/N3TAPI.Services">
  <logins xmlns:d2p1="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">
    <d2p1:TypeLogin>
      <d2p1:_x003C_ApplicationId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_ApplicationId_x003E_k__BackingField>
      <d2p1:_x003C_ApplicationLocationId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_ApplicationLocationId_x003E_k__BackingField>
      <d2p1:_x003C_ApplicationName_x003E_k__BackingField>String</d2p1:_x003C_ApplicationName_x003E_k__BackingField>
      <d2p1:_x003C_Attributes_x003E_k__BackingField>
        <d2p1:TypeMembershipAttribute>
          <d2p1:AttributeDataType>String</d2p1:AttributeDataType>
          <d2p1:AttributeType>String</d2p1:AttributeType>
          <d2p1:AttributeValue>String</d2p1:AttributeValue>
        </d2p1:TypeMembershipAttribute>
      </d2p1:_x003C_Attributes_x003E_k__BackingField>
      <d2p1:_x003C_CompanyId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_CompanyId_x003E_k__BackingField>
      <d2p1:_x003C_CompanyName_x003E_k__BackingField>String</d2p1:_x003C_CompanyName_x003E_k__BackingField>
      <d2p1:_x003C_DatacenterLocation_x003E_k__BackingField>GMU</d2p1:_x003C_DatacenterLocation_x003E_k__BackingField>
      <d2p1:_x003C_DatacenterURL_x003E_k__BackingField>String</d2p1:_x003C_DatacenterURL_x003E_k__BackingField>
      <d2p1:_x003C_FirstName_x003E_k__BackingField>String</d2p1:_x003C_FirstName_x003E_k__BackingField>
      <d2p1:_x003C_Id_x003E_k__BackingField>String</d2p1:_x003C_Id_x003E_k__BackingField>
      <d2p1:_x003C_LastName_x003E_k__BackingField>String</d2p1:_x003C_LastName_x003E_k__BackingField>
      <d2p1:_x003C_LocationType_x003E_k__BackingField>String</d2p1:_x003C_LocationType_x003E_k__BackingField>
      <d2p1:_x003C_Location_x003E_k__BackingField>String</d2p1:_x003C_Location_x003E_k__BackingField>
      <d2p1:_x003C_MembershipId_x003E_k__BackingField>0</d2p1:_x003C_MembershipId_x003E_k__BackingField>
      <d2p1:_x003C_Passcode_x003E_k__BackingField>String</d2p1:_x003C_Passcode_x003E_k__BackingField>
      <d2p1:_x003C_Password_x003E_k__BackingField>String</d2p1:_x003C_Password_x003E_k__BackingField>
      <d2p1:_x003C_Permissions_x003E_k__BackingField xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:_x003C_Permissions_x003E_k__BackingField>
      <d2p1:_x003C_PresharedKey_x003E_k__BackingField>String</d2p1:_x003C_PresharedKey_x003E_k__BackingField>
      <d2p1:_x003C_Rights_x003E_k__BackingField xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:_x003C_Rights_x003E_k__BackingField>
      <d2p1:_x003C_Roles_x003E_k__BackingField xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:_x003C_Roles_x003E_k__BackingField>
      <d2p1:_x003C_SessionId_x003E_k__BackingField>String</d2p1:_x003C_SessionId_x003E_k__BackingField>
      <d2p1:_x003C_Status_x003E_k__BackingField>0</d2p1:_x003C_Status_x003E_k__BackingField>
      <d2p1:_x003C_UseTwoFactorAuth_x003E_k__BackingField>false</d2p1:_x003C_UseTwoFactorAuth_x003E_k__BackingField>
      <d2p1:_x003C_UserId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_UserId_x003E_k__BackingField>
      <d2p1:_x003C_Username_x003E_k__BackingField>String</d2p1:_x003C_Username_x003E_k__BackingField>
    </d2p1:TypeLogin>
  </logins>
  <sessionId>String</sessionId>
  <userId>String</userId>
  <app>Acronis</app>
  <computeType>vm</computeType>
  <datacenterLocation>ACD</datacenterLocation>
  <id>String</id>
  <powerStatus>OFF</powerStatus>
  <project>String</project>
  <zone>String</zone>
</ComputePowerToggle>