Below you will find a current list of the available methods on our CenturyLink Cloud API. If you need help or support, please head over to our Knowledge Base or Getting Started pages.

The calling conventions for the REST API is to send a POST request to the URL of the given method (e.g. https://api.ctl.io/REST/VirtualServer/CreateServer/FORMAT where FORMAT is either XML or JSON). In addition, the content type of the HTTP request must be set as well to either text/xml for XML requests, or application/json; charset=utf-8 for JSON requests. The combination of the format node and the Content Type will determine how the request is interpreted as well as control what format the responses are returned.

The SOAP based API supports the same features as the REST API, and while the request and response messages are essentially identical to those of the REST API, you will want to pull down the WSDL for each API to verify the details. URL's to each API's SOAP WSDL can be found on the individual API pages.

All requests will receive a response (in either JSON or XML format) with at least the following three attributes:

Attributes

Many API calls will also return additional information which will be described in detail.

Authentication for the Public API will be handled differently than the CenturyLink Cloud Control System, To create an API user you must access the Control Portal and create an API user here. The credentials for the API consist of a string based API key and a password.

Prior to calling into the API, consumers must first call into the Authentication API to Logon. On successful login, the API will write a persistent cookie as part of its response. The encrypted cookie will be evaluated as part of each subsequent request, this will prevent the need of providing credentials with each API call.

The URL to the SOAP version of the Authentication API can be found at https://api.ctl.io/soap/auth.asmx and the WSDL can be found here.

For a complete walkthrough of the authentication process with the REST/HTTP API, see Using the HTTP API to Log In and Query Servers.

Authentication API Methods

• Logon
• Logout

This method is required to be called prior to calling any other method exposed by the CenturyLink Cloud API. This method validates your credentials and writes the Encrypted cookie required to be present for all subsequent calls into the API.

URL

REST: https://api.ctl.io/REST/Auth/Logon/

Request

Attributes

Examples

XML

<LogonRequest>
  <APIKey>apikey</APIKey>
  <Password>password</Password>
</LogonRequest>

JSON

{
  "APIKey":"apikey",
  "Password":"password"
}

Response

Attributes

Examples

XML

<LogonResponse Success="true" Message="Login Successful" StatusCode="0" />

JSON

{
  "Success":true,
  "Message":"Login Successful",
  "StatusCode":0
}

Status Codes

This method will log you out of the API. The Logon method must be called again prior to accessing the API again.

URL

REST: https://api.ctl.io/REST/Auth/Logout/

Request

Attributes

None Required.

Status Codes

Create a brand new (sub) account in the system. Calls to this operation must include an authorization cookie acquired from the Logon operation.

URL

REST: https://api.ctl.io/REST/Account/CreateAccount/<format> (format = XML | JSON)
SOAP: https://api.ctl.io/SOAP/Account.asmx?op=CreateAccount

Request

Attributes

Examples

JSON (REST)

{
  "ParentAlias":"1000",
  "AccountAlias":"1001",
  "Location":"WA1",
  "BusinessName":"Demo Biz",
  "Address1":"110 110th Avenue",
  "Address2":null,
  "City":"Bellevue",
  "StateProvince":"WA",
  "PostalCode":"98004",
  "Country":"USA",
  "Telephone":"877-388-4373",
  "Fax":null,
  "TimeZone":"Pacific Standard Time",
  "ShareParentNetworks":"true",
  "BillingResponsibilityID":"2"
}

XML (REST)

<CreateAccountRequest>
  <ParentAlias>1000</ParentAlias>
  <AccountAlias>1001</AccountAlias>
  <Location>QA1</Location>
  <BusinessName>Demo Biz</BusinessName>
  <Address1>110 110th Avenue</Address1>
  <Address2>Suite 520</Address2>
  <City>Bellevue</City>
  <StateProvince>WA</StateProvince>
  <PostalCode>98004</PostalCode>
  <Country>USA</Country>
  <Telephone>877-388-4373</Telephone>
  <Fax></Fax>
  <TimeZone>Pacific Standard Time</TimeZone>
  <ShareParentNetworks>true</ShareParentNetworks>
  <BillingResponsibilityID>2</BillingResponsibilityID>
</CreateAccountRequest>

XML (SOAP)

<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                xmlns:xsd="http://www.w3.org/2001/XMLSchema"
                xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <CreateAccount xmlns="http://www.tier3.com/">
      <request>
        <ParentAlias>1000</ParentAlias>
        <AccountAlias>1001</AccountAlias>
        <Location>WA</Location>
        <BusinessName>Demo Biz</BusinessName>
        <Address1>110 110th Avenue</Address1>
        <Address2>Suite 520</Address2>
        <City>Bellevue</City>
        <StateProvince>WA</StateProvince>
        <PostalCode>98004</PostalCode>
        <Country>USA</Country>
        <Telephone>877-388-4373</Telephone>
        <Fax></Fax>
        <TimeZone>Pacific Standard Time</TimeZone>
        <ShareParentNetworks>true</ShareParentNetworks>
        <BillingResponsibilityID>2</BillingResponsibilityID>
      </request>
    </CreateAccount>
  </soap12:Body>
</soap12:Envelope>  

Response

Attributes

AccountDetails Attributes

Examples

JSON (REST)

{
  "AccountDetails": {
    "AccountAlias":"1001",
    "ParentAlias":"1000",
    "Location":"WA1",
    "BusinessName":"Demo Biz",
    "Address1":"110 110th Avenue",
    "Address2":null,
    "City":"Bellevue",
    "StateProvince":"WA",
    "PostalCode":"98004",
    "Country":"USA",
    "Telephone":"877-388-4373",
    "Fax":null,
    "TimeZone":"Pacific Standard Time",
    "Status":1,
    "ShareParentNetworks":true
  },  
  "Success":true,
  "Message":"Account successfully created.",
  "StatusCode":0
}

XML (REST)

<AccountDetailsResponse Success="true" Message="Account successfully created." StatusCode="0">
  <AccountDetails AccountAlias="1001" ParentAlias="1000" Location="WA1" TimeZone="Pacific Standard Time" Status="1" ShareParentNetworks="true">
    <BusinessName>Demo Biz</BusinessName>
    <Address1>110 110th Avenue</Address1>
    <Address2>Suite 520</Address2>
    <City>Bellevue</City>
    <StateProvince>WA</StateProvince>
    <PostalCode>98004</PostalCode>
    <Country>USA</Country>
    <Telephone>877-388-4373</Telephone>
    <Fax />
  </AccountDetails>
</AccountDetailsResponse>

XML (SOAP)

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <CreateAccountResponse xmlns="http://www.tier3.com/">
      <CreateAccountResult Success="true" Message="Account successfully created." StatusCode="0">
        <AccountDetails AccountAlias="1001" ParentAlias="1000" Location="WA1" TimeZone="Pacific Standard Time" Status="1" ShareParentNetworks="true">
          <BusinessName>Demo Biz</BusinessName>
          <Address1>110 110th Avenue</Address1>
          <Address2>Suite 520</Address2>
          <City>Bellevue</City>
          <StateProvince>WA</StateProvince>
          <PostalCode>98004</PostalCode>
          <Country>USA</Country>
          <Telephone>877-388-4373</Telephone>
          <Fax />
        </AccountDetails>
      </CreateAccountResult>
    </CreateAccountResponse>
  </soap:Body>
</soap:Envelope>

Status Codes

Valid Timezone Entries

• Dateline Standard Time
• UTC-11
• Hawaiian Standard Time
• Alaskan Standard Time
• Pacific Standard Time (Mexico)
• Pacific Standard Time
• US Mountain Standard Time
• Mountain Standard Time (Mexico)
• Mountain Standard Time
• Central America Standard Time
• Central Standard Time
• Central Standard Time(Mexico)
• Canada Central Standard Time
• SA Pacific Standard Time
• Eastern Standard Time
• US Eastern Standard Time
• Venezuela Standard Time
• Paraguay Standard Time
• Atlantic Standard Time
• Central Brazilian Standard Time
• SA Western Standard Time
• Pacific SA Standard Time
• Newfoundland Standard Time
• E. South America Standard Time
• Argentina Standard Time
• SA Eastern Standard Time
• Greenland Standard Time
• Montevideo Standard Time
• Bahia Standard Time
• UTC-02
• Mid-Atlantic Standard Time
• Azores Standard Time
• Cape Verde Standard Time
• Morocco Standard Time
• UTC
• GMT Standard Time
• Greenwich Standard Time
• W. Europe Standard Time
• Central Europe Standard Time
• Romance Standard Time
• Central European Standard Time
• W. Central Africa Standard Time
• Namibia Standard Time
• Jordan Standard Time
• GTB Standard Time
• Middle East Standard Time
• Egypt Standard Time
• Syria Standard Time
• South Africa Standard Time
• FLE Standard Time
• Turkey Standard Time
• Israel Standard Time
• E. Europe Standard Time
• Arabic Standard Time
• Kaliningrad Standard Time
• Arab Standard Time
• E. Africa Standard Time
• Iran Standard Time
• Arabian Standard Time
• Azerbaijan Standard Time
• Russian Standard Time
• Mauritius Standard Time
• Georgian Standard Time
• Caucasus Standard Time
• Afghanistan Standard Time
• Pakistan Standard Time
• West Asia Standard Time
• India Standard Time
• Sri Lanka Standard Time
• Nepal Standard Time
• Central Asia Standard Time
• Bangladesh Standard Time
• Ekaterinburg Standard Time
• Myanmar Standard Time
• SE Asia Standard Time
• N. Central Asia Standard Time
• China Standard Time
• North Asia Standard Time
• Singapore Standard Time
• W. Australia Standard Time
• Taipei Standard Time
• Ulaanbaatar Standard Time
• North Asia East Standard Time
• Tokyo Standard Time
• Korea Standard Time
• Cen. Australia Standard Time
• AUS Central Standard Time
• E. Australia Standard Time
• AUS Eastern Standard Time
• West Pacific Standard Time
• Tasmania Standard Time
• Yakutsk Standard Time
• Central Pacific Standard Time
• Vladivostok Standard Time
• New Zealand Standard Time
• UTC+12
• Fiji Standard Time
• Magadan Standard Time
• Kamchatka Standard Time
• Tonga Standard Time
• Samoa Standard Time

Enable a suspended account in the system. Calls to this operation must include an authorization cookie acquired from the Logon operation.

URL

REST: https://api.ctl.io/REST/Account/EnableAccount/<format> (format = XML | JSON)
SOAP: https://api.ctl.io/SOAP/Account.asmx?op=EnableAccount

Request

Attributes

Examples

JSON (REST)

{
  "AccountAlias": "ACCT"
}

XML (REST)

<AccountStatusRequest>
  <AccountAlias>ACCT</AccountAlias>
</AccountStatusRequest>

XML (SOAP)

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xmlns:xsd="http://www.w3.org/2001/XMLSchema"
        xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <EnableAccount xmlns="http://www.tier3.com/">
      <request>
        <AccountAlias>ACCT</AccountAlias>
      </request>
    </EnableAccount>
  </soap:Body>
</soap:Envelope>  

Response

Attributes

Examples

JSON (REST)

{
  "Success": true,
  "Message": "Account Enabled.",
  "StatusCode": 0,
  "RequestID": 100
}

XML (REST)

<QueuedItemResponse Success="true" Message="Success" StatusCode="0">
    <RequestID>1</RequestID>
</QueuedItemResponse>

XML (SOAP)

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
      <EnableAccountResponse xmlns="http://www.tier3.com/">
          <QueuedItemResponse Success="true" Message="Account Enabled." StatusCode="0">
            <ResponseID>100</ResponseID>
          </QueuedItemResponse>
      </EnableAccountResponse>
  </soap:Body>
</soap:Envelope>

Status Codes

Gets all of the contact information and settings for a given account. Calls to this operation must include an authorization cookie acquired from the Logon operation.

URL

REST: https://api.ctl.io/REST/Account/GetAccountDetails/<format> (format = XML | JSON)
SOAP: https://api.ctl.io/SOAP/Account.asmx?op=GetAccountDetails

Request

Attributes

Examples

JSON (REST)

{

  "AccountAlias": "1000"

}

XML (REST)

<GetAccountDetailsRequest>
    <AccountAlias>1000</AccountAlias>
</GetAccountDetailsRequest>

XML (SOAP)

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xmlns:xsd="http://www.w3.org/2001/XMLSchema"
        xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetAccountDetails xmlns="http://www.tier3.com/">
      <request>
         <AccountAlias>1000</AccountAlias>
      </request>
    </GetAccountDetails>
  </soap:Body>
</soap:Envelope>

Response

Attributes

AccountDetails Attributes

Examples

JSON (REST)

{
  "AccountDetails": {
    "AccountAlias":"1001",
    "ParentAlias":"1000",
    "Location":"WA1",
    "BusinessName":"Example Business Name",
    "Address1":"110 110th Avenue",
    "Address2":null,
    "City":"Bellevue",
    "StateProvince":"WA",
    "PostalCode":"98004",
    "Country":"USA",
    "Telephone":"877-388-4373",
    "Fax":null,
    "TimeZone":"Pacific Standard Time",
    "Status":2,
    "ShareParentNetworks":true
  },
  "Success":true,
  "Message":"Account details successfully queried.",
  "StatusCode":0
}

XML (REST)

<AccountDetailsResponse Success="true" Message="Account details successfully queried." StatusCode="0">
    <AccountDetails AccountAlias="1001" ParentAlias="1000" Location="WA1" TimeZone="Pacific Standard Time" Status="2" ShareParentNetworks="true">
        <BusinessName>Example Business Name</BusinessName>
        <Address1>110 110th Avenue</Address1>
        <City>Bellevue</City>
        <StateProvince>WA</StateProvince>
        <PostalCode>98004</PostalCode>
        <Country>USA</Country>
        <Telephone>877-388-4373</Telephone>
    </AccountDetails>
</AccountDetailsResponse>

XML (SOAP)

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xmlns:xsd="http://www.w3.org/2001/XMLSchema">
     <soap:Body>
        <GetAccountDetailsResponse xmlns="http://www.tier3.com/">
            <GetAccountDetailsResult Success="true" Message="Account details successfully queried." StatusCode="0">
                <AccountDetails AccountAlias="1001" ParentAlias="1000" Location="WA1" TimeZone="Pacific Standard Time" Status="2" ShareParentNetworks="true">
                    <BusinessName>Example Business Name</BusinessName>
                    <Address1>110 110th Avenue</Address1>
                    <City>Bellevue</City>
            	      <StateProvince>WA</StateProvince>
                    <PostalCode>98004</PostalCode>
                    <Country>USA</Country>
                    <Telephone>877-388-4373</Telephone>
                </AccountDetails>
            </GetAccountDetailsResult>
        </GetAccountDetailsResponse>
      </soap:Body>
</soap:Envelope>

Status Codes

Gets details of the API user's account and any sub-accounts. Calls to this operation must include an authorization cookie acquired from the Logon operation.

URL

REST: https://api.ctl.io/REST/Account/GetAccounts/<format> (format = XML | JSON)
SOAP: https://api.ctl.io/SOAP/Account.asmx?op=AccountsResponseMsg

Request

Attributes

None.

Examples

XML (SOAP)

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xmlns:xsd="http://www.w3.org/2001/XMLSchema"
      xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
    <AccountsResponseMsg xmlns="http://www.tier3.com/" />
</soap:Body>
</soap:Envelope>  

Response

Attributes

Account Attributes

Examples

JSON (REST)

{
  "Accounts":[
    {
      "AccountAlias":"1001",
      "ParentAlias":"1000",
      "Location":"WA1",
      "BusinessName":"Example Business Name",
      "IsActive":true
    },
    {
      "AccountAlias":"1002",
      "ParentAlias":"1001",
      "Location":"WA1",
      "BusinessName":"Example Department",
      "IsActive":true}
  ],
  "Success":true,
  "Message":"Accounts successfully queried.",
  "StatusCode":0
}

XML (REST)

<AccountsResponse Success="true" Message="Accounts successfully queried." StatusCode="0">
    <Accounts>
        <Account AccountAlias="1001" ParentAlias="1000" Location="WA1" BusinessName="ExampleBusiness Name" IsActive="true"/>
        <Account AccountAlias="1002" ParentAlias="1001" Location="WA1" BusinessName="Example Department" IsActive="true" />
    </Accounts>
</AccountsResponse>

XML (SOAP)

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
      <AccountsResponseMsgResponse xmlns="http://www.tier3.com/">
          <AccountsResponseMsgResult>
              <Accounts>
                  <Account AccountAlias="1001" ParentAlias="1000" Location="WA1" BusinessName="Example Business Name" IsActive="true" />
                  <Account AccountAlias="1002" ParentAlias="1001" Location="WA1" BusinessName="Example Department" IsActive="true" />
              </Accounts>
          </AccountsResponseMsgResult>
      </AccountsResponseMsgResponse>
  </soap:Body>
</soap:Envelope>

Status Codes

Gets the account custom field definitions.

URL

REST: https://api.ctl.io/REST/Account/GetCustomFields/<format> (format = XML | JSON)
SOAP: https://api.ctl.io/SOAP/Account.asmx?op=GetCustomFields

Request

Attributes

Examples

JSON

{
  "AccountAlias": "ACCT"
}

XML

<GetCustomFieldsRequest>
    <AccountAlias>ACCT</AccountAlias>
</GetCustomFieldsRequest>

Response

Attributes

AccountCustomField Attributes

Examples

JSON

{
  "AccountCustomFields": [
    {
      "ID": -1,
      "CustomFieldTypeID": -1,
      "CustomFieldType": "Text",
      "Name": "Name",
      "IsRequired": true,
      "UUID":"dba67b15-6e77-4e1f-b413-ddfa3dc4ac1d"
      "AccountCustomFieldOptions": null
    },
    {
      "ID": -1,
      "CustomFieldTypeID": -1,
      "CustomFieldType": "Option",
      "Name": "Type",
      "IsRequired": true,
      "UUID":"d61daab2-e99f-40c2-a4b5-820c3d97eea4"
      "AccountCustomFieldOptions": [
        {
          "Name": "My Type",
          "Value": "1"
        },
        {
          "Name": "Your Type",
          "Value": "2"
        }
      ]
    },
    {
      "ID": -1,
      "CustomFieldTypeID": -1,
      "CustomFieldType": "Checkbox",
      "Name": "Enabled",
      "IsRequired": true,
      "UUID": "de775088-8b94-4e9f-b64b-416623477cf8"
      "AccountCustomFieldOptions": []
    }
  ],
  "Success": true,
  "Message": "Custom Fields retrieved successfully.",
  "StatusCode": 0
}

XML

<AccountCustomFieldsResponse
  Success="true"
  Message="Custom Fields retrieved successfully."
  StatusCode="0">
    <AccountCustomFields>
        <AccountCustomField ID="-1" CustomFieldTypeID="-1" CustomFieldType="Text" Name="Name" UUID="dba67b15-6e77-4e1f-b413-ddfa3dc4ac1d" IsRequired="true" />
        <AccountCustomField ID="-1" CustomFieldTypeID="-1" CustomFieldType="Option" Name="Type" UUID="d61daab2-e99f-40c2-a4b5-820c3d97eea4" IsRequired="true">
            <AccountCustomFieldOptions Name="My Type" Value="1" />
            <AccountCustomFieldOptions Name="Your Type" Value="2" />
        </AccountCustomField>
        <AccountCustomField ID="-1" CustomFieldTypeID="-1" CustomFieldType="Checkbox" Name="Enabled" UUID="de775088-8b94-4e9f-b64b-416623477cf8" IsRequired="true" />
    </AccountCustomFields>
</AccountCustomFieldsResponse>

Status Codes

Gets list of all valid data center location codes that are used in subsequent Account operations. Calls to this operation must include an authorization cookie acquired from the Logon operation.

URL

REST: https://api.ctl.io/REST/Account/GetLocations/<format> (format = XML | JSON)
SOAP: https://api.ctl.io/SOAP/Account.asmx?op=LocationsResponseMsg

Request

Attributes

None

Examples

XML (SOAP)

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xmlns:xsd="http://www.w3.org/2001/XMLSchema"
      xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <LocationsResponseMsg xmlns="http://www.tier3.com/" />
  </soap:Body>
</soap:Envelope>

Response

Attributes

Location Attributes

Examples

JSON (REST)

{
  "Locations":[
    {
      "Alias":"100",
      "Region":"Demo Region 1"
    },
    {
      "Alias":"101",
      "Region":"Demo Region 2"
    },
    {
      "Alias":"102",
      "Region":"Demo Region 3"
    }
  ],
  "Success":true,
  "Message":"Locations successfully queried.",
  "StatusCode":0
}

XML (REST)

<LocationsResponse Success="true" Message="Locations successfully queried." StatusCode="0">
    <Locations>
        <Location Alias="100" Region="Demo Region 1" />
        <Location Alias="101" Region="Demo Region 2" />
        <Location Alias="102" Region="Demo Region 3" />
    </Locations>
</LocationsResponse>

XML (SOAP)

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <LocationsResponseMsgResponse xmlns="http://www.tier3.com/">
      <LocationsResponseMsgResult>
        <Locations>
          <Location Alias="string" Region="string" />
          <Location Alias="string" Region="string" />
        </Locations>
      </LocationsResponseMsgResult>
    </LocationsResponseMsgResponse>
  </soap:Body>
</soap:Envelope>

Status Codes

Disable an existing account in the system. Calls to this operation must include an authorization cookie acquired from the Logon operation.

URL

REST: https://api.ctl.io/REST/Account/SuspendAccount/<format> (format = XML | JSON)
SOAP: https://api.ctl.io/SOAP/Account.asmx?op=SuspendAccount

Request

Attributes

Examples

JSON (REST)

{

  "AccountAlias": "1000"

}

XML (REST)

<AccountStatusRequest>
  <AccountAlias>1000</AccountAlias>
</AccountStatusRequest>

XML (SOAP

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xmlns:xsd="http://www.w3.org/2001/XMLSchema"
        xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <SuspendAccount xmlns="http://www.tier3.com/">
      <request>
         <AccountAlias>1000</AccountAlias>
      </request>
    </SuspendAccount>
  </soap:Body>
</soap:Envelope>  

Response

Attributes

Examples

JSON (REST)

{
  "Success": true,
  "Message": "Account Suspended.",
  "StatusCode": 0,
  "RequestID": 100
}

XML (REST)

<QueuedItemResponse Success="true" Message="Account Suspended." StatusCode="0">
    <RequestID>100</RequestID>
</QueuedItemResponse>

XML (SOAP)

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
      <SuspendAccountResponse xmlns="http://www.tier3.com/">
          <QueuedItemResponse Success="true" Message="Account Suspended." StatusCode="0">
              <ResponseID>100</ResponseID>
          </QueuedItemResponse>
      </SuspendAccountResponse>
  </soap:Body>
</soap:Envelope>

Status Codes

Make changes to an existing account in the system. Calls to this operation must include an authorization cookie acquired from the Logon operation.

URL

REST: https://api.ctl.io/REST/Account/UpdateAccountDetails/<format> (format = XML | JSON)
SOAP: https://api.ctl.io/SOAP/Account.asmx?op=UpdateAccountDetails

Request

Attributes

Examples

JSON (REST)

{
  "AccountAlias":"1001",
  "BusinessName":"Demo Biz",
  "Address1":"110 110th Avenue",
  "Address2":null,
  "City":"Bellevue",
  "StateProvince":"WA",
  "PostalCode":"98004",
  "Country":"USA",
  "Telephone":"877-388-4373",
  "Fax":null,
  "TimeZone":"Pacific Standard Time",
  "ShareParentNetworks":"true"
}

XML (REST)

<UpdateAccountDetailsRequest>
    <AccountAlias>1001</AccountAlias>
    <BusinessName>Demo Biz</BusinessName>
    <Address1>110 110th Avenue</Address1>
    <Address2>Suite 520</Address2>
    <City>Bellevue</City>
    <StateProvince>WA</StateProvince>
    <PostalCode>98004</PostalCode>
    <Country>USA</Country>
    <Telephone>877-388-4373</Telephone>
    <Fax></Fax>
    <TimeZone>Pacific Standard Time</TimeZone>
    <ShareParentNetworks>true</ShareParentNetworks>
</UpdateAccountDetailsRequest>

XML (SOAP)

<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
    <soap12:Body>
        <UpdateAccountDetails xmlns="http://www.tier3.com/">
            <request>
                <AccountAlias>1001</AccountAlias>
                <BusinessName>Demo Biz</BusinessName>
                <Address1>110 110th Avenue</Address1>
                <Address2>Suite 520</Address2>
                <City>Bellevue</City>
                <StateProvince>WA</StateProvince>
                <PostalCode>98004</PostalCode>
                <Country>USA</Country>
                <Telephone>877-388-4373</Telephone>
                <Fax></Fax>
                <TimeZone>Pacific Standard Time</TimeZone>
                <ShareParentNetworks>true</ShareParentNetworks>
            </request>
        </UpdateAccountDetails>
    </soap12:Body>
</soap12:Envelope>

Response

Attributes

AccountDetails Attributes

Examples

JSON (REST)

{
  "AccountDetails":{
    "AccountAlias":"1001",
    "ParentAlias":"1000",
    "Location":"WA1",
    "BusinessName":"Demo Biz"
    "Address1":"110 110th Avenue",
    "Address2":null,
    "City":"Bellevue",
    "StateProvince":"WA",
    "PostalCode":"98004",
    "Country":"USA",
    "Telephone":"877-388-4373",
    "Fax":null,
    "TimeZone":"Pacific Standard Time",
    "Status":1,
    "ShareParentNetworks":true
  },
  "Success":true,
  "Message":"Account details successfully updated.",
  "StatusCode":0
}

XML (REST)

<AccountDetailsResponse Success="true" Message="Account details successfully updated." StatusCode="0">
     <AccountDetails AccountAlias="1001" ParentAlias="1000" Location="WA1" TimeZone="Pacific Standard Time" Status="1" ShareParentNetworks="true">
         <BusinessName>Demo Biz</BusinessName>
         <Address1>110 110th Avenue</Address1>
         <Address2>Suite 520</Address2>
         <City>Bellevue</City>
         <StateProvince>WA</StateProvince>
         <PostalCode>98004</PostalCode>
         <Country>USA</Country>
         <Telephone>877-388-4373</Telephone>
         <Fax />
     </AccountDetails>
</AccountDetailsResponse>

XML (SOAP)

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <soap:Body>
        <UpdateAccountDetailsResponse xmlns="http://www.tier3.com/">
            <UpdateAccountDetailsResult Success="true" Message="Account details successfully updated." StatusCode="0">
                <AccountDetails AccountAlias="1001" ParentAlias="1000" Location="WA1" TimeZone="Pacific Standard Time" Status="1" ShareParentNetworks="true">
                    <BusinessName>Demo Biz</BusinessName>
                    <Address1>110 110th Avenue</Address1>
                    <Address2>Suite 520</Address2>
                    <City>Bellevue</City>
                    <StateProvince>WA</StateProvince>
                    <PostalCode>98004</PostalCode>
                    <Country>USA</Country>
                    <Telephone>877-388-4373</Telephone>
                    <Fax />
                </AccountDetails>
            </UpdateAccountDetailsResult>
        </UpdateAccountDetailsResponse>
    </soap:Body>
</soap:Envelope>

Status Codes

Valid Timezone Entries

• Dateline Standard Time
• UTC-11
• Hawaiian Standard Time
• Alaskan Standard Time
• Pacific Standard Time (Mexico)
• Pacific Standard Time
• US Mountain Standard Time
• Mountain Standard Time (Mexico)
• Mountain Standard Time
• Central America Standard Time
• Central Standard Time
• Central Standard Time(Mexico)
• Canada Central Standard Time
• SA Pacific Standard Time
• Eastern Standard Time
• US Eastern Standard Time
• Venezuela Standard Time
• Paraguay Standard Time
• Atlantic Standard Time
• Central Brazilian Standard Time
• SA Western Standard Time
• Pacific SA Standard Time
• Newfoundland Standard Time
• E. South America Standard Time
• Argentina Standard Time
• SA Eastern Standard Time
• Greenland Standard Time
• Montevideo Standard Time
• Bahia Standard Time
• UTC-02
• Mid-Atlantic Standard Time
• Azores Standard Time
• Cape Verde Standard Time
• Morocco Standard Time
• UTC
• GMT Standard Time
• Greenwich Standard Time
• W. Europe Standard Time
• Central Europe Standard Time
• Romance Standard Time
• Central European Standard Time
• W. Central Africa Standard Time
• Namibia Standard Time
• Jordan Standard Time
• GTB Standard Time
• Middle East Standard Time
• Egypt Standard Time
• Syria Standard Time
• South Africa Standard Time
• FLE Standard Time
• Turkey Standard Time
• Israel Standard Time
• E. Europe Standard Time
• Arabic Standard Time
• Kaliningrad Standard Time
• Arab Standard Time
• E. Africa Standard Time
• Iran Standard Time
• Arabian Standard Time
• Azerbaijan Standard Time
• Russian Standard Time
• Mauritius Standard Time
• Georgian Standard Time
• Caucasus Standard Time
• Afghanistan Standard Time
• Pakistan Standard Time
• West Asia Standard Time
• India Standard Time
• Sri Lanka Standard Time
• Nepal Standard Time
• Central Asia Standard Time
• Bangladesh Standard Time
• Ekaterinburg Standard Time
• Myanmar Standard Time
• SE Asia Standard Time
• N. Central Asia Standard Time
• China Standard Time
• North Asia Standard Time
• Singapore Standard Time
• W. Australia Standard Time
• Taipei Standard Time
• Ulaanbaatar Standard Time
• North Asia East Standard Time
• Tokyo Standard Time
• Korea Standard Time
• Cen. Australia Standard Time
• AUS Central Standard Time
• E. Australia Standard Time
• AUS Eastern Standard Time
• West Pacific Standard Time
• Tasmania Standard Time
• Yakutsk Standard Time
• Central Pacific Standard Time
• Vladivostok Standard Time
• New Zealand Standard Time
• UTC+12
• Fiji Standard Time
• Magadan Standard Time
• Kamchatka Standard Time
• Tonga Standard Time
• Samoa Standard Time

Gets monthly and hourly charges and estimates for a given account or collection of accounts. Calls to this operation must include an authorization cookie acquired from the Logon operation.

URL

REST: https://api.ctl.io/REST/Billing/GetAccountSummary/<format> (format = XML | JSON)
SOAP: https://api.ctl.io/SOAP/Billing.asmx?op=GetAccountSummary

Request

Attributes

Examples

JSON (REST)

{
  "AccountAlias": "1000"
}

XML (REST)

<BillingRequest>
    <AccountAlias>1000</AccountAlias>
</BillingRequest>

XML (SOAP)

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xmlns:xsd="http://www.w3.org/2001/XMLSchema"
      xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
  <GetAccountSummary xmlns="http://www.tier3.com/">
    <request>
       <accountAlias>1000</accountAlias>
    </request>
  </GetAccountSummary>
</soap:Body>
</soap:Envelope>

Response

Attributes

Examples

JSON (REST)

{
  "OneTimeCharges":0,
  "MonthToDateTotal":2.000000,
  "MonthlyEstimate":2.000000,
  "MonthToDate":2.000000,
  "CurrentHour":0.0,
  "PreviousHour":0.0,
  "Success":true,
  "Message":"OK",
  "StatusCode":0
}

XML (REST)

<BillingSummmaryResponse
  Success="true"
  Message="OK"
  StatusCode="0"
  MonthlyEstimate="161.870000"
  MonthToDate="82.050000"
  CurrentHour="0.223600"
  PreviousHour="0.223600"
  OneTimeCharges="0"
  MonthToDateTotal="82.050000" />

XML (SOAP)

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <soap:Body>
        <GetAccountSummaryResponse xmlns="http://www.tier3.com/">
            <GetAccountSummaryResult
                Success="true"
                Message="OK"
                StatusCode="0"
                MonthlyEstimate="2.000000"
                MonthToDate="2.000000"
                CurrentHour="0.0" 
                PreviousHour="0.0"
                OneTimeCharges="0"
                MonthToDateTotal="2.000000" />
        </GetAccountSummaryResponse>
    </soap:Body>
</soap:Envelope>

Status Codes

Gets the entire billing history for a given account or collection of accounts. Calls to this operation must include an authorization cookie acquired from the Logon operation.

URL

REST: https://api.ctl.io/REST/Billing/GetBillingHistory/<format> (format = XML | JSON)
SOAP: https://api.ctl.io/SOAP/Billing.asmx?op=GetBillingHistory

Request

Attributes

Examples

JSON (REST)

{
  "AccountAlias": "1000"
}

XML (REST)

<BillingRequest>
  <AccountAlias>1000</AccountAlias>
</BillingRequest>

XML (SOAP)

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
        <GetBillingHistory xmlns="http://www.tier3.com/">
            <request>
               <accountAlias>1000</accountAlias>
            </request>
        </GetBillingHistory>
    </soap:Body>
</soap:Envelope>

Response

Attributes

LedgerEntry Attributes

Examples

JSON (REST)

{
  "AccountAlias":"1001",
  "OutstandingBalance":1722.4500,
  "BillingHistory":[
    {
     "InvoiceID":"ID123456",
     "Date":"\/Date(1343775600000)\/",
     "Description":"Invoice ID123456",
     "Debit":1258.8100,
     "Credit":0,
     "OutstandingBalance":1363.8900,
     "ItemID":244,
     "DisplayPrecedence":1
    },
    {
    "InvoiceID":"ID67890",
    "Date":"\/Date(1346454000000)\/",
    "Description":"Invoice ID67890",
    "Debit":358.5600,
    "Credit":0,
    "OutstandingBalance":1722.4500,
    "ItemID":277,
    "DisplayPrecedence":1
    }
  ],
  "Success":true,
  "Message":"OK",
  "StatusCode":0
}

XML (REST)

<BillingHistoryResponse Success="true" Message="OK" StatusCode="0" AccountAlias="RSDA" OutstandingBalance="1722.4500">
    <BillingHistory>
        <LedgerEntry InvoiceID="ID123456"
            Date="2012-08-31T23:00:00"
            Description="Invoice ID123456"
            Debit="1258.8100"
            Credit="0"
            OutstandingBalance="1363.8900" />
        <LedgerEntry InvoiceID="ID67890"
            Date="2012-09-30T23:00:00"
            Description="Invoice ID67890"
            Debit="358.5600"
            Credit="0"
            OutstandingBalance="1722.4500" />
    </BillingHistory>
</BillingHistoryResponse>

XML (SOAP)

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <soap:Body>
        <GetBillingHistoryResponse xmlns="http://www.tier3.com/">
            <GetBillingHistoryResult Success="true" Message="OK" StatusCode="0" AccountAlias="RSDA" OutstandingBalance="1722.4500">
                <BillingHistory>
                    <LedgerEntry InvoiceID="RSDA4503BF68"
                        Date="2012-08-31T23:00:00"
                        Description="Invoice RSDA4503BF68"
                        Debit="1258.8100"
                        Credit="0"
                        OutstandingBalance="1363.8900" />
                    <LedgerEntry InvoiceID="RSDA9278D23F"
                        Date="2012-09-30T23:00:00"
                        Description="Invoice RSDA9278D23F"
                        Debit="358.5600" Credit="0"
                        OutstandingBalance="1722.4500" />
                </BillingHistory>
            </GetBillingHistoryResult>
        </GetBillingHistoryResponse>
    </soap:Body>
</soap:Envelope>

Status Codes

Gets estimated costs for a group of servers. Calls to this operation must include an authorization cookie acquired from the Logon operation.

URL

REST: https://api.ctl.io/REST/Billing/GetGroupEstimate/<format> (format = XML | JSON)
SOAP: https://api.ctl.io/SOAP/Billing.asmx?op=GetGroupEstimate

Request

Attributes

Examples

JSON (REST)

{
  "AccountAlias": "1000",
  "HardwareGroupUUID":"8a03fbae8ddfe311b05f00505682315a"
}

XML (REST)

<GroupEstimateRequest>
  <AccountAlias>1000</AccountAlias>
  <HardwareGroupUUID>8a03fbae8ddfe311b05f00505682315a</HardwareGroupUUID>
</GroupEstimateRequest>

XML (SOAP)

<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
    <soap12:Body>
        <GetGroupEstimate xmlns="http://www.tier3.com/">
            <groupUuid>8a03fbae8ddfe311b05f00505682315a</groupUuid>
        </GetGroupEstimate>
    </soap12:Body>
</soap12:Envelope>

Response

Attributes

Examples

JSON (REST)

{
  "MonthlyEstimate":0,
  "MonthToDate":0,
  "CurrentHour":0,
  "PreviousHour":0,
  "Success":true,
  "Message":"OK",
  "StatusCode":0
}

XML (REST)

<BillingResponse Success="true"
  Message="OK"
  StatusCode="0"
  MonthlyEstimate="0"
  MonthToDate="0"
  CurrentHour="0"
  PreviousHour="0" />

XML (SOAP)

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <soap:Body>
        <GetGroupEstimateResponse xmlns="http://www.tier3.com/">
            <GetGroupEstimateResult Success="true"
                Message="OK"
                StatusCode="0"
                MonthlyEstimate="0"
                MonthToDate="0"
                CurrentHour="0"
                PreviousHour="0" />
        </GetGroupEstimateResponse>
    </soap:Body>
</soap:Envelope>

Status Codes

Gets the charges for groups and servers within a given account, and for any date range. Calls to this operation must include an authorization cookie acquired from the Logon operation.

URL

REST: https://api.ctl.io/REST/Billing/GetGroupSummaries/<format> (format = XML | JSON)
SOAP: https://api.ctl.io/SOAP/Billing.asmx?op=GetGroupSummaries

Request

Attributes

Examples

JSON (REST)

{
  "AccountAlias": "1000",
  "StartDate":"2012-11-01",
  "EndDate":"2012-11-15"
}

XML (REST)

<BillingRequest>
  <AccountAlias>1000</AccountAlias>
  <StartDate>2012-11-01</StartDate>
  <EndDate>2012-11-15</EndDate>
</BillingRequest>

XML (SOAP)

<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
    <soap12:Body>
        <GetGroupSummaries xmlns="http://www.tier3.com/">
            <accountAlias>1000</accountAlias>
        </GetGroupSummaries>
    </soap12:Body>
</soap12:Envelope>  

Response

Attributes

Summary Attributes

ServerGroupTotals Attributes

ServerTotal Attributes

Examples

JSON (REST)

{
  "Summary": {
      "MonthlyEstimate":73.790,
      "MonthToDate":73.790,
      "CurrentHour":0.0,
      "PreviousHour":0.0
  },
  "AccountAlias":"1000",
  "StartDate":"11/1/2012",
  "EndDate":"11/15/2012",
  "GroupTotals": [
    {
      "GroupID":1634,
      "GroupName":"Group 1",
      "LocationAlias":"WA1",
      "ServerTotals":[
        {
          "ServerName":"SERVER1",
          "MonthlyEstimate":73.790,
          "MonthToDate":73.790,
          "CurrentHour":0.0,
          "PreviousHour":0.0
        }
      ],
      "MonthlyEstimate":73.790,
      "MonthToDate":73.790,
      "CurrentHour":0.0,
      "PreviousHour":0.0
    }
  ],
  "Success":true,
  "Message":"Ok",
  "StatusCode":0
}

XML (REST)

<GroupSummariesResponse Success="true" Message="Ok" StatusCode="0" AccountAlias="1000" StartDate="11/1/2012" EndDate="11/15/2012">
    <Summary MonthlyEstimate="73.790" MonthToDate="73.790" CurrentHour="0.0" PreviousHour="0.0" />
    <GroupTotals>
        <ServerGroupTotal MonthlyEstimate="73.790"
            MonthToDate="73.790"
            CurrentHour="0.0"
            PreviousHour="0.0"
            GroupID="1634"
            GroupName="Group 1"
            LocationAlias="WA1">
            <ServerTotals>
                <ServerTotal MonthlyEstimate="73.790"
                    MonthToDate="73.790"
                    CurrentHour="0.0"
                    PreviousHour="0.0"
                    ServerName="SERVER1" />
            </ServerTotals>
        </ServerGroupTotal>
    </GroupTotals>
</GroupSummariesResponse>

XML (SOAP)

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <soap:Body>
        <GetGroupSummariesResponse xmlns="http://www.tier3.com/">
            <GetGroupSummariesResult Success="true"
              Message="Ok"
              StatusCode="0"
              AccountAlias="1000"
              StartDate="11/1/2012"
              EndDate="11/16/2012">
                <Summary MonthlyEstimate="83.180"
                    MonthToDate="83.180"
                    CurrentHour="0.223600"
                    PreviousHour="0.223600" />
                <GroupTotals>
                    <ServerGroupTotal MonthlyEstimate="83.180"
                      MonthToDate="83.180"
                      CurrentHour="0.223600"
                      PreviousHour="0.223600"
                      GroupID="1634"
                      GroupName="Group 1
                      LocationAlias="WA1">
                        <ServerTotals>
                            <ServerTotal MonthlyEstimate="83.180"
                              MonthToDate="83.180"
                              CurrentHour="0.223600"
                              PreviousHour="0.223600"
                              ServerName="SERVER1" />
                        </ServerTotals>
                    </ServerGroupTotal>
                </GroupTotals>
            </GetGroupSummariesResult>
        </GetGroupSummariesResponse>
    </soap:Body>
</soap:Envelope>

Status Codes

Gets the details for a given invoice within an account. Calls to this operation must include an authorization cookie acquired from the Logon operation.

URL

REST: https://api.ctl.io/REST/Billing/GetInvoiceDetails/<format> (format = XML | JSON)
SOAP: https://api.ctl.io/SOAP/Billing.asmx?op=GetInvoiceDetails

Request

Attributes

Examples

JSON (REST)

{
  "AccountAlias": "1000",
  "InvoiceID":"ABC1235"
}

XML (REST)

<InvoiceRequest>
  <AccountAlias>1000</AccountAlias>
  <InvoiceID>ABC1235</InvoiceID>
</InvoiceRequest>

XML (SOAP)

<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
    <soap12:Body>
        <GetInvoiceDetails xmlns="http://www.tier3.com/">
            <accountAlias>1000</accountAlias>
            <invoiceId>ABC1235</invoiceId>
        </GetInvoiceDetails >
    </soap12:Body>
</soap12:Envelope>  

Response

Attributes

Invoice Attributes

InvoiceLineItem Attributes

LineItemDetail Attributes

Examples

JSON (REST)

{
  "OpeningBalance":1363.8900,
  "NewCharges":358.5600,
  "Payments":0.0,
  "EndingBalance":1722.4500,
  "CurrentOutstandingBalance":1722.4500,
  "Invoice":
    {
      "ID":"RSDA9278D23F",
      "Terms":"Upon Receipt",
      "CompanyName":"Demo Account",
      "AccountAlias":"1000",
      "ParentAccountAlias":null,
      "Address1":"123 100th St NE",
      "Address2":null,
      "City":"Bellevue",
      "StateProvince":"WA",
      "PostalCode":"98155",
      "BillingContactEmail":"user@company.com",
      "InvoiceCCEmail":"",
      "TotalAmount":358.5600,
      "InvoiceDate":"\/Date(1349046000000)\/",
      "PONumber":null,
      "LineItems":[
        {
          "Quantity":1,
          "Description":"Group 1",
          "UnitCost":103.5800,
          "ItemTotal":103.5800,
          "ServiceLocation":"WA1",
          "ItemDetails":[
            {
              "Description":"SERVER123",
              "Cost":103.5800
            }
          ]
        },
        {
          "Quantity":1,
          "Description":"Demo Group 2",
          "UnitCost":252.9800,
          "ItemTotal":252.9800,
          "ServiceLocation":"WA1",
          "ItemDetails":[
            {
              "Description":"SERVER987",
              "Cost":252.9800
            }
          ]
        },
        {
          "Quantity":1,
          "Description":"External IP Address (QA1)",
          "UnitCost":2.0000,
          "ItemTotal":2.0000,
          "ServiceLocation":"WA1",
          "ItemDetails":[]
        }
      ]
    },
  "Success":true,
  "Message":"Ok",
  "StatusCode":0
}

XML (REST)

<InvoiceDetailResponse
  Success="true"
  Message="Ok"
  StatusCode="0"
  OpeningBalance="1363.8900"
  NewCharges="358.5600"
  Payments="0.0"
  EndingBalance="1722.4500"
  CurrentOutstandingBalance="1722.4500">
  <Invoice
    ID="RSDA9278D23F"
    Terms="Upon Receipt"
    CompanyName="Demo Company"
    AccountAlias="1000"
    Address1="123 100th St NE"
    City="Bellevue"
    StateProvince="WA"
    PostalCode="98155"
    BillingContactEmail="user@company.com"
    InvoiceCCEmail=""
    TotalAmount="358.5600"
    InvoiceDate="2012-09-30T23:00:00">
      <LineItems>
          <InvoiceLineItem Quantity="1" Description="Demo Group 1" UnitCost="103.5800" ItemTotal="103.5800" ServiceLocation="WA1">
              <ItemDetails>
                  <LineItemDetail Description="SERVER123" Cost="103.5800" />
              </ItemDetails>
          </InvoiceLineItem>
          <InvoiceLineItem Quantity="1" Description="Demo Group 2" UnitCost="252.9800" ItemTotal="252.9800" ServiceLocation="WA1">
              <ItemDetails>
                  <LineItemDetail Description="SERVER987" Cost="252.9800" />
              </ItemDetails>
          </InvoiceLineItem>
          <InvoiceLineItem Quantity="1" Description="External IP Address (QA1)" UnitCost="2.0000" ItemTotal="2.0000" ServiceLocation="QA1">
              <ItemDetails />
          </InvoiceLineItem>
      </LineItems>
  </Invoice>
</InvoiceDetailResponse>

XML (SOAP)

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <soap:Body>
        <GetInvoiceDetailsResponse xmlns="http://www.tier3.com/">
            <GetInvoiceDetailsResult
              Success="true"
              Message="Ok"
              StatusCode="0"
              OpeningBalance="1363.8900"
              NewCharges="358.5600"
              Payments="0.0"
              EndingBalance="1722.4500"
              CurrentOutstandingBalance="1722.4500">
                <Invoice ID="RSDA9278D23F"
                  Terms="Upon Receipt"
                  CompanyName="Demo Account"
                  AccountAlias="1000"
                  Address1="123 100th St NE"
                  City="Bellevue"
                  StateProvince="WA"
                  PostalCode="98155"
                  BillingContactEmail="user@company.com"
                  InvoiceCCEmail=""
                  TotalAmount="358.5600"
                  InvoiceDate="2012-09-30T23:00:00">
                    <LineItems>
                        <InvoiceLineItem Quantity="1" Description="Group 1" UnitCost="103.5800" ItemTotal="103.5800" ServiceLocation="WA1">
                            <ItemDetails>
                                <LineItemDetail Description="SERVER123" Cost="103.5800" /></ItemDetails>
                        </InvoiceLineItem>
                        <InvoiceLineItem Quantity="1" Description="Group 2" UnitCost="252.9800" ItemTotal="252.9800" ServiceLocation="WA1">
                            <ItemDetails><LineItemDetail Description="SERVER987" Cost="252.9800" /></ItemDetails>
                            </InvoiceLineItem>
                        <InvoiceLineItem Quantity="1" Description="External IP Address (QA1)" UnitCost="2.0000" ItemTotal="2.0000" ServiceLocation="WA1">
                            <ItemDetails />
                        </InvoiceLineItem>
                    </LineItems>
                </Invoice>
            </GetInvoiceDetailsResult>
        </GetInvoiceDetailsResponse>
    </soap:Body>
</soap:Envelope>

Status Codes

Gets the estimated monthly cost for a given server. Calls to this operation must include an authorization cookie acquired from the Logon operation.

URL

REST: https://api.ctl.io/REST/Billing/GetServerEstimate/<format> (format = XML | JSON)
SOAP: https://api.ctl.io/SOAP/Billing.asmx?op=GetServerEstimate

Request

Attributes

Examples

JSON (REST)

{
  "AccountAlias": "1000",
  "ServerName":"SVR1"
}

XML (REST)

<ServerEstimateRequest>
  <AccountAlias>RSDA</AccountAlias>
  <ServerName>SVR1</ServerName>
</ServerEstimateRequest>

XML (SOAP)

<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
    <soap12:Body>
        <GetServerEstimate xmlns="http://www.tier3.com/">
            <name>SVR1</name>
        </GetServerEstimate>
    </soap12:Body>
</soap12:Envelope>

Response

Attributes

Examples

JSON (REST)

{
  "MonthlyEstimate":0,
  "MonthToDate":0,
  "CurrentHour":0,
  "PreviousHour":0,
  "Success":true,
  "Message":"OK",
  "StatusCode":0
}

XML (REST)

<BillingResponse Success="true"
  Message="OK"
  StatusCode="0"
  MonthlyEstimate="0"
  MonthToDate="0"
  CurrentHour="0"
  PreviousHour="0" />

XML (SOAP)

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <soap:Body>
        <GetServerEstimateResponse xmlns="http://www.tier3.com/">
            <GetServerEstimateResult Success="true"
              Message="OK"
              StatusCode="0"
              MonthlyEstimate="0"
              MonthToDate="0" 
              CurrentHour="0"
              PreviousHour="0" />
        </GetServerEstimateResponse>
    </soap:Body>
</soap:Envelope>

Status Codes

Gets the server-based hourly cost for any time period. Calls to this operation must include an authorization cookie acquired from the Logon operation.

URL

REST: https://api.ctl.io/REST/Billing/GetServerHourlyCharges/<format> (format = XML | JSON)
SOAP: https://api.ctl.io/SOAP/Billing.asmx?op=GetServerHourlyCharges

Request

Attributes

Examples

JSON (REST)

{
  "AccountAlias": "1000",
  "ServerName":"QA1RSDASER101",
  "StartDate":"2012-11-14",
  "EndDate":"2012-11-15"
}

XML (REST)

<ServerRequest>
  <AccountAlias>RSDA</AccountAlias>
  <ServerName>QA1RSDASER101</ServerName>
  <StartDate>2012-11-14</StartDate>
  <EndDate>2012-11-15</EndDate>
</ServerRequest>

XML (SOAP)

<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
    <soap12:Body>
        <GetServerHourlyCharges xmlns="http://www.tier3.com/">
            <accountAlias>1000</accountAlias>
            <name>QA1RSDASER101</name>
            <startDate>2012-11-15</startDate>
            <endDate>2012-11-15</endDate>
        </GetServerHourlyCharges>
    </soap12:Body>
</soap12:Envelope>

Response

Attributes

Examples

JSON (REST)

{
  "Summary":
    {
      "MonthlyEstimate":0.0,
      "MonthToDate":0.0,
      "CurrentHour":0.0,
      "PreviousHour":0.0
    },
  "AccountAlias":"RSDA",
  "ServerName":"QA1RSDASER101",
  "StartDate":"\/Date(1352851200000)\/",
  "EndDate":"\/Date(1352937600000)\/",
  "HourlyCharges": [
    {
      "Hour":"2012-11-14T12:00:00",
      "ProcessorCost":"0",
      "MemoryCost":"0",
      "StorageCost":"0",
      "OSCost":"0"
    },
    {
      "Hour":"2012-11-14T01:00:00",
      "ProcessorCost":"0",
      "MemoryCost":"0",
      "StorageCost":"0",
      "OSCost":"0"
    }
  ],
  "Success":true,
  "Message":"OK",
  "StatusCode":0
}

XML (REST)

<ServerHourlyChargesResponse
  Success="true"
  Message="OK"
  StatusCode="0"
  AccountAlias="RSDA"
  ServerName="QA1RSDASER101"
  StartDate="2012-11-14T00:00:00"
  EndDate="2012-11-15T00:00:00">
    <Summary MonthlyEstimate="0.0" MonthToDate="0.0" CurrentHour="0.0" PreviousHour="0.0" />
    <HourlyCharge>
        <ServerHourlyCost Hour="2012-11-14T12:00:00" ProcessorCost="0" MemoryCost="0" StorageCost="0" OSCost="0" />
        <ServerHourlyCost Hour="2012-11-14T01:00:00" ProcessorCost="0" MemoryCost="0" StorageCost="0" OSCost="0" />
    </HourlyCharge>
</ServerHourlyChargesResponse>

XML (SOAP)

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <soap:Body>
        <GetServerHourlyChargesResponse xmlns="http://www.tier3.com/">
            <GetServerHourlyChargesResult Success="true"
              Message="OK"
              StatusCode="0"
              AccountAlias="RSDA"
              ServerName="QA1RSDASER101"
              StartDate="2012-11-14T00:00:00"
              EndDate="2012-11-15T00:00:00">
                <Summary MonthlyEstimate="0.0" MonthToDate="0.0" CurrentHour="0.0" PreviousHour="0.0" />
                <HourlyCharges>
                    <ServerHourlyCost Hour="2012-11-14T12:00:00" ProcessorCost="0" MemoryCost="0" StorageCost="0" OSCost="0" />
                    <ServerHourlyCost Hour="2012-11-14T01:00:00" ProcessorCost="0" MemoryCost="0" StorageCost="0" OSCost="0" />
                </HourlyCharges>
            </GetServerHourlyChargesResult>
        </GetServerHourlyChargesResponse>
    </soap:Body>
</soap:Envelope>

Status Codes

Deploys a Blueprint with the given set of parameter values.

URL

REST: https://api.ctl.io/REST/Blueprint/DeployBlueprint/<format> (format = XML | JSON)
SOAP: https://api.ctl.io/SOAP/Blueprints.asmx?op=DeployBlueprint

Request

Attributes

Parameter Attributes

CustomField Attributes

Examples

JSON

{
  "ID": "1",
  "LocationAlias": "WA1",
  "Parameters": [
    { "Name":"T3.BuildServerTask.Password", "Value":"password" },
    { "Name":"T3.BuildServerTask.Network","Value":"VLAN_XXX" },
    { "Name":"T3.BuildServerTask.PrimaryDNS","Value":"192.168.64.19" },
    { "Name":"T3.BuildServerTask.SecondaryDNS","Value":"192.168.64.20" }
  ],
  "CustomFields": [
    { "ID": "ea97c6e09f604eb689dcdc080114b04d","Value": "A test"},
    { "ID": "b9f454f2ae664998acc3302b24330c5b","Value": "2"},
    { "ID": "d1f12de4ce4b4685b72ba632db0685c6","Value": "true"}
  ]
}

XML

<DeployBlueprintRequest>
    <ID>107</ID>
    <LocationAlias>WA1</LocationAlias>
    <Parameters>
        <Parameter Name="T3.BuildServerTask.Password" Value="Pass@word1" />
        <Parameter Name="T3.BuildServerTask.Network" Value="VLAN_XXX" />
        <Parameter Name="T3.BuildServerTask.PrimaryDNS" Value="192.168.64.19" />
        <Parameter Name="T3.BuildServerTask.SecondaryDNS" Value="192.168.64.20" />
    </Parameters>
    <CustomFields ID="ea97c6e09f604eb689dcdc080114b04d" Value="Test text" />
    <CustomFields ID="b9f454f2ae664998acc3302b24330c5b" Value="2" />
    <CustomFields ID="d1f12de4ce4b4685b72ba632db0685c6" Value="true" />
</DeployBlueprintRequest>

Response

Attributes

Examples

JSON

{
  "RequestID": 1,
  "Success":true,
  "Message":"Success",
  "StatusCode":0
}

XML

<QueuedItemResponse Success="true" Message="Success" StatusCode="0">
    <RequestID>1</RequestID>
</QueuedItemResponse>

Status Codes

Gets the full details of the specified Blueprint.

URL

REST: https://api.ctl.io/REST/Blueprint/GetBlueprintDetails/<format> (format = XML | JSON)
SOAP: https://api.ctl.io/SOAP/Blueprints.asmx?op=GetBlueprintDetailsResponseMsg

Request

Attributes

Examples

JSON

{ "ID": "1" }

XML

<BlueprintRequest>
    <ID>1</ID>
</BlueprintRequest>

Response

Attributes

BlueprintDetails Attributes

Examples

JSON

{
  "BlueprintDetails":{
    "ID":1,
    "Name":"Blueprint 01",
    "Visibility":1,
    "Status":1
    "Author":"",
    "Capabilities":["Web Applications","CDN"],
    "Description":"This is the first Blueprint"
  },
  "Success":true,
  "Message":"Success",
  "StatusCode":0
}

XML

<GetBlueprintDetailsResponse Success="true" Message="Success" StatusCode="0">
    <BlueprintDetails ID="1" Status="1" Visibility="1">
        <Name>Blueprint 01</Name>
        <Author></Author>
        <Description>This is the first Blueprint</Description>
    </BlueprintDetails>
</GetBlueprintDetailsResponse>

Status Codes

Gets a the full list of parameters that are required to deploy a Blueprint.

URL

REST: https://api.ctl.io/REST/Blueprint/GetBlueprintParameters/<format> (format = XML | JSON)
SOAP: https://api.ctl.io/SOAP/Blueprints.asmx?op=GetBlueprintParamatersResponseMsg

Request

Attributes

Examples

JSON

{ "ID":1 }

XML

<BlueprintRequest>
    <ID>1</ID>
</BlueprintRequest>

Response

Attributes

Parameter Attributes

Examples

JSON

{
  "ID":1,
  "Parameters":[
    {
      "Name":"T3.ScriptTask.Parameter01",
      "Regex":null,
      "Type":7,
      "Options":[]
    },
    {
      "Name":"T3.ScriptTask.Parameter02",
      "Regex":null,
      "Type":3,
      "Options":[
        {"Name":"Option 1","Value":"1"},
        {"Name":"Option 2","Value":"2"}
      ]
    }
  ],
  "Success":true,
  "Message":"Success",
  "StatusCode":0
 }

XML

<GetBlueprintParamatersResponse Success="true" Message="Success" StatusCode="0">
    <ID>46</ID>
    <Parameters>
          <Parameter Name="T3.ScriptTask.Parameter01" Type="String" />
          <Parameter Name="T3.ScriptTask.Parameter02" Type="Option">
              <Option Name="Option 1" Value="1"/>
              <Option Name="Option 2" Value="1"/>
          </Parameter>
      </Parameters>
</GetBlueprintParamatersResponse>

Status Codes

Gets a list of all Blueprints with the specified search criteria.

URL

REST:https://api.ctl.io/REST/Blueprint/GetBlueprints/<format> (format = XML | JSON)
SOAP: https://api.ctl.io/SOAP/Blueprints.asmx?op=GetBlueprintsResponseMsg

Request

Attributes

Examples

JSON

{
  "CompanySize": "2",
  "OperatingSystems": [ 7, 20, 22, 28],
  "Search": "High Performance",
  "Visibility": 1
}

XML

<GetBlueprintsRequest>
      <CompanySize>2</CompanySize>
      <OperatingSystems>
          <OS>7</OS>
          <OS>20</OS>
          <OS>22</OS>
          <OS>28</OS>
      </OperatingSystems>
      <Search>High Performance</Search>
      <Visibility>1</Visibility>
</GetBlueprintsRequest>

Response

Attributes

Blueprint Attributes

Examples

JSON

{
  "Blueprints":[
    {"ID":1,"Name":"Blueprint 01"},
    {"ID":2,"Name":"Blueprint 02"},
  ],
  "Success":true,
  "Message":"Success",
  "StatusCode":0
}

XML

<GetBlueprintsResponse Success="true" Message="Success" StatusCode="0">
    <Blueprints>
        <Blueprint ID="1" Name="Blueprint 01" />
        <Blueprint ID="2" Name="Blueprint 02" />
    </Blueprints>
</GetBlueprintsResponse>

Status Codes

Gets the status of the specified Blueprint deployment.

URL

REST: https://api.ctl.io/REST/Blueprint/GetDeploymentStatus/<format> (format = XML | JSON)
SOAP: https://api.ctl.io/SOAP/Blueprints.asmx?op=GetDeploymentStatusMsg

Request

Attributes

Examples

JSON

{
  "RequestID": "1",
  "LocationAlias": "WA1"
}

XML

<GetDeploymentStatusRequest>
    <RequestID>1</RequestID>
    <LocationAlias>WA1</LocationAlias>
</GetDeploymentStatusRequest>

Response

Attributes

Examples

JSON

{
  "RequestID":210,
  "CurrentStatus":"Failed",
  "Description":"Error Building Blueprint",
  "StatusDate":"\/Date(1318480463790)\/",
  "Step":"0",
  "PercentComplete":0,
  "Success":true,
  "Message":"Success",
  "StatusCode":0,
  "Servers":["WA1T3NWEB01"]
}

XML

<GetDeploymentStatusResponse
  Success="true"
  Message="Success"
  StatusCode="0"
  RequestID="210"
  CurrentStatus="Failed"
  Description="Error Building Blueprint"
  StatusDate="2011-10-12T21:34:23.79"
  Step="0"
  PercentComplete="0"
    <Servers>
        <string>WA1T3NWEB01</string>
    </Servers>
</GetDeploymentStatusResponse>

Status Codes

Gets a list of Blueprint Packages.

URL

REST: https://api.ctl.io/REST/Blueprint/GetPackages/<format> (format = XML | JSON)
SOAP: https://api.ctl.io/SOAP/Blueprints.asmx?op=GetPackagesResponseMsg

Request

Attributes

Examples

JSON

{ "Classification": "1", "Visibility": "1" }

XML

<GetPackagesRequest>
  <Classification>1</Classification>
  <Visibility>1</Visibility>
</GetPackagesRequest>

Response

Attributes

Package Attributes

Examples

JSON

{
  "Packages": [
    {"ID":2,"Name":"Add Disk","Classification":1},
    {"ID":3,"Name":"Add IP Address","Classification":1},
    {"ID":4,"Name":"Add Mapped IP Address","Classification":1},
    {"ID":5,"Name":"Snapshot Server","Classification":1},
    {"ID":6,"Name":"Reboot Server","Classification":1}
  ],
  "Success":true,
  "Message":"Success",
  "StatusCode":0
}

XML

<GetPackagesResponse Success="true" Message="Success" StatusCode="0">
    <Packages>
        <Package ID="2" Name="Add Disk" Classification="1" />
        <Package ID="3" Name="Add IP Address" Classification="1" />
        <Package ID="4" Name="Add Mapped IP Address" Classification="1" />
        <Package ID="5" Name="Snapshot Server" Classification="1" />
        <Package ID="6" Name="Reboot Server" Classification="1" />
    </Packages>
</GetPackagesResponse>

Status Codes

Gets a list of Blueprint Packages that are pending publication.

This list contains all Packages that were uploaded to via FTP or that were uploaded in the UI via HTTP.

URL

REST: https://api.ctl.io/REST/Blueprint/GetPendingPackages/<format> (format = XML | JSON)
SOAP: https://api.ctl.io/SOAP/Blueprints.asmx?op=GetPendingPackages

Request

Attributes

None.

Response

Attributes

Package Attributes

Examples

JSON

{
  "Packages": [
    {"ID":0,"Name":"Script 01","Classification":0},
    {"ID":0,"Name":"Software 01","Classification":0}
  ],
  "Success":true,
  "Message":"Success",
  "StatusCode":0
}

XML

<GetPackagesResponse Success="true" Message="Success" StatusCode="0">
    <Packages>
        <Package ID="0" Name="Script 01" Classification="0" />
        <Package ID="0" Name="Software 01" Classification="0" />
    </Packages>
</GetPackagesResponse>

Status Codes

Publishes a Blueprint Package for use within the Blueprint Designer.

URL

REST: https://api.ctl.io/REST/Blueprint/PublishPackage/<format> (format = XML | JSON)
SOAP: https://api.ctl.io/SOAP/Blueprints.asmx?op=PublishPackage

Request

Attributes

Operating Systems

Examples

JSON

{
  "Classification": "2",
  "Name":"Script01.zip",
  "OperatingSystems":[4,5],
  "Visibility": "1"
}

XML

<PublishPackageRequest>
    <Classification>2</Classification>
    <Name>Script01.zip</Name>
    <OperatingSystems>
    <OS>4</OS>
    <OS>5</OS>
    </OperatingSystems>
    <Visibility>1</Visibility>
</PublishPackageRequest>

Response

Attributes

Examples

JSON

{
  "RequestID": 1,
  "Success":true,
  "Message":"Success",
  "StatusCode":0
}

XML

<QueuedItemResponse Success="true" Message="Success" StatusCode="0">
    <RequestID>1</RequestID>
</QueuedItemResponse>

Status Codes

Archives all Servers in the Group and then archives the Group.

URL

REST: https://api.ctl.io/REST/Group/ArchiveHardwareGroup/<format> (format = XML | JSON)
SOAP: https://api.ctl.io/SOAP/Group.asmx?op=ArchiveHardwareGroup

Request

Attributes

Examples

JSON

{
  "AccountAlias": "UNK",
  "UUID": "b7e44f0391824d408732f215a91a0578"
}

XML

<GroupRequest>
    <AccountAlias>ACCT</AccountAlias>
    <UUID>b7e44f0391824d408732f215a91a0578</UUID>
</GroupRequest>

Response

Attributes

Examples

JSON

{
  "RequestID:1,
  "Success":true,
  "Message":"Success",
  "StatusCode":0
}

XML

<QueuedItemResponse Success="true" Message="Success" StatusCode="0">
  <RequestID>1</RequestID>
</QueuedItemResponse>

Status Codes

Creates a new Hardware Group.

URL

REST: https://api.ctl.io/REST/Group/CreateHardwareGroup/<format> (format = XML | JSON)
SOAP: https://api.ctl.io/SOAP/Group.asmx?op=CreateHardwareGroup

Request

Attributes

Examples

JSON

{
  "AccountAlias": "UNK",
  "ParentUUID": "b7e44f0391824d408732f215a91a0578",
  "Name": "Group 01",
  "Description": "My new group"
}

XML

<CreateHardwareGroupRequest>
    <AccountAlias>ACCT</AccountAlias>
    <ParentUUID>b7e44f0391824d408732f215a91a0578</ParentUUID>
    <Name>Group 01</Name>
    <Description>My new group</Description>
</CreateHardwareGroupRequest>

Response

Attributes

Group Attributes

Examples

JSON

{
  "Group":
    {
      "ID":5,
      "UUID":"3d30a6ab6c1243388b7bc966d073e353",
      "ParentID":2,
      "ParentUUID":"b7e44f0391824d408732f215a91a0578"
      "Name":"Group 01",
      "IsSystemGroup":false
    },
  "Success":true,
  "Message":"Success",
  "StatusCode":0
}

XML

<CreateHardwareGroupResponse Success="true" Message="Success" StatusCode="0">
  <Group ID="5" UUID="3d30a6ab6c1243388b7bc966d073e353"
    ParentID="2" ParentUUID="b7e44f0391824d408732f215a91a0578"
    Name="Group 01" IsSystemGroup="false" />
</CreateHardwareGroupResponse>

Status Codes

Deletes the Hardware Group along with all child groups and servers.

URL

REST: https://api.ctl.io/REST/Group/DeleteHardwareGroup/<format> (format = XML | JSON)
SOAP: https://api.ctl.io/SOAP/Group.asmx?op=DeleteHardwareGroup

Request

Attributes

Examples

JSON

{
  "AccountAlias": "UNK",
  "UUID": "b7e44f0391824d408732f215a91a0578"
}

XML

<DeleteGroupRequest>
  <AccountAlias>ACCT</AccountAlias>
  <UUID>b7e44f0391824d408732f215a91a0578</UUID>
</DeleteGroupRequest>

Response

Attributes

Examples

JSON

{
  "RequestID:1,
  "Success":true,
  "Message":"Success",
  "StatusCode":0
}

XML

<QueuedItemResponse Success="true" Message="Success" StatusCode="0">
  <RequestID>1</RequestID>
</QueuedItemResponse>

Status Codes

Gets a list of all groups with the specified search criteria.

URL

REST: https://api.ctl.io/REST/Group/GetGroups/<format> (format = XML | JSON)
SOAP: https://api.ctl.io/SOAP/Group.asmx?op=GetGroups

Request

Attributes

Examples

JSON

{
  "AccountAlias": "UNK",
  "Location": "DC1"
}

XML

<GetGroupsRequest>
    <AccountAlias>ACCT</AccountAlias>
    <Location>WA1</Location>
</GetGroupsRequest>

Response

Attributes

Hardware Group Attributes

Examples

JSON

{
  "AccountAlias":"UNK",
  "HardwareGroups": [
    {
      "ID":5,
      "UUID":"3d30a6ab6c1243388b7bc966d073e353",
      "ParentID":2,
      "ParentUUID":"b7e44f0391824d408732f215a91a0578"
      "Name":"Group 01",
      "IsSystemGroup":false
    },
    {
      "ID":2,
      "UUID":"b7e44f0391824d408732f215a91a0578",
      "ParentID":1,
      "ParentUUID":"8a03fcae8ddfe321b05f00505682315a",
      "Name":"Group 02",
      "IsSystemGroup":false
    }
  ],
  "Success":true,
  "Message":"Success",
  "StatusCode":0
}

XML

<GetGroupsResponse AccountAlias="UNK" Success="true" Message="Success" StatusCode="0">
  <HardwareGroups>
    <HardwareGroup ID="5" UUID="3d30a6ab6c1243388b7bc966d073e353"
      ParentID="2" ParentUUID="b7e44f0391824d408732f215a91a0578"
      Name="Group 01" IsSystemGroup="false" />
    <HardwareGroup ID="2" UUID="b7e44f0391824d408732f215a91a0578"
      ParentID="1" ParentUUID="8a03fcae8ddfe321b05f00505682315a"
      Name="Group 02" IsSystemGroup="false" />
  </HardwareGroups>
</GetGroupsResponse>

Status Codes

Enables or disables Maintenance Mode on a Hardware Group.

URL

REST: https://api.ctl.io/REST/Group/HardwareGroupMaintenance/<format> (format = XML | JSON)
SOAP: https://api.ctl.io/SOAP/Group.asmx?op=HardwareGroupMaintenance

Request

Attributes

Examples

JSON

{
  "AccountAlias": "UNK",
  "UUID": "b7e44f0391824d408732f215a91a0578",
  "Enable": true
}

XML

<GroupMaintenanceRequest>
    <AccountAlias>ACCT</AccountAlias>
    <UUID>b7e44f0391824d408732f215a91a0578</UUID>
    <Enable>true</Enable>
</GroupMaintenanceRequest>

Response

Attributes

Examples

JSON

{
  "RequestID:1,
  "Success":true,
  "Message":"Success",
  "StatusCode":0
}

XML

<QueuedItemResponse Success="true" Message="Success" StatusCode="0">
  <RequestID>1</RequestID>
</QueuedItemResponse>

Status Codes

Pauses the Hardware Group along with all child groups and servers.

URL

REST: https://api.ctl.io/REST/Group/PauseHardwareGroup/<format> (format = XML | JSON)
SOAP: https://api.ctl.io/SOAP/Group.asmx?op=PauseHardwareGroup

Request

Attributes

Examples

JSON

{
  "AccountAlias": "UNK",
  "UUID": "b7e44f0391824d408732f215a91a0578"
}

XML

<GroupRequest>
    <AccountAlias>ACCT</AccountAlias>
    <UUID>b7e44f0391824d408732f215a91a0578</UUID>
</GroupRequest>

Response

Attributes

Examples

JSON

{
  "RequestID:1,
  "Success":true,
  "Message":"Success",
  "StatusCode":0
}

XML

<QueuedItemResponse Success="true" Message="Success" StatusCode="0">
  <RequestID>1</RequestID>
</QueuedItemResponse>

Status Codes

Powers off the Hardware Group along with all child groups and servers.

URL

REST: https://api.ctl.io/REST/Group/PowerOffHardwareGroup/<format> (format = XML | JSON)
SOAP: https://api.ctl.io/SOAP/Group.asmx?op=PowerOffHardwareGroup

Request

Attributes

Examples

JSON

{
  "AccountAlias": "UNK",
  "UUID": "b7e44f0391824d408732f215a91a0578"
}

XML

<GroupRequest>
    <AccountAlias>ACCT</AccountAlias>
    <UUID>b7e44f0391824d408732f215a91a0578</UUID>
</GroupRequest>

Response

Attributes

Examples

JSON

{
  "RequestID:1,
  "Success":true,
  "Message":"Success",
  "StatusCode":0
}

XML

<QueuedItemResponse Success="true" Message="Success" StatusCode="0">
    <RequestID>1</RequestID>
</QueuedItemResponse>

Status Codes

Power on the Hardware Group along with all child groups and servers.

URL

REST: https://api.ctl.io/REST/Group/PowerOnHardwareGroup/<format> (format = XML | JSON)
SOAP: https://api.ctl.io/SOAP/Group.asmx?op=PowerOnHardwareGroup

Request

Attributes

Examples

JSON

{
  "AccountAlias": "UNK",
  "UUID": "b7e44f0391824d408732f215a91a0578"
}

XML

<GroupRequest>
    <AccountAlias>ACCT</AccountAlias>
    <UUID>b7e44f0391824d408732f215a91a0578</UUID>
</GroupRequest>

Response

Attributes

Examples

JSON

{
  "RequestID:1,
  "Success":true,
  "Message":"Success",
  "StatusCode":0
}

XML

<QueuedItemResponse Success="true" Message="Success" StatusCode="0">
  <RequestID>1</RequestID>
</QueuedItemResponse>

Status Codes

Reboot the Hardware Group along with all child groups and servers.

URL

REST: https://api.ctl.io/REST/Group/RebootHardwareGroup/<format> (format = XML | JSON)
SOAP: https://api.ctl.io/SOAP/Group.asmx?op=RebootHardwareGroup

Request

Attributes

Examples

JSON

{
  "AccountAlias": "UNK",
  "UUID": "b7e44f0391824d408732f215a91a0578"
}

XML

<GroupRequest>
    <AccountAlias>ACCT</AccountAlias>
    <UUID>b7e44f0391824d408732f215a91a0578</UUID>
</GroupRequest>

Response

Attributes

Examples

JSON

{
  "RequestID:1,
  "Success":true,
  "Message":"Success",
  "StatusCode":0
}

XML

<QueuedItemResponse Success="true" Message="Success" StatusCode="0">
    <RequestID>1</RequestID>
</QueuedItemResponse>

Status Codes

Reset the Hardware Group along with all child groups and servers.

URL

REST: https://api.ctl.io/REST/Group/ResetHardwareGroup/<format> (format = XML | JSON)
SOAP: https://api.ctl.io/SOAP/Group.asmx?op=ResetHardwareGroup

Request

Attributes

Examples

JSON

{
  "AccountAlias": "UNK",
  "UUID": "b7e44f0391824d408732f215a91a0578"
}

XML

<GroupRequest>
    <AccountAlias>ACCT</AccountAlias>
    <UUID>b7e44f0391824d408732f215a91a0578</UUID>
</GroupRequest>

Response

Attributes

Examples

JSON

{
  "RequestID:1,
  "Success":true,
  "Message":"Success",
  "StatusCode":0
}

XML

<QueuedItemResponse Success="true" Message="Success" StatusCode="0">
    <RequestID>1</RequestID>
</QueuedItemResponse>

Status Codes

Restores an archived Hardware Group.

URL

REST: https://api.ctl.io/REST/Group/RestoreHardwareGroup/<format> (format = XML | JSON)
SOAP: https://api.ctl.io/SOAP/Group.asmx?op=RestoreHardwareGroup

Request

Attributes

Examples

JSON

{
  "AccountAlias": "UNK",
  "UUID": "b7e44f0391824d408732f215a91a0578",
  "ParentUUID": "8a03fcae8ddfe321b05f00505682315a"
}

XML

<RestoreGroupRequest>
    <AccountAlias>ACCT</AccountAlias>
    <UUID>b7e44f0391824d408732f215a91a0578</UUID>
    <ParentUUID>8a03fcae8ddfe321b05f00505682315a</ParentUUID>
</RestoreGroupRequest>

Response

Attributes

Examples

JSON

{
  "RequestID:1,
  "Success":true,
  "Message":"Success",
  "StatusCode":0
}

XML

<QueuedItemResponse Success="true" Message="Success" StatusCode="0">
    <RequestID>1</RequestID>
</QueuedItemResponse>

Status Codes

Shutdown the Hardware Group along with all child groups and servers.

URL

REST: https://api.ctl.io/REST/Group/ShutdownHardwareGroup/<format> (format = XML | JSON)
SOAP: https://api.ctl.io/SOAP/Group.asmx?op=ShutdownHardwareGroup

Request

Attributes

Examples

JSON

{
  "AccountAlias": "UNK",
  "UUID": "b7e44f0391824d408732f215a91a0578"
}

XML

<GroupRequest>
    <AccountAlias>ACCT</AccountAlias>
    <UUID>b7e44f0391824d408732f215a91a0578</UUID>
</GroupRequest>

Response

Attributes

Examples

JSON

{
  "RequestID:1,
  "Success":true,
  "Message":"Success",
  "StatusCode":0
}

XML

<QueuedItemResponse Success="true" Message="Success" StatusCode="0">
    <RequestID>1</RequestID>
</QueuedItemResponse>

Status Codes

Maps a public IP Address to a Server.

URL

REST: https://api.ctl.io/REST/Network/AddPublicIPAddress/<format> (format = XML | JSON)
SOAP: https://api.ctl.io/SOAP/Network.asmx?op=AddPublicIPAddress

Request

Attributes

Examples

JSON

{
  "AccountAlias": "SUB1",
  "ServerName": "WA1T3NWEB01",
  "IPAddress": "1.1.1.1",
  "ServerPassword": "password",
  "AllowHTTP": true,
  "AllowHTTPonPort8080": false,
  "AllowHTTPS": false,
  "AllowFTP": false,
  "AllowFTPS": false,
  "AllowSFTP": false,
  "AllowSSH": false,
  "AllowRDP": false
}

XML

<AddIPAddressRequest>
    <AccountAlias>SUB1</AccountAlias>
    <ServerName>WA1T3NWEB01</ServerName>
    <IPAddress>1.1.1.1</IPAddress>
    <ServerPassword>password</ServerPassword>
    <AllowHTTP>true</AllowHTTP>
    <AllowHTTPonPort8080>false</AllowHTTPonPort8080>
    <AllowHTTPS>false</AllowHTTPS>
    <AllowFTP>false</AllowFTP>
    <AllowFTPS>false</AllowFTPS>
    <AllowSFTP>false</AllowSFTP>
    <AllowSSH>false</AllowSSH>
    <AllowRDP>false</AllowRDP>
</AddIPAddressRequest>

Response

Attributes

Examples

JSON

{
 "Success":true,
 "Message":"Success",
 "StatusCode":0,
 "RequestID":1
}

XML

<QueuedItemResponse Success="true" Message="Success" StatusCode="0" RequestID="1" />

Status Codes

Gets the list of Networks mapped to an account in any Data Center.

URL

REST: https://api.ctl.io/REST/Network/GetAccountNetworks/<format> (format = XML | JSON)
SOAP: https://api.ctl.io/SOAP/Network.asmx?op=GetAccountNetworks

Request

Attributes

Examples

JSON

{
  "AccountAlias": "UNK",
  "Location": "UN1"
}

XML

<NetworkRequest>
    <AccountAlias>UNK</AccountAlias>
    <Location>UN1</Location>
</NetworkRequest>

Response

Attributes

Network Attributes

Examples

JSON

{
  "Networks": [
    {
      "Name": "vlan_1114_10.81.14",
      "Description": "vlan_1114_10.81.14",
      "Gateway": "10.81.14.1",
      "Location": "UN1",
      "AccountAlias": "UNK"
    },
    {
      "Name": "vlan_1241_10.81.141",
      "Description": "vlan_1241_10.81.141",
      "Gateway": "10.81.141.1",
      "Location": "UN1",
      "AccountAlias": "UNK"
    }
  ],
  "Success": true,
  "Message": "Networks successfully queried.",
  "StatusCode": 0
}

XML

<GetNetworksResponse Success="true" Message="Networks successfully queried." StatusCode="0">
    <Networks>
        <Network Name="vlan_1114_10.81.14" Description="vlan_1114_10.81.14" Gateway="10.81.14.1" Location="UN1" AccountAlias="UNK"/>
        <Network Name="vlan_1241_10.81.141" Description="vlan_1241_10.81.141" Gateway="10.81.141.1" Location="UN1" AccountAlias="UNK"/>
    </Networks>
</GetNetworksResponse>

Status Codes

Gets the list of Networks mapped to an account in any Data Center that are deployable.

URL

REST: https://api.ctl.io/REST/Network/GetDeployableNetworks/<format> (format = XML | JSON)
SOAP: https://api.ctl.io/SOAP/Network.asmx?op=GetDeployableNetworks

Request

Attributes

Examples

JSON

{
  "AccountAlias": "UNK",
  "Location": "UN1"
}

XML

<NetworkRequest>
    <AccountAlias>UNK</AccountAlias>
    <Location>UN1</Location>
</NetworkRequest>

Response

Attributes

Network Attributes

Examples

JSON

{
  "Networks": [
    {
      "Name": "vlan_1114_10.81.14",
      "Description": "vlan_1114_10.81.14",
      "Gateway": "10.81.14.1",
      "Location": "UN1",
      "AccountAlias": "UNK"
    },
    {
      "Name": "vlan_1241_10.81.141",
      "Description": "vlan_1241_10.81.141",
      "Gateway": "10.81.141.1",
      "Location": "UN1",
      "AccountAlias": "UNK"
    }
  ],
  "Success": true,
  "Message": "Networks successfully queried.",
  "StatusCode": 0
}

XML

<GetNetworksResponse Success="true" Message="Networks successfully queried." StatusCode="0">
    <Networks>
        <Network Name="vlan_1114_10.81.14" Description="vlan_1114_10.81.14" Gateway="10.81.14.1" Location="UN1" AccountAlias="UNK"/>
        <Network Name="vlan_1241_10.81.141" Description="vlan_1241_10.81.141" Gateway="10.81.141.1" Location="UN1" AccountAlias="UNK"/>
    </Networks>
</GetNetworksResponse>

Status Codes

Gets the details for a Network and its IP Addresses.

URL

REST: https://api.ctl.io/REST/Network/GetNetworkDetails/<format> (format = XML | JSON)
SOAP: https://api.ctl.io/SOAP/Network.asmx?op=GetNetworkDetailsResponseMsg

Request

Attributes

Examples

JSON

{
  "AccountAlias": "UNK",
  "Location": "UN1",
  "Name": "vlan_1114_10.81.14"
}

XML

<GetNetworkDetailsRequest>
    <AccountAlias>UNK</AccountAlias>
    <Location>UN1</Location>
    <Name>vlan250_172.21.250</Name>
</GetNetworkDetailsRequest>

Response

Attributes

NetworkDetails Attributes

IPAddress Attributes

Examples

JSON

{
  "Success":true,
  "Message":"Success",
  "StatusCode":0,
  "NetworkDetails":{
    "Name":"vlan250_172.21.250",
    "Description":"vlan250_172.21.250",
    "Gateway":"172.21.250.1",
    "NetworkMask":"255.255.255.0",
    "Location":"WA1",
    "IPAddresses: [
      {
        "Address":"172.21.250.2",
        "AddressType":"RIP",
        "IsClaimed":false,
        "ServerName":""
      },
      {
        "Address":"172.21.250.3",
        "AddressType":"RIP",
        "IsClaimed":true,
        "ServerName":"DEMOFIRST01"
      }
    ]
  }
}

XML

<NetworkDetailsResponse Success="true" Message="Success" StatusCode="0">
    <NetworkDetails Name="vlan250_172.21.250" Description="vlan250_172.21.250"
        Gateway="172.21.250.1" NetworkMask="255.255.255.0" Location="WA1">
        <IPAddresses>
            <IPAddress Address="172.21.250.2" AddressType="RIP"
              IsClaimed="false" ServerName="" />
            <IPAddress Address="172.21.250.3" AddressType="RIP"
              IsClaimed="true" ServerName="DEMOFIRST01" />
        </IPAddresses>
    </NetworkDetails>
</NetworkDetailsResponse>

Status Codes

Gets the list of Networks mapped to the account in its Primary Data Center.

URL

REST: https://api.ctl.io/REST/Network/GetNetworks/<format> (format = XML | JSON)
SOAP: https://api.ctl.io/SOAP/Network.asmx?op=GetNetworks

Request

Attributes

Examples

JSON (REST)

{
    "AccountAlias": "1000",
    "Location":"WA1"
}

XML (REST)

<Networks>
    <AccountAlias>1000</AccountAlias>
    <Location>WA1</Location>
</Networks>

XML (SOAP)

<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <Networks xmlns="http://www.tier3.com/">
        <AccountAlias>1000</AccountAlias>
        <Location>WA1</Location>
    </Networks>
  </soap12:Body>
</soap12:Envelope>

Response

Attributes

Network Attributes

Examples

JSON

{
  "Networks": [
    {
      "Name": "vlan_1114_10.81.14",
      "Description": "vlan_1114_10.81.14",
      "Gateway": "10.81.14.1",
      "Location": "UN1",
      "AccountAlias": "UNK"
    },
    {
      "Name": "vlan_1241_10.81.141",
      "Description": "vlan_1241_10.81.141",
      "Gateway": "10.81.141.1",
      "Location": "UN1",
      "AccountAlias": "UNK"
    }
  ],
  "Success": true,
  "Message": "Networks successfully queried.",
  "StatusCode": 0
}

XML

<GetNetworksResponse Success="true" Message="Networks successfully queried." StatusCode="0">
    <Networks>
        <Network Name="vlan_1114_10.81.14" Description="vlan_1114_10.81.14" Gateway="10.81.14.1" Location="UN1" AccountAlias="UNK"/>
        <Network Name="vlan_1241_10.81.141" Description="vlan_1241_10.81.141" Gateway="10.81.141.1" Location="UN1" AccountAlias="UNK"/>
    </Networks>
</GetNetworksResponse>

Status Codes

Configures firewall settings on a public IP Address.

URL

REST: https://api.ctl.io/REST/Network/UpdatePublicIPAddress/<format> (format = XML | JSON)
SOAP: https://api.ctl.io/SOAP/Network.asmx?op=UpdatePublicIPAddress

Request

Attributes

Examples

JSON

{
  "AccountAlias": "SUB1",
  "ServerName": "WA1T3NWEB01",
  "PublicIPAddress": "1.1.1.1",
  "AllowHTTP": true,
  "AllowHTTPonPort8080": false,
  "AllowHTTPS": false,
  "AllowFTP": false,
  "AllowFTPS": false,
  "AllowSFTP": false,
  "AllowSSH": false,
  "AllowRDP": false
}

XML

<UpdateIPAddressRequest>
    <AccountAlias>SUB1</AccountAlias>
    <ServerName>WA1T3NWEB01</ServerName>
    <PublicIPAddress>1.1.1.1</PublicIPAddress>
    <AllowHTTP>true</AllowHTTP>
    <AllowHTTPonPort8080>false</AllowHTTPonPort8080>
    <AllowHTTPS>false</AllowHTTPS>
    <AllowFTP>false</AllowFTP>
    <AllowFTPS>false</AllowFTPS>
    <AllowSFTP>false</AllowSFTP>
    <AllowSSH>false</AllowSSH>
    <AllowRDP>false</AllowRDP>
</UpdateIPAddressRequest>

Response

Attributes

Examples

JSON

{
  "Success": true,
  "Message": "Success",
  "StatusCode": 0,
  "RequestID": 1
}

XML

<QueuedItemResponse Success="true" Message="Success" StatusCode="0" RequestID="1" />

Status Codes

This method can be used to check the status of any of the long running requests which must be performed asynchronously.

NOTE: This Queue is not the same as the Blueprint Queue. For operations related to the Blueprint Queue, please reference Blueprint/GetDeploymentStatus.

URL

REST: https://api.ctl.io/REST/Queue/GetRequestStatus/<format> (format = XML | JSON)

Request

Attributes

Examples

XML

<QueueStatusRequest>
    <RequestID>50</RequestID>
</QueueStatusRequest>

JSON

{"RequestID":"50"}

Response

Attributes

Examples

XML

<QueueStatusResponse Success="true" Message="Request Status successfully retrieved." StatusCode="0">  
     <RequestDetails RequestID="50" RequestTitle="Creating Server UT1XXLAB01" ProgressDesc="Request completed" StatusDate="2010-05-28T18:48:49.527" PercentComplete="100" CurrentStatus="Succeeded" StepNumber="0" />
</QueueStatusResponse>

JSON

{
  "RequestDetails": {
    "RequestID":50,
    "RequestTitle":"Creating Server UT1XXLAB01",
    "ProgressDesc":"Request completed",
    "StatusDate":"\/Date(1275097729527)\/",
    "PercentComplete":100,
    "CurrentStatus":"Succeeded",
    "StepNumber":0
  },
  "Success":true,
  "Message":"Request Status successfully retrieved.",
  "StatusCode":0
}

Status Codes

This method can be used to get a list of Queued requests and their current status details.

NOTE: This Queue is not the same as the Blueprint Queue. For operations related to the Blueprint Queue, please reference Blueprint/GetDeploymentStatus.

URL

REST: https://api.ctl.io/REST/Queue/ListQueueRequests/<format> (format = XML | JSON)

Request

Attributes

Examples

XML

<ListQueueItemsRequest>
    <ItemStatusType>1</ItemStatusType>
</ListQueueItemsRequest>

JSON

{
  "ItemStatusType":"1"
}

Response

Attributes

Examples

XML

<ListQueueItemsResponse Success="true" Message="3 Queue requests were found for your account" StatusCode="0">
    <Requests>
        <QueueItem RequestID="106" RequestTitle="Installing SQL Server on WA1XXLAB01" ProgressDesc="Request completed" StatusDate="2010-06-15T22:31:33.633" PercentComplete="100" CurrentStatus="Succeeded" StepNumber="0" />
        <QueueItem RequestID="105" RequestTitle="Creating Server WA1XXPREM01" ProgressDesc="Request completed" StatusDate="2010-06-15T16:11:03.083" PercentComplete="100" CurrentStatus="Succeeded" StepNumber="0" />
        <QueueItem RequestID="104" RequestTitle="Creating Lab Server WA1XXLAB01" ProgressDesc="Request completed" StatusDate="2010-06-15T15:59:10.76" PercentComplete="100" CurrentStatus="Succeeded" StepNumber="0" />
    </Requests>
</ListQueueItemsResponse>

JSON

{
  "Requests": [
    {
      "RequestID":106,
      "RequestTitle":"Installing SQL Server on WA1XXLAB01",
      "ProgressDesc":"Request completed",
      "StatusDate":"\/Date(1276666293633)\/",
      "PercentComplete":100,
      "CurrentStatus":"Succeeded",
      "StepNumber":0
    },
    {
      "RequestID":105,
      "RequestTitle":"Creating Server WA1XXPREM01",
      "ProgressDesc":"Request completed",
      "StatusDate":"\/Date(1276643463083)\/",
      "PercentComplete":100,
      "CurrentStatus":"Succeeded",
      "StepNumber":0
    },
    {
      "RequestID":104,
      "RequestTitle":"Creating Lab Server WA1XXLAB01",
      "ProgressDesc":"Request completed",
      "StatusDate":"\/Date(1276642750760)\/",
      "PercentComplete":100,
      "CurrentStatus":"Succeeded",
      "StepNumber":0
    }
  ],
  "Success":true,
  "Message":"15 Queue requests were found for your account",
  "StatusCode":0
}

Status Codes

Many operations performed by the API are actually long running tasks, for example making a change to a firewall or publishing a package. As a result, these tasks are performed asynchronously. All of the operations which need to be processed asynchronously will return a RequestID property in their responses. The Queue API allows you to query into the queue to get the status of your requests using this RequestID. Many of these operations also send email notifications upon completion.

NOTE: This Queue is not the same as the Blueprint Queue. For operations related to the Blueprint Queue, please reference Blueprint/GetDeploymentStatus.

The URL to the SOAP version of the Queue API can be found at https://api.ctl.io/soap/Queue.asmx and the WSDL can be found here.

Archives the server.

URL

REST: https://api.ctl.io/REST/Server/ArchiveServer/<format> (format = XML | JSON)
SOAP: https://api.ctl.io/SOAP/Server.asmx?op=ArchiveServer

Request

Attributes

Examples

JSON

{
  "AccountAlias":"UNK",
  "Name": "SERVER01"
}

XML

<ServerRequest>
    <AccountAlias>UNK</AccountAlias>
    <Name>SERVER01</Name>
</ServerRequest>

Response

Attributes

Examples

JSON

{
  "RequestID:1,
  "Success":true,
  "Message":"Success",
  "StatusCode":0
}

XML

<QueuedItemResponse Success="true" Message="Success" StatusCode="0">
    <RequestID>1</RequestID>
</QueuedItemResponse>

Status Codes

Updates the Admin/Root password for a Server.

URL

REST: https://api.ctl.io/REST/Server/ChangePassword/<format> (format = XML | JSON)
SOAP: https://api.ctl.io/SOAP/Server.asmx?op=ChangePassword

Request

Attributes

Examples

JSON

{
  "AccountAlias": "UNK",
  "Name": "WA1T3NWEB01",
  "CurrentPassword": "password",
  "NewPassword": "newPassword"
}

XML

<ChangePasswordRequest>
    <AccountAlias>UNK</AccountAlias>
    <Name>QA1FMACC554L01</Name>
    <CurrentPassword>password</CurrentPassword>
    <NewPassword>newPassword</NewPassword>
</ChangePasswordRequest>

Response

Attributes

Examples

JSON

{
  "Success":true,
  "Message":"Success",
  "StatusCode":0
}

XML

<APIResponse Success="true" Message="Success" StatusCode="0" />

Status Codes

Configures the CPU, Memory, Group and additional storage for a Server.

URL

REST: https://api.ctl.io/REST/Server/ConfigureServer/<format> (format = XML | JSON)
SOAP: https://api.ctl.io/SOAP/Server.asmx?op=ConfigureServer

Request

Attributes

CustomField Attributes

Examples

JSON

{
  "AccountAlias": "UNK",
  "Name": "WA1T3NWEB01",
  "HardwareGroupUUID": "8a03fbae8ddfe311b05f00505682315a",
  "Cpu": 2,
  "MemoryGB": 4,
  "AdditionalStorageGB": 50,
  "CustomFields": [
    { "ID": "ea97c6e09f604eb689dcdc080114b04d","Value": "A test"},
    { "ID": "b9f454f2ae664998acc3302b24330c5b","Value": "2"},
    { "ID": "d1f12de4ce4b4685b72ba632db0685c6","Value": "true"}
  ]
}

XML

<ConfigureServerRequest>
    <AccountAlias>UNK</AccountAlias>
    <Name>WEB</Name>
    <HardwareGroupUUID>8a03fbae8ddfe311b05f00505682315a</HardwareGroupUUID>
    <Cpu>2</Cpu>
    <MemoryGB>4</MemoryGB>
    <AdditionalStorageGB>50</AdditionalStorageGB>
    <CustomFields ID="ea97c6e09f604eb689dcdc080114b04d" Value="Test text" />
    <CustomFields ID="b9f454f2ae664998acc3302b24330c5b" Value="2" />
    <CustomFields ID="d1f12de4ce4b4685b72ba632db0685c6" Value="true" />
</ConfigureServerRequest>

Response

Attributes

Examples

JSON

{
  "RequestID":1,
  "Success":true,
  "Message":"Success",
  "StatusCode":0
}

XML

<QueuedItemResponse Success="true" Message="Success" StatusCode="0">
    <RequestID>1</RequestID>
</QueuedItemResponse>

Status Codes

Converts the server to a template.

URL

REST: https://api.ctl.io/REST/Server/ConvertServerToTemplate/<format> (format = XML | JSON)
SOAP: https://api.ctl.io/SOAP/Server.asmx?op=ConvertServerToTemplate

Request

Attributes

Examples

JSON

{
  "Name": "WA1T3NWEB01",
  "AccountAlias": "UNK",
  "Password": "password",
  "TemplateAlias": "TEMP"
}

XML

<ConvertServerToTemplateRequest>
    <AccountAlias>ACCT</AccountAlias>
    <Name>WEB</Name>
    <Password>password</Password>
    <TemplateAlias>TEMP</TemplateAlias>
</ConvertServerToTemplateRequest>

Response

Attributes

Examples

JSON

{
  "RequestID":1,
  "Success":true,
  "Message":"Success",
  "StatusCode":0
}

XML

<QueuedItemResponse Success="true" Message="Success" StatusCode="0">
    <RequestID>1</RequestID>
</QueuedItemResponse>

Status Codes

Converts the Template to a Server.

URL

REST: https://api.ctl.io/REST/Server/ConvertTemplateToServer/<format> (format = XML | JSON)
SOAP: https://api.ctl.io/SOAP/Server.asmx?op=ConvertTemplateToServer

Request

Attributes

Examples

JSON

{
  "AccountAlias": "UNK",
  "Name": "WA1T3NWEB01",
  "Password": "password",
  "HardwareGroupUUID": "b7e44f0391824d408732f215a91a0578",
  "Network": "VLAN113_172.21.113"

}

XML

<ConvertTemplateToServerRequest>
    <AccountAlias>ACCT</AccountAlias>
    <Name>WEB</Name>
    <Password>password</Password>
    <HardwareGroupUUID>b7e44f0391824d408732f215a91a0578</HardwareGroupUUID>
    <Network>VLAN113_172.21.113</Network>
</ConvertTemplateToServerRequest>

Response

Attributes

Examples

JSON

{
  "RequestID":1,
  "Success":true,
  "Message":"Success",
  "StatusCode":0
}

XML

<QueuedItemResponse Success="true" Message="Success" StatusCode="0">
    <RequestID>1</RequestID>
</QueuedItemResponse>

Status Codes

Creates a new Server.

URL

REST: https://api.ctl.io/REST/Server/CreateServer/<format> (format = XML | JSON)
SOAP: https://api.ctl.io/SOAP/Server.asmx?op=CreateServer

Request

Attributes

CustomField Attributes

Examples

JSON

{
  "AccountAlias": "UNK",
  "LocationAlias": "UN1",
  "Template": "WIN2K8R2",
  "Alias": "WEB",
  "Description": "Web server",
  "HardwareGroupUUID": "8a03fbae8ddfe311b05f00505682315a",
  "ServerType": 1,
  "ServiceLevel": 2,
  "Cpu": 2,
  "MemoryGB": 4,
  "ExtraDriveGB": 50,
  "PrimaryDns": "4.2.2.2",
  "SecondaryDns": "4.2.2.3",
  "Network": "VLAN113_172.21.113",
  "CustomFields": [
    { "ID": "ea97c6e09f604eb689dcdc080114b04d","Value": "A test"},
    { "ID": "b9f454f2ae664998acc3302b24330c5b","Value": "2"},
    { "ID": "d1f12de4ce4b4685b72ba632db0685c6","Value": "true"}
  ]
}

XML

<CreateServerRequest>
    <AccountAlias>ACCT</AccountAlias>
    <LocationAlias>QA1</LocationAlias>
    <Template>UBUNTU-10-32-TEMPLATE</Template>
    <MemoryGB>1</MemoryGB>
    <Cpu>1</Cpu>
    <HardwareGroupUUID>8a03fbae8ddfe311b05f00505682315a</HardwareGroupUUID>
    <Alias>WHEE</Alias>
    <Description>Web server</Description>
    <ExtraDriveGB>0</ExtraDriveGB>
    <PrimaryDns>172.17.1.26</PrimaryDns>
    <SecondaryDns>172.17.1.27</SecondaryDns>
    <Network>vlan199_172.21.199</Network>
    <Password>Pass@word1</Password>
    <ServerType>1</ServerType>
    <ServiceLevel>2</ServiceLevel>
    <CustomFields ID="ea97c6e09f604eb689dcdc080114b04d" Value="Test text" />
    <CustomFields ID="b9f454f2ae664998acc3302b24330c5b" Value="2" />
    <CustomFields ID="d1f12de4ce4b4685b72ba632db0685c6" Value="true" />
</CreateServerRequest>

Response

Attributes

Examples

JSON

{
  "RequestID":1,
  "Success":true,
  "Message":"Success",
  "StatusCode":0
}

XML

<QueuedItemResponse Success="true" Message="Success" StatusCode="0">
    <RequestID>1</RequestID>
</QueuedItemResponse>

Status Codes

Deletes a disk on a Server.

URL

REST: https://api.ctl.io/REST/Server/DeleteDisk/<format> (format = XML | JSON)
SOAP: https://api.ctl.io/SOAP/Server.asmx?op=DeleteDisk

Request

Attributes

Examples

{
  "AccountAlias": "UNK",
  "Name": "WA1UNKWEB01",
  "ScsiBusID": "0",
  "ScsiDeviceID": "1",
  "OverrideFailsafes": false
}

XML

<DeleteDiskRequest>
    <AccountAlias>UNK</AccountAlias>
    <Name>WA1UNKWEB01</Name>
    <ScsiBusID>0</ScsiBusID>
    <ScsiDeviceID>1</ScsiDeviceID>
    <OverrideFailsafes>false</OverrideFailsafes>
</DeleteDiskRequest>

Response

Attributes

Examples

JSON

{
    "RequestID":1,
    "Success":true,
    "Message":"Success",
    "StatusCode":0
}

XML

<QueuedItemResponse Success="true" Message="Success" StatusCode="0">
    <RequestID>1</RequestID>
</QueuedItemResponse>

Status Codes

Deletes the machine and releases all associated resources.

URL

REST: https://api.ctl.io/REST/Server/DeleteServer/<format> (format = XML | JSON)
SOAP: https://api.ctl.io/SOAP/Server.asmx?op=DeleteServer

Request

Attributes

Examples

JSON

{
  "AccountAlias": "ACCT",
  "Name": "DC1ACCTSVR01"
}

XML

<ServerRequest>
    <AccountAlias>UNK</AccountAlias>
    <Name>SERVER01</Name>
</ServerRequest>

Response

Attributes

Examples

JSON

{
  "RequestID:1,
  "Success":true,
  "Message":"Success",
  "StatusCode":0
}

XML

<QueuedItemResponse Success="true" Message="Success" StatusCode="0">
    <RequestID>1</RequestID>
</QueuedItemResponse>

Status Codes

Deletes a named snapshot for a specified server.

URL

REST: https://api.ctl.io/REST/Server/DeleteSnapshot/<format> (format = XML | JSON)
SOAP: https://api.ctl.io/SOAP/Server.asmx?op=DeleteSnapshot

Request

Attributes

Examples

JSON

{
  "AccountAlias": "UNK",
  "Name": "1",
  "SnapshotName": "2012-01-01-12:00:00"
}

XML

<SnapshotRequest>
    <AccountAlias>ACCT</AccountAlias>
    <Name>SERVER01</Name>
    <SnapshotName>2012-01-01-12:00:00</SnapshotName>
</SnapshotRequest>

Response

Attribute

Examples

JSON

{
  "Success":true,
  "Message":"Success",
  "StatusCode":0
}

XML

<APIResponse Success="true" Message="Success" StatusCode="0"/>

Status Codes

Deletes the Template with the specified name.

URL

REST: https://api.ctl.io/REST/Server/DeleteTemplate/<format> (format = XML | JSON)
SOAP: https://api.ctl.io/SOAP/Server.asmx?op=DeleteTemplate

Request

Attributes

Examples

JSON

{
  "AccountAlias": "ACCT",
  "Name": "TEMPLATENAME01"
}

XML

<ServerRequest>
    <AccountAlias>UNK</AccountAlias>
    <Name>TEMPLATENAME01</Name>
</ServerRequest>

Response

Attributes

Examples

JSON

{
  "RequestID:1,
  "Success":true,
  "Message":"Success",
  "StatusCode":0
}

XML

<QueuedItemResponse Success="true" Message="Success" StatusCode="0">
    <RequestID>1</RequestID>
</QueuedItemResponse>

Status Codes

Gets a deep list of all modified Servers for a given Hardware Group and its sub groups, or all Servers for a given location. To get all servers that have changed since a certain date, only provide a BeginDate and omit the EndDate.

URL

REST: https://api.ctl.io/REST/Server/GetAllServersByModifiedDates/<format> (format = XML | JSON)
SOAP: https://api.ctl.io/SOAP/Server.asmx?op=GetAllServersByModifiedDatesResponseMsg

Request

Attributes

Examples

JSON

{
  "AccountAlias": "ACCT",
  "Location": "WA1",
  "BeginDate": "2013-05-01",
  "EndDate": "2013-06-30"
}

XML

<GetAllServersRequest>
    <AccountAlias>ACCT</AccountAlias>
    <Location>WA1</Location>
    <BeginDate>2013-05-01</BeginDate>
    <EndDate>2013-06-30</EndDate>
</GetAllServersRequest>

Response

Attributes

Examples

JSON

{
  "Success":true,
  "Message":"Success",
  "StatusCode":0,
  "Servers": [
    {
      "ID":-1,
      "HardwareGroupID":1,
      "HardwareGroupUUID":"8a03fbae8ddfe311b05f00505682315a",
      "Name":"WA1T3NWEB01",
      "Description":"WA1T3NWEB01",
      "DnsName":"WA1T3NWEB01",
      "IsTemplate":false,
      "Cpu":2,
      "MemoryGB":4,
      "DiskCount":3,
      "TotalDiskSpaceGB":116,
      "Status":"Active",
      "ServerType":"2",
      "ServiceLevel":"1",
      "OperatingSystem":4,
      "PowerState":"Started",
      "Location":"WA1",
      "IPAddress":"172.0.0.1"
      "IPAddresses:[
        {"Address":"172.0.0.1", "AddressType":1}
      ],
      "CustomFields":[
        { "ID":"9f4150b68d4340cca652a209a4b32c34", "CustomFieldID": -1, "Name": "My Field", "Type": "Text", "Value": "A test"},
        { "ID":"393a0aafd15d47118d57dde0a3d556e3", "CustomFieldID": -1, "Name": "My Field 2", "Type": "Option", "Value": "2"},
        { "ID":"7997a9c0181644c99e490c5c465cf297", "CustomFieldID": -1, "Name": "My Field 3", "Type": "Checkbox", "Value": "true"}
      ]
    }
  ]
}

XML

<GetServersResponse Success="true" Message="Successfully retrieved servers" StatusCode="0">
    <Servers>
        <Server ID="-1" HardwareGroupID="1" HardwareGroupUUID="8a03fbae8ddfe311b05f00505682315a"
          Name="WA1T3NWEB01" Description="WA1T3NWEB01" DnsName="WA1T3NWEB01"
          IsHyperscale="false" IsTemplate="false" Cpu="2" MemoryGB="4" DiskCount="3"
          TotalDiskSpaceGB="116" Status="Active" ServerType="1" ServiceLevel="2"
          OperatingSystem="2" PowerState="Started" Location="WA1" IPAddress="172.0.0.1">
            <IPAddresses>
                <IPAddress Address="172.0.0.1" AddressType="RIP" />
            </IPAddresses>
            <CustomFields ID="9f4150b68d4340cca652a209a4b32c34" CustomFieldID="-1" Name="My Field" Type="Text" Value="Test Value" />
            <CustomFields ID="393a0aafd15d47118d57dde0a3d556e3" CustomFieldID="-1" Name="My 2nd Field" Type="Option" Value="Value 3" />
            <CustomFields ID="7997a9c0181644c99e490c5c465cf297" CustomFieldID="-1" Name="My 3rd Field" Type="Checkbox" Value="true" />
        </Server>
    </Servers>
</GetServersResponse>

Status Codes

Gets a deep list of all modified servers for a given account hierarchy within a given data center. Use this operation to get a full list of all servers contained within an account and all its subaccounts. To get all servers that have changed since a certain date, only provide a BeginDate and omit the EndDate.

URL

REST: https://api.ctl.io/REST/Server/GetAllServersForAccountHierarchyByModifiedDates/<format> (format = XML | JSON)
SOAP: https://api.ctl.io/SOAP/Server.asmx?op=GetAllServersForAccountHierarchyByModifiedDatesMsg

Request

Attributes

Examples

JSON

{
  "AccountAlias": "ACCT",
  "Location": "WA1",
  "BeginDate": "2013-05-01",
  "EndDate": "2013-06-30"
}

XML

<GetAllServersByModifiedDatesRequest>
    <AccountAlias>ACCT</AccountAlias>
    <Location>WA1</Location>
    <BeginDate>2013-05-01</BeginDate>
    <EndDate>2013-06-30</EndDate>
</GetAllServersByModifiedDatesRequest>

Response

Attributes

Examples

JSON

{
  "AccountServers":[
    {
      "AccountAlias":"ACT1",
      "Servers":[
        {
          "ID":-1,
          "HardwareGroupID":1197,
          "HardwareGroupUUID":"8a03fbae8ddfe311b05f00505682315a",
          "Location":"WA1",
          "Name":"SERVERDEMO01",
          "Description":"Demo server",
          "DnsName":"",
          "IsTemplate":false,
          "Cpu":1,
          "MemoryGB":2,
          "DiskCount":1,
          "TotalDiskSpaceGB":24,
          "Status":"UnderConstruction",
          "PowerState":"Stopped",
          "InMaintenanceMode":false,
          "IPAddress":"",
          "ServerType":1,
          "ServiceLevel":2,
          "OperatingSystem":18,
          "DateModified":"\/Date(1347577422943)\/",
          "ModifiedBy":"user@company.com",
          "IPAddresses":[
            {"Address":"142.25.114.13", "AddressType":"RIP"}
          ],
          "CustomFields":null
        }
      ]
    },
    {
      "AccountAlias":"ACT2",
      "Servers":[
        {
          "ID":-1,
          "HardwareGroupID":1595,
          "HardwareGroupUUID":"b9f454f2ae664998acc3302b24330c5b",
          "Location":"WA1",
          "Name":"SERVERDEMO03",
          "Description":"demo server",
          "DnsName":"QA1SSUBSERO9401",
          "IsTemplate":false,
          "Cpu":1,
          "MemoryGB":1,
          "DiskCount":3,
          "TotalDiskSpaceGB":17,
          "Status":"Active",
          "PowerState":"Started",
          "InMaintenanceMode":false,
          "IPAddress":"173.25.114.15","ServerType":1,"ServiceLevel":2,"OperatingSystem":20,
          "DateModified":"\/Date(1372476852953)\/","ModifiedBy":"user@company.com",
          "IPAddresses":[
            {"Address":"173.25.114.15", "AddressType":"RIP"}
          ],
          "CustomFields":null
        }
      ]
    }
  ],
  "Success":true,
  "Message":"Successfully retrieved deep view of servers",
  "StatusCode":0
}

XML

<GetAccountHierarchyServersResponse Success="true" Message="Successfully retrieved deep view of servers" StatusCode="0">
  <AccountServers>
    <AccountServerGroup AccountAlias="ACT1">
      <Servers>
        <Server
          ID="-1"
          HardwareGroupID="1197"
          HardwareGroupUUID="8a03fbae8ddfe311b05f00505682315a"
          Location="WA1"
          Name="SERVERDEMO01"
          Description="Server1"
          DnsName=""
          IsTemplate="false"
          Cpu="1"
          MemoryGB="2"
          DiskCount="1"
          TotalDiskSpaceGB="24"
          Status="UnderConstruction"
          PowerState="Stopped"
          InMaintenanceMode="false"
          IPAddress=""
          ServerType="1"
          ServiceLevel="2"
          OperatingSystem="18"
          DateModified="2012-09-13T16:03:42.943"
          ModifiedBy="user@company.com">
          <IPAddresses  Address="142.25.114.13"  AddressType="RIP" />
        </Server>
      </Servers>
    </AccountServerGroup>
    <AccountServerGroup AccountAlias="ACT2">
      <Servers>
        <Server
          ID="-1"
          HardwareGroupID="1595"
          HardwareGroupUUID="b9f454f2ae664998acc3302b24330c5b"
          Location="WA1"
          Name="SERVERDEMO03"
          Description="Server 3"
          DnsName="SERVERDEMO03"
          IsTemplate="false"
          Cpu="1"
          MemoryGB="1"
          DiskCount="3"
          TotalDiskSpaceGB="17"
          Status="Active"
          PowerState="Started"
          InMaintenanceMode="false"
          IPAddress="173.25.114.15"
          ServerType="1"
          ServiceLevel="2"
          OperatingSystem="20"
          DateModified="2013-06-28T20:34:12.953"
          ModifiedBy="user@company.com">
        </Server>
      </Servers>
    </AccountServerGroup>
  </AccountServers>
</GetAccountHierarchyServersResponse>

Status Codes

Gets a deep list of all servers for a given account hierarchy within a given data center. Use this operation to get a full list of all servers contained within an account and all its subaccounts.

URL

REST: https://api.ctl.io/REST/Server/GetAllServersForAccountHierarchy/<format> (format = XML | JSON)
SOAP: https://api.ctl.io/SOAP/Server.asmx?op=GetAllServersForAccountHierarchyMsg

Request

Attributes

Examples

JSON

{
  "AccountAlias": "ACCT",
  "Location": "WA1"
}

XML

<GetAllServersRequest>
    <AccountAlias>ACCT</AccountAlias>
    <Location>WA1</Location>
</GetAllServersRequest>

Response

Attributes

Examples

JSON

{
  "AccountServers":[
    {
      "AccountAlias":"ACT1",
      "Servers":[
        {
          "ID":-1,
          "HardwareGroupID":1197,
          "HardwareGroupUUID":"8a03fbae8ddfe311b05f00505682315a",
          "Location":"WA1",
          "Name":"SERVERDEMO01",
          "Description":"Demo server",
          "DnsName":"",
          "IsTemplate":false,
          "Cpu":1,
          "MemoryGB":2,
          "DiskCount":1,
          "TotalDiskSpaceGB":24,
          "Status":"UnderConstruction",
          "PowerState":"Stopped",
          "InMaintenanceMode":false,
          "IPAddress":"",
          "ServerType":1,
          "ServiceLevel":2,
          "OperatingSystem":18,
          "DateModified":"\/Date(1347577422943)\/",
          "ModifiedBy":"user@company.com",
          "IPAddresses":[
            {"Address":"142.25.114.13", "AddressType":"RIP"}
          ],
          "CustomFields":null
        }
      ]
    },
    {
      "AccountAlias":"ACT2",
      "Servers":[
        {
          "ID":-1,
          "HardwareGroupID":1595,
          "HardwareGroupUUID":"b9f454f2ae664998acc3302b24330c5b",
          "Location":"WA1",
          "Name":"SERVERDEMO03",
          "Description":"demo server",
          "DnsName":"QA1SSUBSERO9401",
          "IsTemplate":false,
          "Cpu":1,
          "MemoryGB":1,
          "DiskCount":3,
          "TotalDiskSpaceGB":17,
          "Status":"Active",
          "PowerState":"Started",
          "InMaintenanceMode":false,
          "IPAddress":"173.25.114.15","ServerType":1,"ServiceLevel":2,"OperatingSystem":20,
          "DateModified":"\/Date(1372476852953)\/","ModifiedBy":"user@company.com",
          "IPAddresses":[
            {"Address":"173.25.114.15", "AddressType":"RIP"}
          ],
          "CustomFields":null
        }
      ]
    }
  ],
  "Success":true,
  "Message":"Successfully retrieved deep view of servers",
  "StatusCode":0
}

XML

<GetAccountHierarchyServersResponse Success="true" Message="Successfully retrieved deep view of servers" StatusCode="0">
  <AccountServers>
    <AccountServerGroup AccountAlias="ACT1">
      <Servers>
        <Server
          ID="-1"
          HardwareGroupID="1197"
          HardwareGroupUUID="8a03fbae8ddfe311b05f00505682315a"
          Location="WA1"
          Name="SERVERDEMO01"
          Description="Server1"
          DnsName=""
          IsTemplate="false"
          Cpu="1"
          MemoryGB="2"
          DiskCount="1"
          TotalDiskSpaceGB="24"
          Status="UnderConstruction"
          PowerState="Stopped"
          InMaintenanceMode="false"
          IPAddress=""
          ServerType="1"
          ServiceLevel="2"
          OperatingSystem="18"
          DateModified="2012-09-13T16:03:42.943"
          ModifiedBy="user@company.com">
          <IPAddresses  Address="142.25.114.13"  AddressType="RIP" />
        </Server>
      </Servers>
    </AccountServerGroup>
    <AccountServerGroup AccountAlias="ACT2">
      <Servers>
        <Server
          ID="-1"
          HardwareGroupID="1595"
          HardwareGroupUUID="b9f454f2ae664998acc3302b24330c5b"
          Location="WA1"
          Name="SERVERDEMO03"
          Description="Server 3"
          DnsName="SERVERDEMO03"
          IsTemplate="false"
          Cpu="1"
          MemoryGB="1"
          DiskCount="3"
          TotalDiskSpaceGB="17"
          Status="Active"
          PowerState="Started"
          InMaintenanceMode="false"
          IPAddress="173.25.114.15"
          ServerType="1"
          ServiceLevel="2"
          OperatingSystem="20"
          DateModified="2013-06-28T20:34:12.953"
          ModifiedBy="user@company.com">
        </Server>
      </Servers>
    </AccountServerGroup>
  </AccountServers>
</GetAccountHierarchyServersResponse>

Status Codes

Gets a deep list of all Servers for a given Hardware Group and its sub groups, or all Servers for a given location.

URL

REST: https://api.ctl.io/REST/Server/GetAllServers/<format> (format = XML | JSON)
SOAP: https://api.ctl.io/SOAP/Server.asmx?op=GetAllServersResponseMsg

Request

Attributes

Examples

JSON

{
  "AccountAlias":"ACCT",
  "HardwareGroupUUID": "8a03fbae8ddfe311b05f00505682315a",
  "Location": "WA1"
}

XML

<GetAllServersRequest>
    <AccountAlias>ACCT</AccountAlias>
    <HardwareGroupUUID>8a03fbae8ddfe311b05f00505682315a</HardwareGroupUUID>
    <Location>WA1</Location>
</GetAllServersRequest>

Response

Attributes

Examples

JSON

{
  "Success":true,
  "Message":"Success",
  "StatusCode":0,
  "Servers": [
    {
      "ID":-1,
      "HardwareGroupID":1,
      "HardwareGroupUUID":"8a03fbae8ddfe311b05f00505682315a",
      "Name":"WA1T3NWEB01",
      "Description":"WA1T3NWEB01",
      "DnsName":"WA1T3NWEB01",
      "IsTemplate":false,
      "Cpu":2,
      "MemoryGB":4,
      "DiskCount":3,
      "TotalDiskSpaceGB":116,
      "Status":"Active",
      "ServerType":"2",
      "ServiceLevel":"1",
      "OperatingSystem":4,
      "PowerState":"Started",
      "Location":"WA1",
      "IPAddress":"172.0.0.1"
      "IPAddresses:[
        {"Address":"172.0.0.1", "AddressType":1}
      ],
      "CustomFields":[
        { "ID":"9f4150b68d4340cca652a209a4b32c34", "CustomFieldID": -1, "Name": "My Field", "Type": "Text", "Value": "A test"},
        { "ID":"393a0aafd15d47118d57dde0a3d556e3", "CustomFieldID": -1, "Name": "My Field 2", "Type": "Option", "Value": "2"},
        { "ID":"7997a9c0181644c99e490c5c465cf297", "CustomFieldID": -1, "Name": "My Field 3", "Type": "Checkbox", "Value": "true"}
      ]
    },
    {
      "ID":-1,
      "HardwareGroupID":1,
      "HardwareGroupUUID":"8a03fbae8ddfe311b05f00505682315a",
      "Name":"WA1T3NWEB02",
      "Description":"WA1T3NWEB02",
      "DnsName":"WA1T3NWEB02",
      "IsTemplate":false,
      "Cpu":2,
      "MemoryGB":4,
      "DiskCount":3,
      "TotalDiskSpaceGB":116,
      "Status":"Active",
      "ServerType":"1",
      "ServiceLevel":"2",
      "OperatingSystem":6,
      "PowerState":"Started",
      "Location":"WA1",
      "IPAddress":"172.0.0.2",
      "IPAddresses: [
        {"Address":"172.0.0.2", "AddressType":1}
      ],
      "CustomFields": []
    }
  ]
}

XML

<GetServersResponse Success="true" Message="Successfully retrieved servers" StatusCode="0">
    <Servers>
        <Server ID="-1" HardwareGroupID="1" HardwareGroupUUID="8a03fbae8ddfe311b05f00505682315a"
          Name="WA1T3NWEB01" Description="WA1T3NWEB01" DnsName="WA1T3NWEB01"
          IsHyperscale="false" IsTemplate="false" Cpu="2" MemoryGB="4" DiskCount="3"
          TotalDiskSpaceGB="116" Status="Active" ServerType="1" ServiceLevel="2"
          OperatingSystem="2" PowerState="Started" Location="WA1" IPAddress="172.0.0.1">
            <IPAddresses>
                <IPAddress Address="172.0.0.1" AddressType="RIP" />
            </IPAddresses>
            <CustomFields ID="9f4150b68d4340cca652a209a4b32c34" CustomFieldID="-1" Name="My Field" Type="Text" Value="Test Value" />
            <CustomFields ID="393a0aafd15d47118d57dde0a3d556e3" CustomFieldID="-1" Name="My 2nd Field" Type="Option" Value="Value 3" />
            <CustomFields ID="7997a9c0181644c99e490c5c465cf297" CustomFieldID="-1" Name="My 3rd Field" Type="Checkbox" Value="true" />
        </Server>
        <Server ID="-1" HardwareGroupID="1" HardwareGroupUUID="8a03fbae8ddfe311b05f00505682315a"
          Name="WA1T3NWEB02" Description="WA1T3NWEB02" DnsName="WA1T3NWEB02"
          IsHyperscale="false" IsTemplate="false" Cpu="2" MemoryGB="4" DiskCount="3"
          TotalDiskSpaceGB="116" Status="Active" ServerType="1" ServiceLevel="2"
          OperatingSystem="2" PowerState="Started" Location="WA1" IPAddress="172.0.0.2">
            <IPAddresses>
                <IPAddress Address="172.0.0.2" AddressType="RIP"/>
            </IPAddresses>
            <CustomFields />
       </Server>
    </Servers>
</GetServersResponse>

Status Codes