diff --git a/reference/datatypes/SoftLayer_Account_Historical_Report/index.html b/reference/datatypes/SoftLayer_Account_Historical_Report/index.html deleted file mode 100644 index dd7bb774ed9..00000000000 --- a/reference/datatypes/SoftLayer_Account_Historical_Report/index.html +++ /dev/null @@ -1,296 +0,0 @@ - - - - - - - - - - - - SoftLayer_Account_Historical_Report - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Account_Historical_Report

-
-
-
-
-
- Classes - - SoftLayer_Account_Historical_Report - -
- Tags - - datatype - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Account_Historical_Report

- -
- -
- - -

Description

- - - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- -
-
-

Relational

- - - -

Count

- -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Account_Link_OpenStack/index.html b/reference/datatypes/SoftLayer_Account_Link_OpenStack/index.html deleted file mode 100644 index 05872eb19c6..00000000000 --- a/reference/datatypes/SoftLayer_Account_Link_OpenStack/index.html +++ /dev/null @@ -1,576 +0,0 @@ - - - - - - - - - - - - SoftLayer_Account_Link_OpenStack - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Account_Link_OpenStack

-
-
-
-
-
- Classes - - SoftLayer_Account_Link_OpenStack - -
- Tags - - datatype - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Account_Link_OpenStack

- -
- -
- - -

Description

- - - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - - - -
-
-

accountId

-

- - None - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

authorizationToken

-

- - Authorization token that’s included on linking calls. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

createDate

-

- - None - -
- - - Type: - - - dateTime - - -

- -
- - - - - -
-
-

destinationAccountAlphanumericId

-

- - None - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

destinationAccountId

-

- - None - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

domainId

-

- - Pseudonym for destinationAccountAlphanumericId - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

id

-

- - None - -
- - - Type: - - - int - - -

- -
- - - - - - - -
-
-

serviceProviderId

-

- - None - -
- - - Type: - - - int - - -

- -
- - -
-
-

Relational

- - - - -
-
-

account

-

- - None - -
- - - Type: - - - SoftLayer_Account - - -

- -
- - - - - - - - - - - - - - - - - - - -
-
-

serviceProvider

-

- - None - -
- - - Type: - - - SoftLayer_Service_Provider - - -

- -
- - - - - - -

Count

- - - - - - - - - - - - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Account_Link_OpenStack_DomainCreationDetails/index.html b/reference/datatypes/SoftLayer_Account_Link_OpenStack_DomainCreationDetails/index.html deleted file mode 100644 index b2cb3355e00..00000000000 --- a/reference/datatypes/SoftLayer_Account_Link_OpenStack_DomainCreationDetails/index.html +++ /dev/null @@ -1,379 +0,0 @@ - - - - - - - - - - - - SoftLayer_Account_Link_OpenStack_DomainCreationDetails - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Account_Link_OpenStack_DomainCreationDetails

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Account_Link_OpenStack_DomainCreationDetails

- -
- -
- - -

Description

- - OpenStack domain creation details - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

domainId

-

- - Id for the domain this user was added to. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

userId

-

- - Id for the user given the Cloud Admin role for this domain. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

userName

-

- - Name for the user given the Cloud Admin role for this domain. - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - - - - - - -

Count

- - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Account_Link_OpenStack_LinkRequest/index.html b/reference/datatypes/SoftLayer_Account_Link_OpenStack_LinkRequest/index.html deleted file mode 100644 index 2b7d23a8ba0..00000000000 --- a/reference/datatypes/SoftLayer_Account_Link_OpenStack_LinkRequest/index.html +++ /dev/null @@ -1,379 +0,0 @@ - - - - - - - - - - - - SoftLayer_Account_Link_OpenStack_LinkRequest - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Account_Link_OpenStack_LinkRequest

-
-
-
-
-
- Classes - - SoftLayer_Account_Link_OpenStack_LinkRequest - -
- Tags - - datatype - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Account_Link_OpenStack_LinkRequest

- -
- -
- - -

Description

- - Details Deprecated. - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

desiredPassword

-

- - Optional password - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

desiredProjectName

-

- - Optional projectName - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

desiredUsername

-

- - Required username - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - - - - - - -

Count

- - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Account_Link_OpenStack_ProjectCreationDetails/index.html b/reference/datatypes/SoftLayer_Account_Link_OpenStack_ProjectCreationDetails/index.html deleted file mode 100644 index 128bf657cfa..00000000000 --- a/reference/datatypes/SoftLayer_Account_Link_OpenStack_ProjectCreationDetails/index.html +++ /dev/null @@ -1,435 +0,0 @@ - - - - - - - - - - - - SoftLayer_Account_Link_OpenStack_ProjectCreationDetails - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Account_Link_OpenStack_ProjectCreationDetails

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Account_Link_OpenStack_ProjectCreationDetails

- -
- -
- - -

Description

- - OpenStack project creation details - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

domainId

-

- - Id for the domain this project was added to. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

projectId

-

- - Id for this project. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

projectName

-

- - Name for this project. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

userId

-

- - Id for the user given the Project Admin role for this project. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

userName

-

- - Name for the user given the Project Admin role for this project. - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - - - - - - - - - - -

Count

- - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Account_Link_OpenStack_ProjectDetails/index.html b/reference/datatypes/SoftLayer_Account_Link_OpenStack_ProjectDetails/index.html deleted file mode 100644 index f3674b93866..00000000000 --- a/reference/datatypes/SoftLayer_Account_Link_OpenStack_ProjectDetails/index.html +++ /dev/null @@ -1,351 +0,0 @@ - - - - - - - - - - - - SoftLayer_Account_Link_OpenStack_ProjectDetails - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Account_Link_OpenStack_ProjectDetails

-
-
-
-
-
- Classes - - SoftLayer_Account_Link_OpenStack_ProjectDetails - -
- Tags - - datatype - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Account_Link_OpenStack_ProjectDetails

- -
- -
- - -

Description

- - OpenStack project details - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

projectId

-

- - Id for this project. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

projectName

-

- - Name for this project. - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - - - - -

Count

- - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Account_Media/index.html b/reference/datatypes/SoftLayer_Account_Media/index.html deleted file mode 100644 index 041e1c6fafc..00000000000 --- a/reference/datatypes/SoftLayer_Account_Media/index.html +++ /dev/null @@ -1,660 +0,0 @@ - - - - - - - - - - - - SoftLayer_Account_Media - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Account_Media

-
-
-
-
-
- Classes - - SoftLayer_Account_Media - -
- Tags - - datatype - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Account_Media

- -
- -
- - -

Description

- - The SoftLayer_Account_Media data type contains information on a single piece of media associated with a Data Transfer Service request. - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - - - - - - - -
-
-

description

-

- - The description of the media. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

id

-

- - The unique id of the media. - -
- - - Type: - - - int - - -

- -
- - - - - - - - - - - -
-
-

requestId

-

- - The request id of the media. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

serialNumber

-

- - The manufacturer’s serial number of the media. - -
- - - Type: - - - string - - -

- -
- - - - - - - -
-
-

typeId

-

- - The type id of the media. - -
- - - Type: - - - int - - -

- -
- - - - -
-
-

Relational

- - - - -
-
-

account

-

- - The account to which the media belongs. - -
- - - Type: - - - SoftLayer_Account - - -

- -
- - - - - -
-
-

createUser

-

- - The customer user who created the media object. - -
- - - Type: - - - SoftLayer_User_Customer - - -

- -
- - - - - -
-
-

datacenter

-

- - The datacenter where the media resides. - -
- - - Type: - - - SoftLayer_Location - - -

- -
- - - - - - - - - -
-
-

modifyEmployee

-

- - The employee who last modified the media. - -
- - - Type: - - - SoftLayer_User_Employee - - -

- -
- - - - - -
-
-

modifyUser

-

- - The customer user who last modified the media. - -
- - - Type: - - - SoftLayer_User_Customer - - -

- -
- - - - - -
-
-

request

-

- - The request to which the media belongs. - -
- - - Type: - - - SoftLayer_Account_Media_Data_Transfer_Request - - -

- -
- - - - - - - - - -
-
-

type

-

- - The media’s type. - -
- - - Type: - - - SoftLayer_Account_Media_Type - - -

- -
- - - - - - - -
-
-

volume

-

- - A guest’s associated EVault network storage service account. - -
- - - Type: - - - SoftLayer_Network_Storage - - -

- -
- - - - -

Count

- - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Account_Media_Data_Transfer_Request/index.html b/reference/datatypes/SoftLayer_Account_Media_Data_Transfer_Request/index.html deleted file mode 100644 index b54b6bbd85a..00000000000 --- a/reference/datatypes/SoftLayer_Account_Media_Data_Transfer_Request/index.html +++ /dev/null @@ -1,862 +0,0 @@ - - - - - - - - - - - - SoftLayer_Account_Media_Data_Transfer_Request - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Account_Media_Data_Transfer_Request

-
-
-
-
-
- Classes - - SoftLayer_Account_Media_Data_Transfer_Request - -
- Tags - - datatype - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Account_Media_Data_Transfer_Request

- -
- -
- - -

Description

- - The SoftLayer_Account_Media_Data_Transfer_Request data type contains information on a single Data Transfer Service request. Creation of these requests is limited to SoftLayer customers through the SoftLayer Customer Portal. - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - - - -
-
-

accountId

-

- - The account id of the request. - -
- - - Type: - - - int - - -

- -
- - - - - - - - - - - - - -
-
-

createUserId

-

- - The create user id of the request. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

endDate

-

- - The end date of the request. - -
- - - Type: - - - dateTime - - -

- -
- - - - - -
-
-

id

-

- - The unique id of the request. - -
- - - Type: - - - int - - -

- -
- - - - - - - - - - - -
-
-

modifyUserId

-

- - The modify user id of the request. - -
- - - Type: - - - int - - -

- -
- - - - - - - - - -
-
-

startDate

-

- - The start date of the request. - -
- - - Type: - - - dateTime - - -

- -
- - - - - - - -
-
-

statusId

-

- - The status id of the request. - -
- - - Type: - - - int - - -

- -
- - - - - - -
-
-

Relational

- - - - -
-
-

account

-

- - The account to which the request belongs. - -
- - - Type: - - - SoftLayer_Account - - -

- -
- - - - - - - - - -
-
-

activeTickets

-

- - The active tickets that are attached to the data transfer request. - -
- - - - - Type: - - - SoftLayer_Ticket[] - - -

- -
- - - - - -
-
-

billingItem

-

- - The billing item for the original request. - -
- - - Type: - - - SoftLayer_Billing_Item - - -

- -
- - - - - -
-
-

createUser

-

- - The customer user who created the request. - -
- - - Type: - - - SoftLayer_User_Customer - - -

- -
- - - - - - - - - - - -
-
-

media

-

- - The media of the request. - -
- - - Type: - - - SoftLayer_Account_Media - - -

- -
- - - - - -
-
-

modifyEmployee

-

- - The employee who last modified the request. - -
- - - Type: - - - SoftLayer_User_Employee - - -

- -
- - - - - -
-
-

modifyUser

-

- - The customer user who last modified the request. - -
- - - Type: - - - SoftLayer_User_Customer - - -

- -
- - - - - - - - - -
-
-

shipments

-

- - The shipments of the request. - -
- - - - - Type: - - - SoftLayer_Account_Shipment[] - - -

- -
- - - - - - - -
-
-

status

-

- - The status of the request. - -
- - - Type: - - - SoftLayer_Account_Media_Data_Transfer_Request_Status - - -

- -
- - - - - - - - - -
-
-

tickets

-

- - All tickets that are attached to the data transfer request. - -
- - - - - Type: - - - SoftLayer_Ticket[] - - -

- -
- - - - -

Count

- - - - - - - - -
-
-

activeTicketCount

-

- - A count of the active tickets that are attached to the data transfer request. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - - - - - - - - - - - - - - - -
-
-

shipmentCount

-

- - A count of the shipments of the request. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - - - -
-
-

ticketCount

-

- - A count of all tickets that are attached to the data transfer request. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Account_Media_Data_Transfer_Request_Status/index.html b/reference/datatypes/SoftLayer_Account_Media_Data_Transfer_Request_Status/index.html deleted file mode 100644 index da418d06147..00000000000 --- a/reference/datatypes/SoftLayer_Account_Media_Data_Transfer_Request_Status/index.html +++ /dev/null @@ -1,407 +0,0 @@ - - - - - - - - - - - - SoftLayer_Account_Media_Data_Transfer_Request_Status - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Account_Media_Data_Transfer_Request_Status

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Account_Media_Data_Transfer_Request_Status

- -
- -
- - -

Description

- - The SoftLayer_Account_Media_Data_Transfer_Request_Status data type contains general information relating to the statuses to which a Data Transfer Request may be set. - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

description

-

- - The description of the request status. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

id

-

- - The unique id of the request status. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

keyName

-

- - The unique keyname of the request status. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

name

-

- - The name of the request status. - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - - - - - - - - -

Count

- - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Account_Media_Type/index.html b/reference/datatypes/SoftLayer_Account_Media_Type/index.html deleted file mode 100644 index 55adacc5359..00000000000 --- a/reference/datatypes/SoftLayer_Account_Media_Type/index.html +++ /dev/null @@ -1,407 +0,0 @@ - - - - - - - - - - - - SoftLayer_Account_Media_Type - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Account_Media_Type

-
-
-
-
-
- Classes - - SoftLayer_Account_Media_Type - -
- Tags - - datatype - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Account_Media_Type

- -
- -
- - -

Description

- - The SoftLayer_Account_Media_Type data type contains general information relating to the different types of media devices that SoftLayer currently supports, as part of the Data Transfer Request Service. Such devices as USB hard drives and flash drives, as well as optical media such as CD and DVD are currently supported. - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

description

-

- - The description of the media type. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

id

-

- - The unique id of the media type. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

keyName

-

- - The unique keyname of the media type. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

name

-

- - The name of the media type. - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - - - - - - - - -

Count

- - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail/index.html b/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail/index.html deleted file mode 100644 index 7d2256bc061..00000000000 --- a/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail/index.html +++ /dev/null @@ -1,686 +0,0 @@ - - - - - - - - - - - - SoftLayer_Account_Regional_Registry_Detail - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Account_Regional_Registry_Detail

-
-
-
-
-
- Classes - - SoftLayer_Account_Regional_Registry_Detail - -
- Tags - - datatype - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Account_Regional_Registry_Detail

- -
- -
- - -

Description

- -
Deprecated
- - The subnet registration detail type has been deprecated. - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - - - -
-
-

accountId

-

- - The detail object’s associated SoftLayer_Account id - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

createDate

-

- - The date and time the detail object was created - -
- - - Type: - - - dateTime - - -

- -
- - - - - - - - - -
-
-

detailTypeId

-

- - The detail object’s associated SoftLayer_Account_Regional_Registry_Detail_Type id - -
- - - Type: - - - int - - -

- -
- - - - - - - -
-
-

id

-

- - Unique ID of the detail object - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

modifyDate

-

- - The date and time the detail object was last modified - -
- - - Type: - - - dateTime - - -

- -
- - - - - - - - - - - -
-
-

regionalInternetRegistryHandleId

-

- - The detail object’s associated SoftLayer_Account_Rwhois_Handle id - -
- - - Type: - - - int - - -

- -
- - -
-
-

Relational

- - - - - - -
-
-

account

-

- - [Deprecated] The account that this detail object belongs to. - -
- - - Type: - - - SoftLayer_Account - - -

- -

Deprecated

- -
- - - - - - - - - - - - - -
-
-

detailType

-

- - [Deprecated] The associated type of this detail object. - -
- - - Type: - - - SoftLayer_Account_Regional_Registry_Detail_Type - - -

- -

Deprecated

- -
- - - - - - - - - -
-
-

details

-

- - [Deprecated] References to the SoftLayer_Network_Subnet_Registration that consume this detail object. - -
- - - - - Type: - - - SoftLayer_Network_Subnet_Registration_Details[] - - -

- -

Deprecated

- -
- - - - - - - - - - - -
-
-

properties

-

- - [Deprecated] The individual properties that define this detail object’s values. - -
- - - - - Type: - - - SoftLayer_Account_Regional_Registry_Detail_Property[] - - -

- -

Deprecated

- -
- - - - - - - - - -
-
-

regionalInternetRegistryHandle

-

- - [Deprecated] The associated RWhois handle of this detail object. Used only when detailed reassignments are necessary. - -
- - - Type: - - - SoftLayer_Account_Rwhois_Handle - - -

- -

Deprecated

- -
- - - - - - -

Count

- - - - - - - - - - -
-
-

detailCount

-

- - A count of [Deprecated] References to the SoftLayer_Network_Subnet_Registration that consume this detail object. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - - - - - - - -
-
-

propertyCount

-

- - A count of [Deprecated] The individual properties that define this detail object’s values. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Property/index.html b/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Property/index.html deleted file mode 100644 index 39ec7e87f9d..00000000000 --- a/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Property/index.html +++ /dev/null @@ -1,560 +0,0 @@ - - - - - - - - - - - - SoftLayer_Account_Regional_Registry_Detail_Property - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Account_Regional_Registry_Detail_Property

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Account_Regional_Registry_Detail_Property

- -
- -
- - -

Description

- -
Deprecated
- -

The subnet registration detail property type has been deprecated.

-

Subnet registration properties are used to define various attributes of the SoftLayer_Account_Regional_Registry_Detail. These properties are defined by the SoftLayer_Account_Regional_Registry_Detail_Property_Type objects, which describe the available value formats.

- - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

createDate

-

- - None - -
- - - Type: - - - dateTime - - -

- -
- - - - - - - -
-
-

id

-

- - Unique ID of the property object - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

modifyDate

-

- - None - -
- - - Type: - - - dateTime - - -

- -
- - - - - - - -
-
-

propertyTypeId

-

- - The numeric ID of the related SoftLayer_Account_Regional_Registry_Detail_Property_Type - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

registrationDetailId

-

- - The numeric ID of the related SoftLayer_Account_Regional_Registry_Detail - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

sequencePosition

-

- - When multiple properties exist for a property type, defines the position in the sequence of those properties - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

value

-

- - The value of the property - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - - - - - -
-
-

detail

-

- - [Deprecated] The SoftLayer_Account_Regional_Registry_Detail object this property belongs to - -
- - - Type: - - - SoftLayer_Account_Regional_Registry_Detail - - -

- -

Deprecated

- -
- - - - - - - - - - - -
-
-

propertyType

-

- - [Deprecated] The SoftLayer_Account_Regional_Registry_Detail_Property_Type object this property belongs to - -
- - - Type: - - - SoftLayer_Account_Regional_Registry_Detail_Property_Type - - -

- -

Deprecated

- -
- - - - - - - - - - - - -

Count

- - - - - - - - - - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Property_Type/index.html b/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Property_Type/index.html deleted file mode 100644 index 11bd8d18946..00000000000 --- a/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Property_Type/index.html +++ /dev/null @@ -1,468 +0,0 @@ - - - - - - - - - - - - SoftLayer_Account_Regional_Registry_Detail_Property_Type - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Account_Regional_Registry_Detail_Property_Type

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Account_Regional_Registry_Detail_Property_Type

- -
- -
- - -

Description

- -
Deprecated
- -

The subnet registration detail property type type has been deprecated.

-

Subnet Registration Detail Property Type objects describe the nature of a SoftLayer_Account_Regional_Registry_Detail_Property object. These types use [http://php.net/pcre.pattern.php Perl-Compatible Regular Expressions] to validate the value of a property object.

- - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

createDate

-

- - None - -
- - - Type: - - - dateTime - - -

- -
- - - - - -
-
-

id

-

- - Unique numeric ID of the property type object - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

keyName

-

- - Code-friendly string name of the property type - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

modifyDate

-

- - None - -
- - - Type: - - - dateTime - - -

- -
- - - - - -
-
-

name

-

- - Human-readable name of the property type - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

valueExpression

-

- - A Perl-compatible regular expression used to describe the valid format of the property - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - - - - - - - - - - - - -

Count

- - - - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Type/index.html b/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Type/index.html deleted file mode 100644 index b6c0a464056..00000000000 --- a/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Type/index.html +++ /dev/null @@ -1,441 +0,0 @@ - - - - - - - - - - - - SoftLayer_Account_Regional_Registry_Detail_Type - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Account_Regional_Registry_Detail_Type

-
-
-
-
-
- Classes - - SoftLayer_Account_Regional_Registry_Detail_Type - -
- Tags - - datatype - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Account_Regional_Registry_Detail_Type

- -
- -
- - -

Description

- -
Deprecated
- -

The subnet registration detail type type has been deprecated.

-

Subnet Registration Detail Type objects describe the nature of a SoftLayer_Account_Regional_Registry_Detail object.

-

The standard values for these objects are as follows:

- - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

createDate

-

- - None - -
- - - Type: - - - dateTime - - -

- -
- - - - - -
-
-

id

-

- - Unique numeric ID of the detail type object - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

keyName

-

- - Code-friendly string name of the detail type - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

modifyDate

-

- - None - -
- - - Type: - - - dateTime - - -

- -
- - - - - -
-
-

name

-

- - Human-readable name of the detail type - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - - - - - - - - - - -

Count

- - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Version4_Person_Default/index.html b/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Version4_Person_Default/index.html deleted file mode 100644 index e9328a81c38..00000000000 --- a/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Version4_Person_Default/index.html +++ /dev/null @@ -1,687 +0,0 @@ - - - - - - - - - - - - SoftLayer_Account_Regional_Registry_Detail_Version4_Person_Default - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Account_Regional_Registry_Detail_Version4_Person_Default

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Account_Regional_Registry_Detail_Version4_Person_Default

- -
- -
- - -

Description

- -
Deprecated
- -

The subnet registration default person detail type has been deprecated.

-

The SoftLayer_Account_Regional_Registry_Detail_Version4_Person_Default data type contains general information relating to a single SoftLayer RIR account. RIR account information in this type such as names, addresses, and phone numbers are assigned to the registry only and not to users belonging to the account.

- - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - - - -
-
-

accountId

-

- - The detail object’s associated SoftLayer_Account id - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

createDate

-

- - The date and time the detail object was created - -
- - - Type: - - - dateTime - - -

- -
- - - - - - - - - -
-
-

detailTypeId

-

- - The detail object’s associated SoftLayer_Account_Regional_Registry_Detail_Type id - -
- - - Type: - - - int - - -

- -
- - - - - - - -
-
-

id

-

- - Unique ID of the detail object - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

modifyDate

-

- - The date and time the detail object was last modified - -
- - - Type: - - - dateTime - - -

- -
- - - - - - - - - - - -
-
-

regionalInternetRegistryHandleId

-

- - The detail object’s associated SoftLayer_Account_Rwhois_Handle id - -
- - - Type: - - - int - - -

- -
- - -
-
-

Relational

- - - - - - -
-
-

account

-

- - [Deprecated] The account that this detail object belongs to. - -
- - - Type: - - - SoftLayer_Account - - -

- -

Deprecated

- -
- - - - - - - - - - - - - -
-
-

detailType

-

- - [Deprecated] The associated type of this detail object. - -
- - - Type: - - - SoftLayer_Account_Regional_Registry_Detail_Type - - -

- -

Deprecated

- -
- - - - - - - - - -
-
-

details

-

- - [Deprecated] References to the SoftLayer_Network_Subnet_Registration that consume this detail object. - -
- - - - - Type: - - - SoftLayer_Network_Subnet_Registration_Details[] - - -

- -

Deprecated

- -
- - - - - - - - - - - -
-
-

properties

-

- - [Deprecated] The individual properties that define this detail object’s values. - -
- - - - - Type: - - - SoftLayer_Account_Regional_Registry_Detail_Property[] - - -

- -

Deprecated

- -
- - - - - - - - - -
-
-

regionalInternetRegistryHandle

-

- - [Deprecated] The associated RWhois handle of this detail object. Used only when detailed reassignments are necessary. - -
- - - Type: - - - SoftLayer_Account_Rwhois_Handle - - -

- -

Deprecated

- -
- - - - - - -

Count

- - - - - - - - - - -
-
-

detailCount

-

- - A count of [Deprecated] References to the SoftLayer_Network_Subnet_Registration that consume this detail object. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - - - - - - - -
-
-

propertyCount

-

- - A count of [Deprecated] The individual properties that define this detail object’s values. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Account_Rwhois_Handle/index.html b/reference/datatypes/SoftLayer_Account_Rwhois_Handle/index.html deleted file mode 100644 index adc9bfcdde3..00000000000 --- a/reference/datatypes/SoftLayer_Account_Rwhois_Handle/index.html +++ /dev/null @@ -1,471 +0,0 @@ - - - - - - - - - - - - SoftLayer_Account_Rwhois_Handle - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Account_Rwhois_Handle

-
-
-
-
-
- Classes - - SoftLayer_Account_Rwhois_Handle - -
- Tags - - datatype - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Account_Rwhois_Handle

- -
- -
- - -

Description

- -
Deprecated
- -

The subnet registration handle type has been deprecated.

-

Provides a means of tracking handle identifiers at the various regional internet registries (RIRs). These objects are used by the SoftLayer_Network_Subnet_Registration objects to identify a customer or organization when a subnet is registered.

- - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - - - -
-
-

accountId

-

- - The handle object’s associated SoftLayer_Account id - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

createDate

-

- - None - -
- - - Type: - - - dateTime - - -

- -
- - - - - -
-
-

handle

-

- - The handle object’s unique identifier as assigned by the RIR. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

id

-

- - Unique ID of the handle object - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

modifyDate

-

- - None - -
- - - Type: - - - dateTime - - -

- -
- - -
-
-

Relational

- - - - - - -
-
-

account

-

- - [Deprecated] The account that this handle belongs to. - -
- - - Type: - - - SoftLayer_Account - - -

- -

Deprecated

- -
- - - - - - - - - - - - - - -

Count

- - - - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Auxiliary_Network_Status/index.html b/reference/datatypes/SoftLayer_Auxiliary_Network_Status/index.html deleted file mode 100644 index dd28f8caaed..00000000000 --- a/reference/datatypes/SoftLayer_Auxiliary_Network_Status/index.html +++ /dev/null @@ -1,298 +0,0 @@ - - - - - - - - - - - - SoftLayer_Auxiliary_Network_Status - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Auxiliary_Network_Status

-
-
-
-
-
- Classes - - SoftLayer_Auxiliary_Network_Status - -
- Tags - - datatype - - sldn - - auxiliary - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Auxiliary_Network_Status

- -
- -
- - -

Description

- -
Deprecated
- - - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- -
-
-

Relational

- - - -

Count

- -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Billing_Item_Account_Media_Data_Transfer_Request/index.html b/reference/datatypes/SoftLayer_Billing_Item_Account_Media_Data_Transfer_Request/index.html deleted file mode 100644 index 62c70ba8629..00000000000 --- a/reference/datatypes/SoftLayer_Billing_Item_Account_Media_Data_Transfer_Request/index.html +++ /dev/null @@ -1,3195 +0,0 @@ - - - - - - - - - - - - SoftLayer_Billing_Item_Account_Media_Data_Transfer_Request - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Billing_Item_Account_Media_Data_Transfer_Request

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Billing_Item_Account_Media_Data_Transfer_Request

- -
- -
- - -

Description

- - The SoftLayer_Billing_Item_Account_Media_Data_Transfer_Request data type contains general information relating to a single SoftLayer billing item for a data transfer request. - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-

allowCancellationFlag

-

- - Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. - -
- - - Type: - - - int - - -

- -
- - - - - - - - - - - -
-
-

associatedBillingItemId

-

- - This is sometimes populated for orphan billing items that are not attached to servers. Billing items like secondary portable IP addresses fit into this category. A user may set an association by calling SoftLayer_Billing_Item::setAssociationId. This will cause this orphan item to appear under its associated server billing item on future invoices. You may only attach orphaned billing items to server billing items without cancellation dates set. - -
- - - Type: - - - string - - -

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-

cancellationDate

-

- - A billing item’s cancellation date. A billing item with a cancellation date in the past is not charged on your SoftLayer invoice. Cancellation dates in the future indicate the current billing item is active, but will be cancelled and not charged for in the future. A billing item with a null cancellation date is also considered an active billing item and is charged once every billing cycle. - -
- - - Type: - - - dateTime - - -

- -
- - - - - - - - - - - - - -
-
-

categoryCode

-

- - The category code of this billing item. It is used to tell us the difference between a primary disk and a secondary disk, for instance. - -
- - - Type: - - - string - - -

- -
- - - - - - - - - - - - - -
-
-

createDate

-

- - The date the billing item was created. You can see this date on the invoice. - -
- - - Type: - - - dateTime - - -

- -
- - - - - -
-
-

currentHourlyCharge

-

- - This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

cycleStartDate

-

- - The last time this billing item was charged. - -
- - - Type: - - - dateTime - - -

- -
- - - - - -
-
-

description

-

- - A brief description of a billing item. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

domainName

-

- - The domain name is provided for server billing items. - -
- - - Type: - - - string - - -

- -
- - - - - - - - - - - - - -
-
-

hostName

-

- - The hostname is provided for server billing items - -
- - - Type: - - - string - - -

- -
- - - - - - - -
-
-

hourlyRecurringFee

-

- - The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

hoursUsed

-

- - This is the number of hours the hourly billing item has been in use this billing period. For virtual servers, this means running, paused or stopped. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

id

-

- - The unique identifier for this billing item. - -
- - - Type: - - - int - - -

- -
- - - - - - - - - - - - - -
-
-

laborFee

-

- - The labor fee, if any. This is a one time charge. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

laborFeeTaxRate

-

- - The rate at which labor fees are taxed if you are a taxable customer. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

lastBillDate

-

- - The last time this billing item was charged. - -
- - - Type: - - - dateTime - - -

- -
- - - - - - - -
-
-

modifyDate

-

- - The date that a billing item was last modified. - -
- - - Type: - - - dateTime - - -

- -
- - - - - -
-
-

nextBillDate

-

- - The date on which your account will be charged for this billing item. - -
- - - Type: - - - dateTime - - -

- -
- - - - - - - - - - - - - - - - - - - - - -
-
-

notes

-

- - Extra information provided to help you identify this billing item. This is often a username or something to help identify items that customers have more than one of. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

oneTimeFee

-

- - The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

oneTimeFeeTaxRate

-

- - The rate at which one time fees are taxed if you are a taxable customer. - -
- - - Type: - - - decimal - - -

- -
- - - - - - - -
-
-

orderItemId

-

- - the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created. - -
- - - Type: - - - int - - -

- -
- - - - - - - - - -
-
-

packageId

-

- - This is the package id for this billing item. - -
- - - Type: - - - int - - -

- -
- - - - - - - -
-
-

parentId

-

- - The unique identifier of the parent of this billing item. - -
- - - Type: - - - int - - -

- -
- - - - - - - - - - - - - -
-
-

recurringFee

-

- - The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

recurringFeeTaxRate

-

- - The rate at which recurring fees are taxed if you are a taxable customer. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

recurringMonths

-

- - The number of months in which the recurring fees will be incurred. - -
- - - Type: - - - int - - -

- -
- - - - - - - -
-
-

serviceProviderId

-

- - This is the service provider for this billing item. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

setupFee

-

- - The setup fee, if any. This is a one time charge. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

setupFeeTaxRate

-

- - The rate at which setup fees are taxed if you are a taxable customer. - -
- - - Type: - - - decimal - - -

- -
- - - - - - - - - - -
-
-

Relational

- - - - -
-
-

account

-

- - The account that a billing item belongs to. - -
- - - Type: - - - SoftLayer_Account - - -

- -
- - - - - -
-
-

activeAgreement

-

- - None - -
- - - Type: - - - SoftLayer_Account_Agreement - - -

- -
- - - - - -
-
-

activeAgreementFlag

-

- - A flag indicating that the billing item is under an active agreement. - -
- - - Type: - - - SoftLayer_Account_Agreement - - -

- -
- - - - - -
-
-

activeAssociatedChildren

-

- - A billing item’s active associated child billing items. This includes “floating” items that are not necessarily child items of this billing item. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - - - -
-
-

activeAssociatedGuestDiskBillingItems

-

- - None - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - -
-
-

activeBundledItems

-

- - A Billing Item’s active bundled billing items. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - -
-
-

activeCancellationItem

-

- - A service cancellation request item that corresponds to the billing item. - -
- - - Type: - - - SoftLayer_Billing_Item_Cancellation_Request_Item - - -

- -
- - - - - -
-
-

activeChildren

-

- - A Billing Item’s active child billing items. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - -
-
-

activeFlag

-

- - None - -
- - - Type: - - - boolean - - -

- -
- - - - - - - -
-
-

activeSparePoolAssociatedGuestDiskBillingItems

-

- - None - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - -
-
-

activeSparePoolBundledItems

-

- - A Billing Item’s spare pool bundled billing items. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - -
-
-

associatedBillingItem

-

- - A billing item’s associated parent. This is to be used for billing items that are “floating”, and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item. - -
- - - Type: - - - SoftLayer_Billing_Item - - -

- -
- - - - - -
-
-

associatedBillingItemHistory

-

- - A history of billing items which a billing item has been associated with. - -
- - - - - Type: - - - SoftLayer_Billing_Item_Association_History[] - - -

- -
- - - - - - - - - -
-
-

associatedChildren

-

- - A Billing Item’s associated child billing items. This includes “floating” items that are not necessarily child billing items of this billing item. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - -
-
-

associatedParent

-

- - A billing item’s associated parent billing item. This object will be the same as the parent billing item if parentId is set. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - - - -
-
-

availableMatchingVlans

-

- - None - -
- - - - - Type: - - - SoftLayer_Network_Vlan[] - - -

- -
- - - - - -
-
-

bandwidthAllocation

-

- - The bandwidth allocation for a billing item. - -
- - - Type: - - - SoftLayer_Network_Bandwidth_Version1_Allocation - - -

- -
- - - - - -
-
-

billableChildren

-

- - A billing item’s recurring child items that have once been billed and are scheduled to be billed in the future. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - - - -
-
-

bundledItems

-

- - A Billing Item’s bundled billing items. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - -
-
-

canceledChildren

-

- - A Billing Item’s active child billing items. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - - - -
-
-

cancellationReason

-

- - The billing item’s cancellation reason. - -
- - - Type: - - - SoftLayer_Billing_Item_Cancellation_Reason - - -

- -
- - - - - - - -
-
-

cancellationRequests

-

- - This will return any cancellation requests that are associated with this billing item. - -
- - - - - Type: - - - SoftLayer_Billing_Item_Cancellation_Request[] - - -

- -
- - - - - -
-
-

category

-

- - The item category to which the billing item’s item belongs. - -
- - - Type: - - - SoftLayer_Product_Item_Category - - -

- -
- - - - - - - -
-
-

children

-

- - A Billing Item’s child billing items' - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - -
-
-

childrenWithActiveAgreement

-

- - A Billing Item’s active child billing items. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - - - - - - - - - - - - - -
-
-

downgradeItems

-

- - For product items which have a downgrade path defined, this will return those product items. - -
- - - - - Type: - - - SoftLayer_Product_Item[] - - -

- -
- - - - - -
-
-

filteredNextInvoiceChildren

-

- - A Billing Item’s associated child billing items, excluding some items with a $0.00 recurring fee. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - - - -
-
-

hourlyFlag

-

- - A flag that will reflect whether this billing item is billed on an hourly basis or not. - -
- - - Type: - - - boolean - - -

- -
- - - - - - - - - - - -
-
-

invoiceItem

-

- - Invoice items associated with this billing item - -
- - - Type: - - - SoftLayer_Billing_Invoice_Item - - -

- -
- - - - - - - -
-
-

invoiceItems

-

- - All invoice items associated with the billing item - -
- - - - - Type: - - - SoftLayer_Billing_Invoice_Item[] - - -

- -
- - - - - -
-
-

item

-

- - The entry in the SoftLayer product catalog that a billing item is based upon. - -
- - - Type: - - - SoftLayer_Product_Item - - -

- -
- - - - - - - - - - - -
-
-

location

-

- - The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information. - -
- - - Type: - - - SoftLayer_Location - - -

- -
- - - - - - - - - -
-
-

nextInvoiceChildren

-

- - A Billing Item’s child billing items and associated items' - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - -
-
-

nextInvoiceTotalOneTimeAmount

-

- - A Billing Item’s total, including any child billing items if they exist.' - -
- - - Type: - - - float - - -

- -
- - - - - -
-
-

nextInvoiceTotalOneTimeTaxAmount

-

- - A Billing Item’s total, including any child billing items if they exist.' - -
- - - Type: - - - float - - -

- -
- - - - - -
-
-

nextInvoiceTotalRecurringAmount

-

- - A Billing Item’s total, including any child billing items and associated billing items if they exist.' - -
- - - Type: - - - float - - -

- -
- - - - - -
-
-

nextInvoiceTotalRecurringTaxAmount

-

- - This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only. - -
- - - Type: - - - float - - -

- -
- - - - - -
-
-

nonZeroNextInvoiceChildren

-

- - A Billing Item’s associated child billing items, excluding ALL items with a $0.00 recurring fee. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - - - - - - - -
-
-

orderItem

-

- - A billing item’s original order item. Simply a reference to the original order from which this billing item was created. - -
- - - Type: - - - SoftLayer_Billing_Order_Item - - -

- -
- - - - - - - -
-
-

originalLocation

-

- - The original physical location for this billing item–may differ from current. - -
- - - Type: - - - SoftLayer_Location - - -

- -
- - - - - -
-
-

package

-

- - The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms. - -
- - - Type: - - - SoftLayer_Product_Package - - -

- -
- - - - - - - -
-
-

parent

-

- - A billing item’s parent item. If a billing item has no parent item then this value is null. - -
- - - Type: - - - SoftLayer_Billing_Item - - -

- -
- - - - - - - -
-
-

parentVirtualGuestBillingItem

-

- - A billing item’s parent item. If a billing item has no parent item then this value is null. - -
- - - Type: - - - SoftLayer_Billing_Item_Virtual_Guest - - -

- -
- - - - - -
-
-

pendingCancellationFlag

-

- - This flag indicates whether a billing item is scheduled to be canceled or not. - -
- - - Type: - - - boolean - - -

- -
- - - - - -
-
-

pendingOrderItem

-

- - The new order item that will replace this billing item. - -
- - - Type: - - - SoftLayer_Billing_Order_Item - - -

- -
- - - - - -
-
-

provisionTransaction

-

- - Provisioning transaction for this billing item - -
- - - Type: - - - SoftLayer_Provisioning_Version1_Transaction - - -

- -
- - - - - - - - - - - -
-
-

resource

-

- - The data transfer request to which the billing item points. - -
- - - Type: - - - SoftLayer_Account_Media_Data_Transfer_Request - - -

- -
- - - - - - - - - - - -
-
-

softwareDescription

-

- - A friendly description of software component - -
- - - Type: - - - SoftLayer_Software_Description - - -

- -
- - - - - -
-
-

upgradeItem

-

- - Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path. - -
- - - Type: - - - SoftLayer_Product_Item - - -

- -
- - - - - - - -
-
-

upgradeItems

-

- - Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. - -
- - - - - Type: - - - SoftLayer_Product_Item[] - - -

- -
- - - - -

Count

- - - - - - - - - - - - -
-
-

activeAssociatedChildrenCount

-

- - A count of a billing item’s active associated child billing items. This includes “floating” items that are not necessarily child items of this billing item. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - -
-
-

activeAssociatedGuestDiskBillingItemCount

-

- - A count of - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - -
-
-

activeBundledItemCount

-

- - A count of a Billing Item’s active bundled billing items. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - -
-
-

activeChildrenCount

-

- - A count of a Billing Item’s active child billing items. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - -
-
-

activeSparePoolAssociatedGuestDiskBillingItemCount

-

- - A count of - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - -
-
-

activeSparePoolBundledItemCount

-

- - A count of a Billing Item’s spare pool bundled billing items. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - - - -
-
-

associatedBillingItemHistoryCount

-

- - A count of a history of billing items which a billing item has been associated with. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - -
-
-

associatedChildrenCount

-

- - A count of a Billing Item’s associated child billing items. This includes “floating” items that are not necessarily child billing items of this billing item. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - -
-
-

associatedParentCount

-

- - A count of a billing item’s associated parent billing item. This object will be the same as the parent billing item if parentId is set. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - -
-
-

availableMatchingVlanCount

-

- - A count of - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - -
-
-

billableChildrenCount

-

- - A count of a billing item’s recurring child items that have once been billed and are scheduled to be billed in the future. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - -
-
-

bundledItemCount

-

- - A count of a Billing Item’s bundled billing items. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - -
-
-

canceledChildrenCount

-

- - A count of a Billing Item’s active child billing items. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - -
-
-

cancellationRequestCount

-

- - A count of this will return any cancellation requests that are associated with this billing item. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - - - -
-
-

childrenCount

-

- - A count of a Billing Item’s child billing items' - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - -
-
-

childrenWithActiveAgreementCount

-

- - A count of a Billing Item’s active child billing items. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - - - - - -
-
-

downgradeItemCount

-

- - A count of for product items which have a downgrade path defined, this will return those product items. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - -
-
-

filteredNextInvoiceChildrenCount

-

- - A count of a Billing Item’s associated child billing items, excluding some items with a $0.00 recurring fee. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - - - - - - - -
-
-

invoiceItemCount

-

- - A count of all invoice items associated with the billing item - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - - - - - - - - - - - - - -
-
-

nextInvoiceChildrenCount

-

- - A count of a Billing Item’s child billing items and associated items' - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - - - - - -
-
-

nonZeroNextInvoiceChildrenCount

-

- - A count of a Billing Item’s associated child billing items, excluding ALL items with a $0.00 recurring fee. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-

upgradeItemCount

-

- - A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Billing_Item_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/index.html b/reference/datatypes/SoftLayer_Billing_Item_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/index.html deleted file mode 100644 index 2dae1e59601..00000000000 --- a/reference/datatypes/SoftLayer_Billing_Item_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/index.html +++ /dev/null @@ -1,3195 +0,0 @@ - - - - - - - - - - - - SoftLayer_Billing_Item_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Billing_Item_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Billing_Item_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress

- -
- -
- - -

Description

- - A SoftLayer_Billing_Item_Network_Application_Delivery_Controller_LoadBalancer represents the SoftLayer_Billing_Item related to a single SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress instance. - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-

allowCancellationFlag

-

- - Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. - -
- - - Type: - - - int - - -

- -
- - - - - - - - - - - -
-
-

associatedBillingItemId

-

- - This is sometimes populated for orphan billing items that are not attached to servers. Billing items like secondary portable IP addresses fit into this category. A user may set an association by calling SoftLayer_Billing_Item::setAssociationId. This will cause this orphan item to appear under its associated server billing item on future invoices. You may only attach orphaned billing items to server billing items without cancellation dates set. - -
- - - Type: - - - string - - -

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-

cancellationDate

-

- - A billing item’s cancellation date. A billing item with a cancellation date in the past is not charged on your SoftLayer invoice. Cancellation dates in the future indicate the current billing item is active, but will be cancelled and not charged for in the future. A billing item with a null cancellation date is also considered an active billing item and is charged once every billing cycle. - -
- - - Type: - - - dateTime - - -

- -
- - - - - - - - - - - - - -
-
-

categoryCode

-

- - The category code of this billing item. It is used to tell us the difference between a primary disk and a secondary disk, for instance. - -
- - - Type: - - - string - - -

- -
- - - - - - - - - - - - - -
-
-

createDate

-

- - The date the billing item was created. You can see this date on the invoice. - -
- - - Type: - - - dateTime - - -

- -
- - - - - -
-
-

currentHourlyCharge

-

- - This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

cycleStartDate

-

- - The last time this billing item was charged. - -
- - - Type: - - - dateTime - - -

- -
- - - - - -
-
-

description

-

- - A brief description of a billing item. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

domainName

-

- - The domain name is provided for server billing items. - -
- - - Type: - - - string - - -

- -
- - - - - - - - - - - - - -
-
-

hostName

-

- - The hostname is provided for server billing items - -
- - - Type: - - - string - - -

- -
- - - - - - - -
-
-

hourlyRecurringFee

-

- - The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

hoursUsed

-

- - This is the number of hours the hourly billing item has been in use this billing period. For virtual servers, this means running, paused or stopped. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

id

-

- - The unique identifier for this billing item. - -
- - - Type: - - - int - - -

- -
- - - - - - - - - - - - - -
-
-

laborFee

-

- - The labor fee, if any. This is a one time charge. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

laborFeeTaxRate

-

- - The rate at which labor fees are taxed if you are a taxable customer. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

lastBillDate

-

- - The last time this billing item was charged. - -
- - - Type: - - - dateTime - - -

- -
- - - - - - - -
-
-

modifyDate

-

- - The date that a billing item was last modified. - -
- - - Type: - - - dateTime - - -

- -
- - - - - -
-
-

nextBillDate

-

- - The date on which your account will be charged for this billing item. - -
- - - Type: - - - dateTime - - -

- -
- - - - - - - - - - - - - - - - - - - - - -
-
-

notes

-

- - Extra information provided to help you identify this billing item. This is often a username or something to help identify items that customers have more than one of. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

oneTimeFee

-

- - The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

oneTimeFeeTaxRate

-

- - The rate at which one time fees are taxed if you are a taxable customer. - -
- - - Type: - - - decimal - - -

- -
- - - - - - - -
-
-

orderItemId

-

- - the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created. - -
- - - Type: - - - int - - -

- -
- - - - - - - - - -
-
-

packageId

-

- - This is the package id for this billing item. - -
- - - Type: - - - int - - -

- -
- - - - - - - -
-
-

parentId

-

- - The unique identifier of the parent of this billing item. - -
- - - Type: - - - int - - -

- -
- - - - - - - - - - - - - -
-
-

recurringFee

-

- - The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

recurringFeeTaxRate

-

- - The rate at which recurring fees are taxed if you are a taxable customer. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

recurringMonths

-

- - The number of months in which the recurring fees will be incurred. - -
- - - Type: - - - int - - -

- -
- - - - - - - -
-
-

serviceProviderId

-

- - This is the service provider for this billing item. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

setupFee

-

- - The setup fee, if any. This is a one time charge. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

setupFeeTaxRate

-

- - The rate at which setup fees are taxed if you are a taxable customer. - -
- - - Type: - - - decimal - - -

- -
- - - - - - - - - - -
-
-

Relational

- - - - -
-
-

account

-

- - The account that a billing item belongs to. - -
- - - Type: - - - SoftLayer_Account - - -

- -
- - - - - -
-
-

activeAgreement

-

- - None - -
- - - Type: - - - SoftLayer_Account_Agreement - - -

- -
- - - - - -
-
-

activeAgreementFlag

-

- - A flag indicating that the billing item is under an active agreement. - -
- - - Type: - - - SoftLayer_Account_Agreement - - -

- -
- - - - - -
-
-

activeAssociatedChildren

-

- - A billing item’s active associated child billing items. This includes “floating” items that are not necessarily child items of this billing item. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - - - -
-
-

activeAssociatedGuestDiskBillingItems

-

- - None - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - -
-
-

activeBundledItems

-

- - A Billing Item’s active bundled billing items. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - -
-
-

activeCancellationItem

-

- - A service cancellation request item that corresponds to the billing item. - -
- - - Type: - - - SoftLayer_Billing_Item_Cancellation_Request_Item - - -

- -
- - - - - -
-
-

activeChildren

-

- - A Billing Item’s active child billing items. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - -
-
-

activeFlag

-

- - None - -
- - - Type: - - - boolean - - -

- -
- - - - - - - -
-
-

activeSparePoolAssociatedGuestDiskBillingItems

-

- - None - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - -
-
-

activeSparePoolBundledItems

-

- - A Billing Item’s spare pool bundled billing items. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - -
-
-

associatedBillingItem

-

- - A billing item’s associated parent. This is to be used for billing items that are “floating”, and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item. - -
- - - Type: - - - SoftLayer_Billing_Item - - -

- -
- - - - - -
-
-

associatedBillingItemHistory

-

- - A history of billing items which a billing item has been associated with. - -
- - - - - Type: - - - SoftLayer_Billing_Item_Association_History[] - - -

- -
- - - - - - - - - -
-
-

associatedChildren

-

- - A Billing Item’s associated child billing items. This includes “floating” items that are not necessarily child billing items of this billing item. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - -
-
-

associatedParent

-

- - A billing item’s associated parent billing item. This object will be the same as the parent billing item if parentId is set. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - - - -
-
-

availableMatchingVlans

-

- - None - -
- - - - - Type: - - - SoftLayer_Network_Vlan[] - - -

- -
- - - - - -
-
-

bandwidthAllocation

-

- - The bandwidth allocation for a billing item. - -
- - - Type: - - - SoftLayer_Network_Bandwidth_Version1_Allocation - - -

- -
- - - - - -
-
-

billableChildren

-

- - A billing item’s recurring child items that have once been billed and are scheduled to be billed in the future. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - - - -
-
-

bundledItems

-

- - A Billing Item’s bundled billing items. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - -
-
-

canceledChildren

-

- - A Billing Item’s active child billing items. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - - - -
-
-

cancellationReason

-

- - The billing item’s cancellation reason. - -
- - - Type: - - - SoftLayer_Billing_Item_Cancellation_Reason - - -

- -
- - - - - - - -
-
-

cancellationRequests

-

- - This will return any cancellation requests that are associated with this billing item. - -
- - - - - Type: - - - SoftLayer_Billing_Item_Cancellation_Request[] - - -

- -
- - - - - -
-
-

category

-

- - The item category to which the billing item’s item belongs. - -
- - - Type: - - - SoftLayer_Product_Item_Category - - -

- -
- - - - - - - -
-
-

children

-

- - A Billing Item’s child billing items' - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - -
-
-

childrenWithActiveAgreement

-

- - A Billing Item’s active child billing items. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - - - - - - - - - - - - - -
-
-

downgradeItems

-

- - For product items which have a downgrade path defined, this will return those product items. - -
- - - - - Type: - - - SoftLayer_Product_Item[] - - -

- -
- - - - - -
-
-

filteredNextInvoiceChildren

-

- - A Billing Item’s associated child billing items, excluding some items with a $0.00 recurring fee. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - - - -
-
-

hourlyFlag

-

- - A flag that will reflect whether this billing item is billed on an hourly basis or not. - -
- - - Type: - - - boolean - - -

- -
- - - - - - - - - - - -
-
-

invoiceItem

-

- - Invoice items associated with this billing item - -
- - - Type: - - - SoftLayer_Billing_Invoice_Item - - -

- -
- - - - - - - -
-
-

invoiceItems

-

- - All invoice items associated with the billing item - -
- - - - - Type: - - - SoftLayer_Billing_Invoice_Item[] - - -

- -
- - - - - -
-
-

item

-

- - The entry in the SoftLayer product catalog that a billing item is based upon. - -
- - - Type: - - - SoftLayer_Product_Item - - -

- -
- - - - - - - - - - - -
-
-

location

-

- - The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information. - -
- - - Type: - - - SoftLayer_Location - - -

- -
- - - - - - - - - -
-
-

nextInvoiceChildren

-

- - A Billing Item’s child billing items and associated items' - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - -
-
-

nextInvoiceTotalOneTimeAmount

-

- - A Billing Item’s total, including any child billing items if they exist.' - -
- - - Type: - - - float - - -

- -
- - - - - -
-
-

nextInvoiceTotalOneTimeTaxAmount

-

- - A Billing Item’s total, including any child billing items if they exist.' - -
- - - Type: - - - float - - -

- -
- - - - - -
-
-

nextInvoiceTotalRecurringAmount

-

- - A Billing Item’s total, including any child billing items and associated billing items if they exist.' - -
- - - Type: - - - float - - -

- -
- - - - - -
-
-

nextInvoiceTotalRecurringTaxAmount

-

- - This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only. - -
- - - Type: - - - float - - -

- -
- - - - - -
-
-

nonZeroNextInvoiceChildren

-

- - A Billing Item’s associated child billing items, excluding ALL items with a $0.00 recurring fee. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - - - - - - - -
-
-

orderItem

-

- - A billing item’s original order item. Simply a reference to the original order from which this billing item was created. - -
- - - Type: - - - SoftLayer_Billing_Order_Item - - -

- -
- - - - - - - -
-
-

originalLocation

-

- - The original physical location for this billing item–may differ from current. - -
- - - Type: - - - SoftLayer_Location - - -

- -
- - - - - -
-
-

package

-

- - The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms. - -
- - - Type: - - - SoftLayer_Product_Package - - -

- -
- - - - - - - -
-
-

parent

-

- - A billing item’s parent item. If a billing item has no parent item then this value is null. - -
- - - Type: - - - SoftLayer_Billing_Item - - -

- -
- - - - - - - -
-
-

parentVirtualGuestBillingItem

-

- - A billing item’s parent item. If a billing item has no parent item then this value is null. - -
- - - Type: - - - SoftLayer_Billing_Item_Virtual_Guest - - -

- -
- - - - - -
-
-

pendingCancellationFlag

-

- - This flag indicates whether a billing item is scheduled to be canceled or not. - -
- - - Type: - - - boolean - - -

- -
- - - - - -
-
-

pendingOrderItem

-

- - The new order item that will replace this billing item. - -
- - - Type: - - - SoftLayer_Billing_Order_Item - - -

- -
- - - - - -
-
-

provisionTransaction

-

- - Provisioning transaction for this billing item - -
- - - Type: - - - SoftLayer_Provisioning_Version1_Transaction - - -

- -
- - - - - - - - - - - -
-
-

resource

-

- - The load balancer that a load balancer billing item is associated with. - -
- - - Type: - - - SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress - - -

- -
- - - - - - - - - - - -
-
-

softwareDescription

-

- - A friendly description of software component - -
- - - Type: - - - SoftLayer_Software_Description - - -

- -
- - - - - -
-
-

upgradeItem

-

- - Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path. - -
- - - Type: - - - SoftLayer_Product_Item - - -

- -
- - - - - - - -
-
-

upgradeItems

-

- - Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. - -
- - - - - Type: - - - SoftLayer_Product_Item[] - - -

- -
- - - - -

Count

- - - - - - - - - - - - -
-
-

activeAssociatedChildrenCount

-

- - A count of a billing item’s active associated child billing items. This includes “floating” items that are not necessarily child items of this billing item. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - -
-
-

activeAssociatedGuestDiskBillingItemCount

-

- - A count of - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - -
-
-

activeBundledItemCount

-

- - A count of a Billing Item’s active bundled billing items. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - -
-
-

activeChildrenCount

-

- - A count of a Billing Item’s active child billing items. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - -
-
-

activeSparePoolAssociatedGuestDiskBillingItemCount

-

- - A count of - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - -
-
-

activeSparePoolBundledItemCount

-

- - A count of a Billing Item’s spare pool bundled billing items. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - - - -
-
-

associatedBillingItemHistoryCount

-

- - A count of a history of billing items which a billing item has been associated with. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - -
-
-

associatedChildrenCount

-

- - A count of a Billing Item’s associated child billing items. This includes “floating” items that are not necessarily child billing items of this billing item. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - -
-
-

associatedParentCount

-

- - A count of a billing item’s associated parent billing item. This object will be the same as the parent billing item if parentId is set. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - -
-
-

availableMatchingVlanCount

-

- - A count of - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - -
-
-

billableChildrenCount

-

- - A count of a billing item’s recurring child items that have once been billed and are scheduled to be billed in the future. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - -
-
-

bundledItemCount

-

- - A count of a Billing Item’s bundled billing items. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - -
-
-

canceledChildrenCount

-

- - A count of a Billing Item’s active child billing items. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - -
-
-

cancellationRequestCount

-

- - A count of this will return any cancellation requests that are associated with this billing item. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - - - -
-
-

childrenCount

-

- - A count of a Billing Item’s child billing items' - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - -
-
-

childrenWithActiveAgreementCount

-

- - A count of a Billing Item’s active child billing items. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - - - - - -
-
-

downgradeItemCount

-

- - A count of for product items which have a downgrade path defined, this will return those product items. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - -
-
-

filteredNextInvoiceChildrenCount

-

- - A count of a Billing Item’s associated child billing items, excluding some items with a $0.00 recurring fee. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - - - - - - - -
-
-

invoiceItemCount

-

- - A count of all invoice items associated with the billing item - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - - - - - - - - - - - - - -
-
-

nextInvoiceChildrenCount

-

- - A count of a Billing Item’s child billing items and associated items' - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - - - - - -
-
-

nonZeroNextInvoiceChildrenCount

-

- - A count of a Billing Item’s associated child billing items, excluding ALL items with a $0.00 recurring fee. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-

upgradeItemCount

-

- - A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Billing_Item_Network_LoadBalancer/index.html b/reference/datatypes/SoftLayer_Billing_Item_Network_LoadBalancer/index.html deleted file mode 100644 index f6cdcfd5f17..00000000000 --- a/reference/datatypes/SoftLayer_Billing_Item_Network_LoadBalancer/index.html +++ /dev/null @@ -1,3167 +0,0 @@ - - - - - - - - - - - - SoftLayer_Billing_Item_Network_LoadBalancer - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Billing_Item_Network_LoadBalancer

-
-
-
-
-
- Classes - - SoftLayer_Billing_Item_Network_LoadBalancer - -
- Tags - - datatype - - sldn - - billing - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Billing_Item_Network_LoadBalancer

- -
- -
- - -

Description

- - A SoftLayer_Billing_Item_Network_LoadBalancer represents the SoftLayer_Billing_Item related to a single SoftLayer_Network_LoadBalancer instance. - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-

allowCancellationFlag

-

- - Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. - -
- - - Type: - - - int - - -

- -
- - - - - - - - - - - -
-
-

associatedBillingItemId

-

- - This is sometimes populated for orphan billing items that are not attached to servers. Billing items like secondary portable IP addresses fit into this category. A user may set an association by calling SoftLayer_Billing_Item::setAssociationId. This will cause this orphan item to appear under its associated server billing item on future invoices. You may only attach orphaned billing items to server billing items without cancellation dates set. - -
- - - Type: - - - string - - -

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-

cancellationDate

-

- - A billing item’s cancellation date. A billing item with a cancellation date in the past is not charged on your SoftLayer invoice. Cancellation dates in the future indicate the current billing item is active, but will be cancelled and not charged for in the future. A billing item with a null cancellation date is also considered an active billing item and is charged once every billing cycle. - -
- - - Type: - - - dateTime - - -

- -
- - - - - - - - - - - - - -
-
-

categoryCode

-

- - The category code of this billing item. It is used to tell us the difference between a primary disk and a secondary disk, for instance. - -
- - - Type: - - - string - - -

- -
- - - - - - - - - - - - - -
-
-

createDate

-

- - The date the billing item was created. You can see this date on the invoice. - -
- - - Type: - - - dateTime - - -

- -
- - - - - -
-
-

currentHourlyCharge

-

- - This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

cycleStartDate

-

- - The last time this billing item was charged. - -
- - - Type: - - - dateTime - - -

- -
- - - - - -
-
-

description

-

- - A brief description of a billing item. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

domainName

-

- - The domain name is provided for server billing items. - -
- - - Type: - - - string - - -

- -
- - - - - - - - - - - - - -
-
-

hostName

-

- - The hostname is provided for server billing items - -
- - - Type: - - - string - - -

- -
- - - - - - - -
-
-

hourlyRecurringFee

-

- - The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

hoursUsed

-

- - This is the number of hours the hourly billing item has been in use this billing period. For virtual servers, this means running, paused or stopped. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

id

-

- - The unique identifier for this billing item. - -
- - - Type: - - - int - - -

- -
- - - - - - - - - - - - - -
-
-

laborFee

-

- - The labor fee, if any. This is a one time charge. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

laborFeeTaxRate

-

- - The rate at which labor fees are taxed if you are a taxable customer. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

lastBillDate

-

- - The last time this billing item was charged. - -
- - - Type: - - - dateTime - - -

- -
- - - - - - - -
-
-

modifyDate

-

- - The date that a billing item was last modified. - -
- - - Type: - - - dateTime - - -

- -
- - - - - -
-
-

nextBillDate

-

- - The date on which your account will be charged for this billing item. - -
- - - Type: - - - dateTime - - -

- -
- - - - - - - - - - - - - - - - - - - - - -
-
-

notes

-

- - Extra information provided to help you identify this billing item. This is often a username or something to help identify items that customers have more than one of. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

oneTimeFee

-

- - The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

oneTimeFeeTaxRate

-

- - The rate at which one time fees are taxed if you are a taxable customer. - -
- - - Type: - - - decimal - - -

- -
- - - - - - - -
-
-

orderItemId

-

- - the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created. - -
- - - Type: - - - int - - -

- -
- - - - - - - - - -
-
-

packageId

-

- - This is the package id for this billing item. - -
- - - Type: - - - int - - -

- -
- - - - - - - -
-
-

parentId

-

- - The unique identifier of the parent of this billing item. - -
- - - Type: - - - int - - -

- -
- - - - - - - - - - - - - -
-
-

recurringFee

-

- - The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

recurringFeeTaxRate

-

- - The rate at which recurring fees are taxed if you are a taxable customer. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

recurringMonths

-

- - The number of months in which the recurring fees will be incurred. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

serviceProviderId

-

- - This is the service provider for this billing item. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

setupFee

-

- - The setup fee, if any. This is a one time charge. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

setupFeeTaxRate

-

- - The rate at which setup fees are taxed if you are a taxable customer. - -
- - - Type: - - - decimal - - -

- -
- - - - - - - - - - -
-
-

Relational

- - - - -
-
-

account

-

- - The account that a billing item belongs to. - -
- - - Type: - - - SoftLayer_Account - - -

- -
- - - - - -
-
-

activeAgreement

-

- - None - -
- - - Type: - - - SoftLayer_Account_Agreement - - -

- -
- - - - - -
-
-

activeAgreementFlag

-

- - A flag indicating that the billing item is under an active agreement. - -
- - - Type: - - - SoftLayer_Account_Agreement - - -

- -
- - - - - -
-
-

activeAssociatedChildren

-

- - A billing item’s active associated child billing items. This includes “floating” items that are not necessarily child items of this billing item. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - - - -
-
-

activeAssociatedGuestDiskBillingItems

-

- - None - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - -
-
-

activeBundledItems

-

- - A Billing Item’s active bundled billing items. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - -
-
-

activeCancellationItem

-

- - A service cancellation request item that corresponds to the billing item. - -
- - - Type: - - - SoftLayer_Billing_Item_Cancellation_Request_Item - - -

- -
- - - - - -
-
-

activeChildren

-

- - A Billing Item’s active child billing items. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - -
-
-

activeFlag

-

- - None - -
- - - Type: - - - boolean - - -

- -
- - - - - - - -
-
-

activeSparePoolAssociatedGuestDiskBillingItems

-

- - None - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - -
-
-

activeSparePoolBundledItems

-

- - A Billing Item’s spare pool bundled billing items. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - -
-
-

associatedBillingItem

-

- - A billing item’s associated parent. This is to be used for billing items that are “floating”, and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item. - -
- - - Type: - - - SoftLayer_Billing_Item - - -

- -
- - - - - -
-
-

associatedBillingItemHistory

-

- - A history of billing items which a billing item has been associated with. - -
- - - - - Type: - - - SoftLayer_Billing_Item_Association_History[] - - -

- -
- - - - - - - - - -
-
-

associatedChildren

-

- - A Billing Item’s associated child billing items. This includes “floating” items that are not necessarily child billing items of this billing item. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - -
-
-

associatedParent

-

- - A billing item’s associated parent billing item. This object will be the same as the parent billing item if parentId is set. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - - - -
-
-

availableMatchingVlans

-

- - None - -
- - - - - Type: - - - SoftLayer_Network_Vlan[] - - -

- -
- - - - - -
-
-

bandwidthAllocation

-

- - The bandwidth allocation for a billing item. - -
- - - Type: - - - SoftLayer_Network_Bandwidth_Version1_Allocation - - -

- -
- - - - - -
-
-

billableChildren

-

- - A billing item’s recurring child items that have once been billed and are scheduled to be billed in the future. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - - - -
-
-

bundledItems

-

- - A Billing Item’s bundled billing items. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - -
-
-

canceledChildren

-

- - A Billing Item’s active child billing items. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - - - -
-
-

cancellationReason

-

- - The billing item’s cancellation reason. - -
- - - Type: - - - SoftLayer_Billing_Item_Cancellation_Reason - - -

- -
- - - - - - - -
-
-

cancellationRequests

-

- - This will return any cancellation requests that are associated with this billing item. - -
- - - - - Type: - - - SoftLayer_Billing_Item_Cancellation_Request[] - - -

- -
- - - - - -
-
-

category

-

- - The item category to which the billing item’s item belongs. - -
- - - Type: - - - SoftLayer_Product_Item_Category - - -

- -
- - - - - - - -
-
-

children

-

- - A Billing Item’s child billing items' - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - -
-
-

childrenWithActiveAgreement

-

- - A Billing Item’s active child billing items. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - - - - - - - - - - - - - -
-
-

downgradeItems

-

- - For product items which have a downgrade path defined, this will return those product items. - -
- - - - - Type: - - - SoftLayer_Product_Item[] - - -

- -
- - - - - -
-
-

filteredNextInvoiceChildren

-

- - A Billing Item’s associated child billing items, excluding some items with a $0.00 recurring fee. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - - - -
-
-

hourlyFlag

-

- - A flag that will reflect whether this billing item is billed on an hourly basis or not. - -
- - - Type: - - - boolean - - -

- -
- - - - - - - - - - - -
-
-

invoiceItem

-

- - Invoice items associated with this billing item - -
- - - Type: - - - SoftLayer_Billing_Invoice_Item - - -

- -
- - - - - - - -
-
-

invoiceItems

-

- - All invoice items associated with the billing item - -
- - - - - Type: - - - SoftLayer_Billing_Invoice_Item[] - - -

- -
- - - - - -
-
-

item

-

- - The entry in the SoftLayer product catalog that a billing item is based upon. - -
- - - Type: - - - SoftLayer_Product_Item - - -

- -
- - - - - - - - - - - -
-
-

location

-

- - The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information. - -
- - - Type: - - - SoftLayer_Location - - -

- -
- - - - - - - - - -
-
-

nextInvoiceChildren

-

- - A Billing Item’s child billing items and associated items' - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - -
-
-

nextInvoiceTotalOneTimeAmount

-

- - A Billing Item’s total, including any child billing items if they exist.' - -
- - - Type: - - - float - - -

- -
- - - - - -
-
-

nextInvoiceTotalOneTimeTaxAmount

-

- - A Billing Item’s total, including any child billing items if they exist.' - -
- - - Type: - - - float - - -

- -
- - - - - -
-
-

nextInvoiceTotalRecurringAmount

-

- - A Billing Item’s total, including any child billing items and associated billing items if they exist.' - -
- - - Type: - - - float - - -

- -
- - - - - -
-
-

nextInvoiceTotalRecurringTaxAmount

-

- - This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only. - -
- - - Type: - - - float - - -

- -
- - - - - -
-
-

nonZeroNextInvoiceChildren

-

- - A Billing Item’s associated child billing items, excluding ALL items with a $0.00 recurring fee. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - - - - - - - -
-
-

orderItem

-

- - A billing item’s original order item. Simply a reference to the original order from which this billing item was created. - -
- - - Type: - - - SoftLayer_Billing_Order_Item - - -

- -
- - - - - - - -
-
-

originalLocation

-

- - The original physical location for this billing item–may differ from current. - -
- - - Type: - - - SoftLayer_Location - - -

- -
- - - - - -
-
-

package

-

- - The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms. - -
- - - Type: - - - SoftLayer_Product_Package - - -

- -
- - - - - - - -
-
-

parent

-

- - A billing item’s parent item. If a billing item has no parent item then this value is null. - -
- - - Type: - - - SoftLayer_Billing_Item - - -

- -
- - - - - - - -
-
-

parentVirtualGuestBillingItem

-

- - A billing item’s parent item. If a billing item has no parent item then this value is null. - -
- - - Type: - - - SoftLayer_Billing_Item_Virtual_Guest - - -

- -
- - - - - -
-
-

pendingCancellationFlag

-

- - This flag indicates whether a billing item is scheduled to be canceled or not. - -
- - - Type: - - - boolean - - -

- -
- - - - - -
-
-

pendingOrderItem

-

- - The new order item that will replace this billing item. - -
- - - Type: - - - SoftLayer_Billing_Order_Item - - -

- -
- - - - - -
-
-

provisionTransaction

-

- - Provisioning transaction for this billing item - -
- - - Type: - - - SoftLayer_Provisioning_Version1_Transaction - - -

- -
- - - - - - - - - - - - - - - - - -
-
-

softwareDescription

-

- - A friendly description of software component - -
- - - Type: - - - SoftLayer_Software_Description - - -

- -
- - - - - -
-
-

upgradeItem

-

- - Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path. - -
- - - Type: - - - SoftLayer_Product_Item - - -

- -
- - - - - - - -
-
-

upgradeItems

-

- - Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. - -
- - - - - Type: - - - SoftLayer_Product_Item[] - - -

- -
- - - - -

Count

- - - - - - - - - - - - -
-
-

activeAssociatedChildrenCount

-

- - A count of a billing item’s active associated child billing items. This includes “floating” items that are not necessarily child items of this billing item. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - -
-
-

activeAssociatedGuestDiskBillingItemCount

-

- - A count of - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - -
-
-

activeBundledItemCount

-

- - A count of a Billing Item’s active bundled billing items. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - -
-
-

activeChildrenCount

-

- - A count of a Billing Item’s active child billing items. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - -
-
-

activeSparePoolAssociatedGuestDiskBillingItemCount

-

- - A count of - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - -
-
-

activeSparePoolBundledItemCount

-

- - A count of a Billing Item’s spare pool bundled billing items. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - - - -
-
-

associatedBillingItemHistoryCount

-

- - A count of a history of billing items which a billing item has been associated with. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - -
-
-

associatedChildrenCount

-

- - A count of a Billing Item’s associated child billing items. This includes “floating” items that are not necessarily child billing items of this billing item. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - -
-
-

associatedParentCount

-

- - A count of a billing item’s associated parent billing item. This object will be the same as the parent billing item if parentId is set. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - -
-
-

availableMatchingVlanCount

-

- - A count of - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - -
-
-

billableChildrenCount

-

- - A count of a billing item’s recurring child items that have once been billed and are scheduled to be billed in the future. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - -
-
-

bundledItemCount

-

- - A count of a Billing Item’s bundled billing items. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - -
-
-

canceledChildrenCount

-

- - A count of a Billing Item’s active child billing items. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - -
-
-

cancellationRequestCount

-

- - A count of this will return any cancellation requests that are associated with this billing item. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - - - -
-
-

childrenCount

-

- - A count of a Billing Item’s child billing items' - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - -
-
-

childrenWithActiveAgreementCount

-

- - A count of a Billing Item’s active child billing items. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - - - - - -
-
-

downgradeItemCount

-

- - A count of for product items which have a downgrade path defined, this will return those product items. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - -
-
-

filteredNextInvoiceChildrenCount

-

- - A count of a Billing Item’s associated child billing items, excluding some items with a $0.00 recurring fee. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - - - - - - - -
-
-

invoiceItemCount

-

- - A count of all invoice items associated with the billing item - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - - - - - - - - - - - - - -
-
-

nextInvoiceChildrenCount

-

- - A count of a Billing Item’s child billing items and associated items' - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - - - - - -
-
-

nonZeroNextInvoiceChildrenCount

-

- - A count of a Billing Item’s associated child billing items, excluding ALL items with a $0.00 recurring fee. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-

upgradeItemCount

-

- - A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Billing_Item_Network_LoadBalancer_Global/index.html b/reference/datatypes/SoftLayer_Billing_Item_Network_LoadBalancer_Global/index.html deleted file mode 100644 index b3d9e4b2662..00000000000 --- a/reference/datatypes/SoftLayer_Billing_Item_Network_LoadBalancer_Global/index.html +++ /dev/null @@ -1,3148 +0,0 @@ - - - - - - - - - - - - SoftLayer_Billing_Item_Network_LoadBalancer_Global - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Billing_Item_Network_LoadBalancer_Global

-
-
-
-
-
- Classes - - SoftLayer_Billing_Item_Network_LoadBalancer_Global - -
- Tags - - datatype - - sldn - - billing - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Billing_Item_Network_LoadBalancer_Global

- -
- -
- - -

Description

- -
Deprecated
- -

The global load balancer service has been deprecated and is no longer available.

-

The SoftLayer_Billing_Item_Network_LoadBalancer_Global data type contains general information relating to a single SoftLayer billing item whose item category code is ‘global_load_balancer’

- - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-

allowCancellationFlag

-

- - Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. - -
- - - Type: - - - int - - -

- -
- - - - - - - - - - - -
-
-

associatedBillingItemId

-

- - This is sometimes populated for orphan billing items that are not attached to servers. Billing items like secondary portable IP addresses fit into this category. A user may set an association by calling SoftLayer_Billing_Item::setAssociationId. This will cause this orphan item to appear under its associated server billing item on future invoices. You may only attach orphaned billing items to server billing items without cancellation dates set. - -
- - - Type: - - - string - - -

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-

cancellationDate

-

- - A billing item’s cancellation date. A billing item with a cancellation date in the past is not charged on your SoftLayer invoice. Cancellation dates in the future indicate the current billing item is active, but will be cancelled and not charged for in the future. A billing item with a null cancellation date is also considered an active billing item and is charged once every billing cycle. - -
- - - Type: - - - dateTime - - -

- -
- - - - - - - - - - - - - -
-
-

categoryCode

-

- - The category code of this billing item. It is used to tell us the difference between a primary disk and a secondary disk, for instance. - -
- - - Type: - - - string - - -

- -
- - - - - - - - - - - - - -
-
-

createDate

-

- - The date the billing item was created. You can see this date on the invoice. - -
- - - Type: - - - dateTime - - -

- -
- - - - - -
-
-

currentHourlyCharge

-

- - This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

cycleStartDate

-

- - The last time this billing item was charged. - -
- - - Type: - - - dateTime - - -

- -
- - - - - -
-
-

description

-

- - A brief description of a billing item. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

domainName

-

- - The domain name is provided for server billing items. - -
- - - Type: - - - string - - -

- -
- - - - - - - - - - - - - -
-
-

hostName

-

- - The hostname is provided for server billing items - -
- - - Type: - - - string - - -

- -
- - - - - - - -
-
-

hourlyRecurringFee

-

- - The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

hoursUsed

-

- - This is the number of hours the hourly billing item has been in use this billing period. For virtual servers, this means running, paused or stopped. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

id

-

- - The unique identifier for this billing item. - -
- - - Type: - - - int - - -

- -
- - - - - - - - - - - - - -
-
-

laborFee

-

- - The labor fee, if any. This is a one time charge. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

laborFeeTaxRate

-

- - The rate at which labor fees are taxed if you are a taxable customer. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

lastBillDate

-

- - The last time this billing item was charged. - -
- - - Type: - - - dateTime - - -

- -
- - - - - - - -
-
-

modifyDate

-

- - The date that a billing item was last modified. - -
- - - Type: - - - dateTime - - -

- -
- - - - - -
-
-

nextBillDate

-

- - The date on which your account will be charged for this billing item. - -
- - - Type: - - - dateTime - - -

- -
- - - - - - - - - - - - - - - - - - - - - -
-
-

notes

-

- - Extra information provided to help you identify this billing item. This is often a username or something to help identify items that customers have more than one of. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

oneTimeFee

-

- - The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

oneTimeFeeTaxRate

-

- - The rate at which one time fees are taxed if you are a taxable customer. - -
- - - Type: - - - decimal - - -

- -
- - - - - - - -
-
-

orderItemId

-

- - the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created. - -
- - - Type: - - - int - - -

- -
- - - - - - - - - -
-
-

packageId

-

- - This is the package id for this billing item. - -
- - - Type: - - - int - - -

- -
- - - - - - - -
-
-

parentId

-

- - The unique identifier of the parent of this billing item. - -
- - - Type: - - - int - - -

- -
- - - - - - - - - - - - - -
-
-

recurringFee

-

- - The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

recurringFeeTaxRate

-

- - The rate at which recurring fees are taxed if you are a taxable customer. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

recurringMonths

-

- - The number of months in which the recurring fees will be incurred. - -
- - - Type: - - - int - - -

- -
- - - - - - - -
-
-

serviceProviderId

-

- - This is the service provider for this billing item. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

setupFee

-

- - The setup fee, if any. This is a one time charge. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

setupFeeTaxRate

-

- - The rate at which setup fees are taxed if you are a taxable customer. - -
- - - Type: - - - decimal - - -

- -
- - - - - - - - - - -
-
-

Relational

- - - - -
-
-

account

-

- - The account that a billing item belongs to. - -
- - - Type: - - - SoftLayer_Account - - -

- -
- - - - - -
-
-

activeAgreement

-

- - None - -
- - - Type: - - - SoftLayer_Account_Agreement - - -

- -
- - - - - -
-
-

activeAgreementFlag

-

- - A flag indicating that the billing item is under an active agreement. - -
- - - Type: - - - SoftLayer_Account_Agreement - - -

- -
- - - - - -
-
-

activeAssociatedChildren

-

- - A billing item’s active associated child billing items. This includes “floating” items that are not necessarily child items of this billing item. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - - - -
-
-

activeAssociatedGuestDiskBillingItems

-

- - None - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - -
-
-

activeBundledItems

-

- - A Billing Item’s active bundled billing items. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - -
-
-

activeCancellationItem

-

- - A service cancellation request item that corresponds to the billing item. - -
- - - Type: - - - SoftLayer_Billing_Item_Cancellation_Request_Item - - -

- -
- - - - - -
-
-

activeChildren

-

- - A Billing Item’s active child billing items. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - -
-
-

activeFlag

-

- - None - -
- - - Type: - - - boolean - - -

- -
- - - - - - - -
-
-

activeSparePoolAssociatedGuestDiskBillingItems

-

- - None - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - -
-
-

activeSparePoolBundledItems

-

- - A Billing Item’s spare pool bundled billing items. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - -
-
-

associatedBillingItem

-

- - A billing item’s associated parent. This is to be used for billing items that are “floating”, and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item. - -
- - - Type: - - - SoftLayer_Billing_Item - - -

- -
- - - - - -
-
-

associatedBillingItemHistory

-

- - A history of billing items which a billing item has been associated with. - -
- - - - - Type: - - - SoftLayer_Billing_Item_Association_History[] - - -

- -
- - - - - - - - - -
-
-

associatedChildren

-

- - A Billing Item’s associated child billing items. This includes “floating” items that are not necessarily child billing items of this billing item. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - -
-
-

associatedParent

-

- - A billing item’s associated parent billing item. This object will be the same as the parent billing item if parentId is set. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - - - -
-
-

availableMatchingVlans

-

- - None - -
- - - - - Type: - - - SoftLayer_Network_Vlan[] - - -

- -
- - - - - -
-
-

bandwidthAllocation

-

- - The bandwidth allocation for a billing item. - -
- - - Type: - - - SoftLayer_Network_Bandwidth_Version1_Allocation - - -

- -
- - - - - -
-
-

billableChildren

-

- - A billing item’s recurring child items that have once been billed and are scheduled to be billed in the future. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - - - -
-
-

bundledItems

-

- - A Billing Item’s bundled billing items. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - -
-
-

canceledChildren

-

- - A Billing Item’s active child billing items. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - - - -
-
-

cancellationReason

-

- - The billing item’s cancellation reason. - -
- - - Type: - - - SoftLayer_Billing_Item_Cancellation_Reason - - -

- -
- - - - - - - -
-
-

cancellationRequests

-

- - This will return any cancellation requests that are associated with this billing item. - -
- - - - - Type: - - - SoftLayer_Billing_Item_Cancellation_Request[] - - -

- -
- - - - - -
-
-

category

-

- - The item category to which the billing item’s item belongs. - -
- - - Type: - - - SoftLayer_Product_Item_Category - - -

- -
- - - - - - - -
-
-

children

-

- - A Billing Item’s child billing items' - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - -
-
-

childrenWithActiveAgreement

-

- - A Billing Item’s active child billing items. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - - - - - - - - - - - - - -
-
-

downgradeItems

-

- - For product items which have a downgrade path defined, this will return those product items. - -
- - - - - Type: - - - SoftLayer_Product_Item[] - - -

- -
- - - - - -
-
-

filteredNextInvoiceChildren

-

- - A Billing Item’s associated child billing items, excluding some items with a $0.00 recurring fee. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - - - -
-
-

hourlyFlag

-

- - A flag that will reflect whether this billing item is billed on an hourly basis or not. - -
- - - Type: - - - boolean - - -

- -
- - - - - - - - - - - -
-
-

invoiceItem

-

- - Invoice items associated with this billing item - -
- - - Type: - - - SoftLayer_Billing_Invoice_Item - - -

- -
- - - - - - - -
-
-

invoiceItems

-

- - All invoice items associated with the billing item - -
- - - - - Type: - - - SoftLayer_Billing_Invoice_Item[] - - -

- -
- - - - - -
-
-

item

-

- - The entry in the SoftLayer product catalog that a billing item is based upon. - -
- - - Type: - - - SoftLayer_Product_Item - - -

- -
- - - - - - - - - - - -
-
-

location

-

- - The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information. - -
- - - Type: - - - SoftLayer_Location - - -

- -
- - - - - - - - - -
-
-

nextInvoiceChildren

-

- - A Billing Item’s child billing items and associated items' - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - -
-
-

nextInvoiceTotalOneTimeAmount

-

- - A Billing Item’s total, including any child billing items if they exist.' - -
- - - Type: - - - float - - -

- -
- - - - - -
-
-

nextInvoiceTotalOneTimeTaxAmount

-

- - A Billing Item’s total, including any child billing items if they exist.' - -
- - - Type: - - - float - - -

- -
- - - - - -
-
-

nextInvoiceTotalRecurringAmount

-

- - A Billing Item’s total, including any child billing items and associated billing items if they exist.' - -
- - - Type: - - - float - - -

- -
- - - - - -
-
-

nextInvoiceTotalRecurringTaxAmount

-

- - This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only. - -
- - - Type: - - - float - - -

- -
- - - - - -
-
-

nonZeroNextInvoiceChildren

-

- - A Billing Item’s associated child billing items, excluding ALL items with a $0.00 recurring fee. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - - - - - - - -
-
-

orderItem

-

- - A billing item’s original order item. Simply a reference to the original order from which this billing item was created. - -
- - - Type: - - - SoftLayer_Billing_Order_Item - - -

- -
- - - - - - - -
-
-

originalLocation

-

- - The original physical location for this billing item–may differ from current. - -
- - - Type: - - - SoftLayer_Location - - -

- -
- - - - - -
-
-

package

-

- - The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms. - -
- - - Type: - - - SoftLayer_Product_Package - - -

- -
- - - - - - - -
-
-

parent

-

- - A billing item’s parent item. If a billing item has no parent item then this value is null. - -
- - - Type: - - - SoftLayer_Billing_Item - - -

- -
- - - - - - - -
-
-

parentVirtualGuestBillingItem

-

- - A billing item’s parent item. If a billing item has no parent item then this value is null. - -
- - - Type: - - - SoftLayer_Billing_Item_Virtual_Guest - - -

- -
- - - - - -
-
-

pendingCancellationFlag

-

- - This flag indicates whether a billing item is scheduled to be canceled or not. - -
- - - Type: - - - boolean - - -

- -
- - - - - -
-
-

pendingOrderItem

-

- - The new order item that will replace this billing item. - -
- - - Type: - - - SoftLayer_Billing_Order_Item - - -

- -
- - - - - -
-
-

provisionTransaction

-

- - Provisioning transaction for this billing item - -
- - - Type: - - - SoftLayer_Provisioning_Version1_Transaction - - -

- -
- - - - - - - - - - - -
-
-

resource

-

- - The resource for a global load balancer billing item. - -
- - - Type: - - - SoftLayer_Network_LoadBalancer_Global_Account - - -

- -
- - - - - - - - - - - -
-
-

softwareDescription

-

- - A friendly description of software component - -
- - - Type: - - - SoftLayer_Software_Description - - -

- -
- - - - - -
-
-

upgradeItem

-

- - Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path. - -
- - - Type: - - - SoftLayer_Product_Item - - -

- -
- - - - - - - -
-
-

upgradeItems

-

- - Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. - -
- - - - - Type: - - - SoftLayer_Product_Item[] - - -

- -
- - - - -

Count

- - - - - - - - - - - - -
-
-

activeAssociatedChildrenCount

-

- - A count of a billing item’s active associated child billing items. This includes “floating” items that are not necessarily child items of this billing item. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - -
-
-

activeAssociatedGuestDiskBillingItemCount

-

- - A count of - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - -
-
-

activeBundledItemCount

-

- - A count of a Billing Item’s active bundled billing items. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - -
-
-

activeChildrenCount

-

- - A count of a Billing Item’s active child billing items. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - -
-
-

activeSparePoolAssociatedGuestDiskBillingItemCount

-

- - A count of - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - -
-
-

activeSparePoolBundledItemCount

-

- - A count of a Billing Item’s spare pool bundled billing items. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - - - -
-
-

associatedBillingItemHistoryCount

-

- - A count of a history of billing items which a billing item has been associated with. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - -
-
-

associatedChildrenCount

-

- - A count of a Billing Item’s associated child billing items. This includes “floating” items that are not necessarily child billing items of this billing item. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - -
-
-

associatedParentCount

-

- - A count of a billing item’s associated parent billing item. This object will be the same as the parent billing item if parentId is set. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - -
-
-

availableMatchingVlanCount

-

- - A count of - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - -
-
-

billableChildrenCount

-

- - A count of a billing item’s recurring child items that have once been billed and are scheduled to be billed in the future. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - -
-
-

bundledItemCount

-

- - A count of a Billing Item’s bundled billing items. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - -
-
-

canceledChildrenCount

-

- - A count of a Billing Item’s active child billing items. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - -
-
-

cancellationRequestCount

-

- - A count of this will return any cancellation requests that are associated with this billing item. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - - - -
-
-

childrenCount

-

- - A count of a Billing Item’s child billing items' - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - -
-
-

childrenWithActiveAgreementCount

-

- - A count of a Billing Item’s active child billing items. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - - - - - -
-
-

downgradeItemCount

-

- - A count of for product items which have a downgrade path defined, this will return those product items. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - -
-
-

filteredNextInvoiceChildrenCount

-

- - A count of a Billing Item’s associated child billing items, excluding some items with a $0.00 recurring fee. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - - - - - - - -
-
-

invoiceItemCount

-

- - A count of all invoice items associated with the billing item - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - - - - - - - - - - - - - -
-
-

nextInvoiceChildrenCount

-

- - A count of a Billing Item’s child billing items and associated items' - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - - - - - -
-
-

nonZeroNextInvoiceChildrenCount

-

- - A count of a Billing Item’s associated child billing items, excluding ALL items with a $0.00 recurring fee. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-

upgradeItemCount

-

- - A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Billing_Item_Network_LoadBalancer_VirtualIpAddress/index.html b/reference/datatypes/SoftLayer_Billing_Item_Network_LoadBalancer_VirtualIpAddress/index.html deleted file mode 100644 index 7fb99108651..00000000000 --- a/reference/datatypes/SoftLayer_Billing_Item_Network_LoadBalancer_VirtualIpAddress/index.html +++ /dev/null @@ -1,3195 +0,0 @@ - - - - - - - - - - - - SoftLayer_Billing_Item_Network_LoadBalancer_VirtualIpAddress - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Billing_Item_Network_LoadBalancer_VirtualIpAddress

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Billing_Item_Network_LoadBalancer_VirtualIpAddress

- -
- -
- - -

Description

- - A SoftLayer_Billing_Item_Network_LoadBalancer_VirtualIpAddress represents the SoftLayer_Billing_Item related to a single SoftLayer_Network_LoadBalancer_VirtualIpAddress instance. - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-

allowCancellationFlag

-

- - Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. - -
- - - Type: - - - int - - -

- -
- - - - - - - - - - - -
-
-

associatedBillingItemId

-

- - This is sometimes populated for orphan billing items that are not attached to servers. Billing items like secondary portable IP addresses fit into this category. A user may set an association by calling SoftLayer_Billing_Item::setAssociationId. This will cause this orphan item to appear under its associated server billing item on future invoices. You may only attach orphaned billing items to server billing items without cancellation dates set. - -
- - - Type: - - - string - - -

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-

cancellationDate

-

- - A billing item’s cancellation date. A billing item with a cancellation date in the past is not charged on your SoftLayer invoice. Cancellation dates in the future indicate the current billing item is active, but will be cancelled and not charged for in the future. A billing item with a null cancellation date is also considered an active billing item and is charged once every billing cycle. - -
- - - Type: - - - dateTime - - -

- -
- - - - - - - - - - - - - -
-
-

categoryCode

-

- - The category code of this billing item. It is used to tell us the difference between a primary disk and a secondary disk, for instance. - -
- - - Type: - - - string - - -

- -
- - - - - - - - - - - - - -
-
-

createDate

-

- - The date the billing item was created. You can see this date on the invoice. - -
- - - Type: - - - dateTime - - -

- -
- - - - - -
-
-

currentHourlyCharge

-

- - This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

cycleStartDate

-

- - The last time this billing item was charged. - -
- - - Type: - - - dateTime - - -

- -
- - - - - -
-
-

description

-

- - A brief description of a billing item. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

domainName

-

- - The domain name is provided for server billing items. - -
- - - Type: - - - string - - -

- -
- - - - - - - - - - - - - -
-
-

hostName

-

- - The hostname is provided for server billing items - -
- - - Type: - - - string - - -

- -
- - - - - - - -
-
-

hourlyRecurringFee

-

- - The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

hoursUsed

-

- - This is the number of hours the hourly billing item has been in use this billing period. For virtual servers, this means running, paused or stopped. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

id

-

- - The unique identifier for this billing item. - -
- - - Type: - - - int - - -

- -
- - - - - - - - - - - - - -
-
-

laborFee

-

- - The labor fee, if any. This is a one time charge. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

laborFeeTaxRate

-

- - The rate at which labor fees are taxed if you are a taxable customer. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

lastBillDate

-

- - The last time this billing item was charged. - -
- - - Type: - - - dateTime - - -

- -
- - - - - - - -
-
-

modifyDate

-

- - The date that a billing item was last modified. - -
- - - Type: - - - dateTime - - -

- -
- - - - - -
-
-

nextBillDate

-

- - The date on which your account will be charged for this billing item. - -
- - - Type: - - - dateTime - - -

- -
- - - - - - - - - - - - - - - - - - - - - -
-
-

notes

-

- - Extra information provided to help you identify this billing item. This is often a username or something to help identify items that customers have more than one of. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

oneTimeFee

-

- - The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

oneTimeFeeTaxRate

-

- - The rate at which one time fees are taxed if you are a taxable customer. - -
- - - Type: - - - decimal - - -

- -
- - - - - - - -
-
-

orderItemId

-

- - the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created. - -
- - - Type: - - - int - - -

- -
- - - - - - - - - -
-
-

packageId

-

- - This is the package id for this billing item. - -
- - - Type: - - - int - - -

- -
- - - - - - - -
-
-

parentId

-

- - The unique identifier of the parent of this billing item. - -
- - - Type: - - - int - - -

- -
- - - - - - - - - - - - - -
-
-

recurringFee

-

- - The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

recurringFeeTaxRate

-

- - The rate at which recurring fees are taxed if you are a taxable customer. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

recurringMonths

-

- - The number of months in which the recurring fees will be incurred. - -
- - - Type: - - - int - - -

- -
- - - - - - - -
-
-

serviceProviderId

-

- - This is the service provider for this billing item. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

setupFee

-

- - The setup fee, if any. This is a one time charge. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

setupFeeTaxRate

-

- - The rate at which setup fees are taxed if you are a taxable customer. - -
- - - Type: - - - decimal - - -

- -
- - - - - - - - - - -
-
-

Relational

- - - - -
-
-

account

-

- - The account that a billing item belongs to. - -
- - - Type: - - - SoftLayer_Account - - -

- -
- - - - - -
-
-

activeAgreement

-

- - None - -
- - - Type: - - - SoftLayer_Account_Agreement - - -

- -
- - - - - -
-
-

activeAgreementFlag

-

- - A flag indicating that the billing item is under an active agreement. - -
- - - Type: - - - SoftLayer_Account_Agreement - - -

- -
- - - - - -
-
-

activeAssociatedChildren

-

- - A billing item’s active associated child billing items. This includes “floating” items that are not necessarily child items of this billing item. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - - - -
-
-

activeAssociatedGuestDiskBillingItems

-

- - None - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - -
-
-

activeBundledItems

-

- - A Billing Item’s active bundled billing items. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - -
-
-

activeCancellationItem

-

- - A service cancellation request item that corresponds to the billing item. - -
- - - Type: - - - SoftLayer_Billing_Item_Cancellation_Request_Item - - -

- -
- - - - - -
-
-

activeChildren

-

- - A Billing Item’s active child billing items. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - -
-
-

activeFlag

-

- - None - -
- - - Type: - - - boolean - - -

- -
- - - - - - - -
-
-

activeSparePoolAssociatedGuestDiskBillingItems

-

- - None - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - -
-
-

activeSparePoolBundledItems

-

- - A Billing Item’s spare pool bundled billing items. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - -
-
-

associatedBillingItem

-

- - A billing item’s associated parent. This is to be used for billing items that are “floating”, and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item. - -
- - - Type: - - - SoftLayer_Billing_Item - - -

- -
- - - - - -
-
-

associatedBillingItemHistory

-

- - A history of billing items which a billing item has been associated with. - -
- - - - - Type: - - - SoftLayer_Billing_Item_Association_History[] - - -

- -
- - - - - - - - - -
-
-

associatedChildren

-

- - A Billing Item’s associated child billing items. This includes “floating” items that are not necessarily child billing items of this billing item. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - -
-
-

associatedParent

-

- - A billing item’s associated parent billing item. This object will be the same as the parent billing item if parentId is set. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - - - -
-
-

availableMatchingVlans

-

- - None - -
- - - - - Type: - - - SoftLayer_Network_Vlan[] - - -

- -
- - - - - -
-
-

bandwidthAllocation

-

- - The bandwidth allocation for a billing item. - -
- - - Type: - - - SoftLayer_Network_Bandwidth_Version1_Allocation - - -

- -
- - - - - -
-
-

billableChildren

-

- - A billing item’s recurring child items that have once been billed and are scheduled to be billed in the future. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - - - -
-
-

bundledItems

-

- - A Billing Item’s bundled billing items. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - -
-
-

canceledChildren

-

- - A Billing Item’s active child billing items. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - - - -
-
-

cancellationReason

-

- - The billing item’s cancellation reason. - -
- - - Type: - - - SoftLayer_Billing_Item_Cancellation_Reason - - -

- -
- - - - - - - -
-
-

cancellationRequests

-

- - This will return any cancellation requests that are associated with this billing item. - -
- - - - - Type: - - - SoftLayer_Billing_Item_Cancellation_Request[] - - -

- -
- - - - - -
-
-

category

-

- - The item category to which the billing item’s item belongs. - -
- - - Type: - - - SoftLayer_Product_Item_Category - - -

- -
- - - - - - - -
-
-

children

-

- - A Billing Item’s child billing items' - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - -
-
-

childrenWithActiveAgreement

-

- - A Billing Item’s active child billing items. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - - - - - - - - - - - - - -
-
-

downgradeItems

-

- - For product items which have a downgrade path defined, this will return those product items. - -
- - - - - Type: - - - SoftLayer_Product_Item[] - - -

- -
- - - - - -
-
-

filteredNextInvoiceChildren

-

- - A Billing Item’s associated child billing items, excluding some items with a $0.00 recurring fee. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - - - -
-
-

hourlyFlag

-

- - A flag that will reflect whether this billing item is billed on an hourly basis or not. - -
- - - Type: - - - boolean - - -

- -
- - - - - - - - - - - -
-
-

invoiceItem

-

- - Invoice items associated with this billing item - -
- - - Type: - - - SoftLayer_Billing_Invoice_Item - - -

- -
- - - - - - - -
-
-

invoiceItems

-

- - All invoice items associated with the billing item - -
- - - - - Type: - - - SoftLayer_Billing_Invoice_Item[] - - -

- -
- - - - - -
-
-

item

-

- - The entry in the SoftLayer product catalog that a billing item is based upon. - -
- - - Type: - - - SoftLayer_Product_Item - - -

- -
- - - - - - - - - - - -
-
-

location

-

- - The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information. - -
- - - Type: - - - SoftLayer_Location - - -

- -
- - - - - - - - - -
-
-

nextInvoiceChildren

-

- - A Billing Item’s child billing items and associated items' - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - -
-
-

nextInvoiceTotalOneTimeAmount

-

- - A Billing Item’s total, including any child billing items if they exist.' - -
- - - Type: - - - float - - -

- -
- - - - - -
-
-

nextInvoiceTotalOneTimeTaxAmount

-

- - A Billing Item’s total, including any child billing items if they exist.' - -
- - - Type: - - - float - - -

- -
- - - - - -
-
-

nextInvoiceTotalRecurringAmount

-

- - A Billing Item’s total, including any child billing items and associated billing items if they exist.' - -
- - - Type: - - - float - - -

- -
- - - - - -
-
-

nextInvoiceTotalRecurringTaxAmount

-

- - This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only. - -
- - - Type: - - - float - - -

- -
- - - - - -
-
-

nonZeroNextInvoiceChildren

-

- - A Billing Item’s associated child billing items, excluding ALL items with a $0.00 recurring fee. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - - - - - - - -
-
-

orderItem

-

- - A billing item’s original order item. Simply a reference to the original order from which this billing item was created. - -
- - - Type: - - - SoftLayer_Billing_Order_Item - - -

- -
- - - - - - - -
-
-

originalLocation

-

- - The original physical location for this billing item–may differ from current. - -
- - - Type: - - - SoftLayer_Location - - -

- -
- - - - - -
-
-

package

-

- - The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms. - -
- - - Type: - - - SoftLayer_Product_Package - - -

- -
- - - - - - - -
-
-

parent

-

- - A billing item’s parent item. If a billing item has no parent item then this value is null. - -
- - - Type: - - - SoftLayer_Billing_Item - - -

- -
- - - - - - - -
-
-

parentVirtualGuestBillingItem

-

- - A billing item’s parent item. If a billing item has no parent item then this value is null. - -
- - - Type: - - - SoftLayer_Billing_Item_Virtual_Guest - - -

- -
- - - - - -
-
-

pendingCancellationFlag

-

- - This flag indicates whether a billing item is scheduled to be canceled or not. - -
- - - Type: - - - boolean - - -

- -
- - - - - -
-
-

pendingOrderItem

-

- - The new order item that will replace this billing item. - -
- - - Type: - - - SoftLayer_Billing_Order_Item - - -

- -
- - - - - -
-
-

provisionTransaction

-

- - Provisioning transaction for this billing item - -
- - - Type: - - - SoftLayer_Provisioning_Version1_Transaction - - -

- -
- - - - - - - - - - - -
-
-

resource

-

- - The load balancer’s virtual IP address that the billing item is associated with. - -
- - - Type: - - - SoftLayer_Network_LoadBalancer_VirtualIpAddress - - -

- -
- - - - - - - - - - - -
-
-

softwareDescription

-

- - A friendly description of software component - -
- - - Type: - - - SoftLayer_Software_Description - - -

- -
- - - - - -
-
-

upgradeItem

-

- - Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path. - -
- - - Type: - - - SoftLayer_Product_Item - - -

- -
- - - - - - - -
-
-

upgradeItems

-

- - Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. - -
- - - - - Type: - - - SoftLayer_Product_Item[] - - -

- -
- - - - -

Count

- - - - - - - - - - - - -
-
-

activeAssociatedChildrenCount

-

- - A count of a billing item’s active associated child billing items. This includes “floating” items that are not necessarily child items of this billing item. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - -
-
-

activeAssociatedGuestDiskBillingItemCount

-

- - A count of - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - -
-
-

activeBundledItemCount

-

- - A count of a Billing Item’s active bundled billing items. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - -
-
-

activeChildrenCount

-

- - A count of a Billing Item’s active child billing items. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - -
-
-

activeSparePoolAssociatedGuestDiskBillingItemCount

-

- - A count of - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - -
-
-

activeSparePoolBundledItemCount

-

- - A count of a Billing Item’s spare pool bundled billing items. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - - - -
-
-

associatedBillingItemHistoryCount

-

- - A count of a history of billing items which a billing item has been associated with. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - -
-
-

associatedChildrenCount

-

- - A count of a Billing Item’s associated child billing items. This includes “floating” items that are not necessarily child billing items of this billing item. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - -
-
-

associatedParentCount

-

- - A count of a billing item’s associated parent billing item. This object will be the same as the parent billing item if parentId is set. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - -
-
-

availableMatchingVlanCount

-

- - A count of - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - -
-
-

billableChildrenCount

-

- - A count of a billing item’s recurring child items that have once been billed and are scheduled to be billed in the future. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - -
-
-

bundledItemCount

-

- - A count of a Billing Item’s bundled billing items. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - -
-
-

canceledChildrenCount

-

- - A count of a Billing Item’s active child billing items. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - -
-
-

cancellationRequestCount

-

- - A count of this will return any cancellation requests that are associated with this billing item. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - - - -
-
-

childrenCount

-

- - A count of a Billing Item’s child billing items' - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - -
-
-

childrenWithActiveAgreementCount

-

- - A count of a Billing Item’s active child billing items. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - - - - - -
-
-

downgradeItemCount

-

- - A count of for product items which have a downgrade path defined, this will return those product items. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - -
-
-

filteredNextInvoiceChildrenCount

-

- - A count of a Billing Item’s associated child billing items, excluding some items with a $0.00 recurring fee. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - - - - - - - -
-
-

invoiceItemCount

-

- - A count of all invoice items associated with the billing item - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - - - - - - - - - - - - - -
-
-

nextInvoiceChildrenCount

-

- - A count of a Billing Item’s child billing items and associated items' - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - - - - - -
-
-

nonZeroNextInvoiceChildrenCount

-

- - A count of a Billing Item’s associated child billing items, excluding ALL items with a $0.00 recurring fee. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-

upgradeItemCount

-

- - A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Billing_Item_Network_Tunnel/index.html b/reference/datatypes/SoftLayer_Billing_Item_Network_Tunnel/index.html deleted file mode 100644 index 1524833b790..00000000000 --- a/reference/datatypes/SoftLayer_Billing_Item_Network_Tunnel/index.html +++ /dev/null @@ -1,3195 +0,0 @@ - - - - - - - - - - - - SoftLayer_Billing_Item_Network_Tunnel - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Billing_Item_Network_Tunnel

-
-
-
-
-
- Classes - - SoftLayer_Billing_Item_Network_Tunnel - -
- Tags - - datatype - - sldn - - billing - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Billing_Item_Network_Tunnel

- -
- -
- - -

Description

- - The SoftLayer_Billing_Item_Network_Storage data type describes the billing items related to StorageLayer accounts. - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-

allowCancellationFlag

-

- - Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. - -
- - - Type: - - - int - - -

- -
- - - - - - - - - - - -
-
-

associatedBillingItemId

-

- - This is sometimes populated for orphan billing items that are not attached to servers. Billing items like secondary portable IP addresses fit into this category. A user may set an association by calling SoftLayer_Billing_Item::setAssociationId. This will cause this orphan item to appear under its associated server billing item on future invoices. You may only attach orphaned billing items to server billing items without cancellation dates set. - -
- - - Type: - - - string - - -

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-

cancellationDate

-

- - A billing item’s cancellation date. A billing item with a cancellation date in the past is not charged on your SoftLayer invoice. Cancellation dates in the future indicate the current billing item is active, but will be cancelled and not charged for in the future. A billing item with a null cancellation date is also considered an active billing item and is charged once every billing cycle. - -
- - - Type: - - - dateTime - - -

- -
- - - - - - - - - - - - - -
-
-

categoryCode

-

- - The category code of this billing item. It is used to tell us the difference between a primary disk and a secondary disk, for instance. - -
- - - Type: - - - string - - -

- -
- - - - - - - - - - - - - -
-
-

createDate

-

- - The date the billing item was created. You can see this date on the invoice. - -
- - - Type: - - - dateTime - - -

- -
- - - - - -
-
-

currentHourlyCharge

-

- - This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

cycleStartDate

-

- - The last time this billing item was charged. - -
- - - Type: - - - dateTime - - -

- -
- - - - - -
-
-

description

-

- - A brief description of a billing item. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

domainName

-

- - The domain name is provided for server billing items. - -
- - - Type: - - - string - - -

- -
- - - - - - - - - - - - - -
-
-

hostName

-

- - The hostname is provided for server billing items - -
- - - Type: - - - string - - -

- -
- - - - - - - -
-
-

hourlyRecurringFee

-

- - The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

hoursUsed

-

- - This is the number of hours the hourly billing item has been in use this billing period. For virtual servers, this means running, paused or stopped. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

id

-

- - The unique identifier for this billing item. - -
- - - Type: - - - int - - -

- -
- - - - - - - - - - - - - -
-
-

laborFee

-

- - The labor fee, if any. This is a one time charge. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

laborFeeTaxRate

-

- - The rate at which labor fees are taxed if you are a taxable customer. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

lastBillDate

-

- - The last time this billing item was charged. - -
- - - Type: - - - dateTime - - -

- -
- - - - - - - -
-
-

modifyDate

-

- - The date that a billing item was last modified. - -
- - - Type: - - - dateTime - - -

- -
- - - - - -
-
-

nextBillDate

-

- - The date on which your account will be charged for this billing item. - -
- - - Type: - - - dateTime - - -

- -
- - - - - - - - - - - - - - - - - - - - - -
-
-

notes

-

- - Extra information provided to help you identify this billing item. This is often a username or something to help identify items that customers have more than one of. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

oneTimeFee

-

- - The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

oneTimeFeeTaxRate

-

- - The rate at which one time fees are taxed if you are a taxable customer. - -
- - - Type: - - - decimal - - -

- -
- - - - - - - -
-
-

orderItemId

-

- - the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created. - -
- - - Type: - - - int - - -

- -
- - - - - - - - - -
-
-

packageId

-

- - This is the package id for this billing item. - -
- - - Type: - - - int - - -

- -
- - - - - - - -
-
-

parentId

-

- - The unique identifier of the parent of this billing item. - -
- - - Type: - - - int - - -

- -
- - - - - - - - - - - - - -
-
-

recurringFee

-

- - The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

recurringFeeTaxRate

-

- - The rate at which recurring fees are taxed if you are a taxable customer. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

recurringMonths

-

- - The number of months in which the recurring fees will be incurred. - -
- - - Type: - - - int - - -

- -
- - - - - - - -
-
-

serviceProviderId

-

- - This is the service provider for this billing item. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

setupFee

-

- - The setup fee, if any. This is a one time charge. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

setupFeeTaxRate

-

- - The rate at which setup fees are taxed if you are a taxable customer. - -
- - - Type: - - - decimal - - -

- -
- - - - - - - - - - -
-
-

Relational

- - - - -
-
-

account

-

- - The account that a billing item belongs to. - -
- - - Type: - - - SoftLayer_Account - - -

- -
- - - - - -
-
-

activeAgreement

-

- - None - -
- - - Type: - - - SoftLayer_Account_Agreement - - -

- -
- - - - - -
-
-

activeAgreementFlag

-

- - A flag indicating that the billing item is under an active agreement. - -
- - - Type: - - - SoftLayer_Account_Agreement - - -

- -
- - - - - -
-
-

activeAssociatedChildren

-

- - A billing item’s active associated child billing items. This includes “floating” items that are not necessarily child items of this billing item. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - - - -
-
-

activeAssociatedGuestDiskBillingItems

-

- - None - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - -
-
-

activeBundledItems

-

- - A Billing Item’s active bundled billing items. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - -
-
-

activeCancellationItem

-

- - A service cancellation request item that corresponds to the billing item. - -
- - - Type: - - - SoftLayer_Billing_Item_Cancellation_Request_Item - - -

- -
- - - - - -
-
-

activeChildren

-

- - A Billing Item’s active child billing items. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - -
-
-

activeFlag

-

- - None - -
- - - Type: - - - boolean - - -

- -
- - - - - - - -
-
-

activeSparePoolAssociatedGuestDiskBillingItems

-

- - None - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - -
-
-

activeSparePoolBundledItems

-

- - A Billing Item’s spare pool bundled billing items. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - -
-
-

associatedBillingItem

-

- - A billing item’s associated parent. This is to be used for billing items that are “floating”, and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item. - -
- - - Type: - - - SoftLayer_Billing_Item - - -

- -
- - - - - -
-
-

associatedBillingItemHistory

-

- - A history of billing items which a billing item has been associated with. - -
- - - - - Type: - - - SoftLayer_Billing_Item_Association_History[] - - -

- -
- - - - - - - - - -
-
-

associatedChildren

-

- - A Billing Item’s associated child billing items. This includes “floating” items that are not necessarily child billing items of this billing item. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - -
-
-

associatedParent

-

- - A billing item’s associated parent billing item. This object will be the same as the parent billing item if parentId is set. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - - - -
-
-

availableMatchingVlans

-

- - None - -
- - - - - Type: - - - SoftLayer_Network_Vlan[] - - -

- -
- - - - - -
-
-

bandwidthAllocation

-

- - The bandwidth allocation for a billing item. - -
- - - Type: - - - SoftLayer_Network_Bandwidth_Version1_Allocation - - -

- -
- - - - - -
-
-

billableChildren

-

- - A billing item’s recurring child items that have once been billed and are scheduled to be billed in the future. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - - - -
-
-

bundledItems

-

- - A Billing Item’s bundled billing items. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - -
-
-

canceledChildren

-

- - A Billing Item’s active child billing items. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - - - -
-
-

cancellationReason

-

- - The billing item’s cancellation reason. - -
- - - Type: - - - SoftLayer_Billing_Item_Cancellation_Reason - - -

- -
- - - - - - - -
-
-

cancellationRequests

-

- - This will return any cancellation requests that are associated with this billing item. - -
- - - - - Type: - - - SoftLayer_Billing_Item_Cancellation_Request[] - - -

- -
- - - - - -
-
-

category

-

- - The item category to which the billing item’s item belongs. - -
- - - Type: - - - SoftLayer_Product_Item_Category - - -

- -
- - - - - - - -
-
-

children

-

- - A Billing Item’s child billing items' - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - -
-
-

childrenWithActiveAgreement

-

- - A Billing Item’s active child billing items. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - - - - - - - - - - - - - -
-
-

downgradeItems

-

- - For product items which have a downgrade path defined, this will return those product items. - -
- - - - - Type: - - - SoftLayer_Product_Item[] - - -

- -
- - - - - -
-
-

filteredNextInvoiceChildren

-

- - A Billing Item’s associated child billing items, excluding some items with a $0.00 recurring fee. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - - - -
-
-

hourlyFlag

-

- - A flag that will reflect whether this billing item is billed on an hourly basis or not. - -
- - - Type: - - - boolean - - -

- -
- - - - - - - - - - - -
-
-

invoiceItem

-

- - Invoice items associated with this billing item - -
- - - Type: - - - SoftLayer_Billing_Invoice_Item - - -

- -
- - - - - - - -
-
-

invoiceItems

-

- - All invoice items associated with the billing item - -
- - - - - Type: - - - SoftLayer_Billing_Invoice_Item[] - - -

- -
- - - - - -
-
-

item

-

- - The entry in the SoftLayer product catalog that a billing item is based upon. - -
- - - Type: - - - SoftLayer_Product_Item - - -

- -
- - - - - - - - - - - -
-
-

location

-

- - The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information. - -
- - - Type: - - - SoftLayer_Location - - -

- -
- - - - - - - - - -
-
-

nextInvoiceChildren

-

- - A Billing Item’s child billing items and associated items' - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - -
-
-

nextInvoiceTotalOneTimeAmount

-

- - A Billing Item’s total, including any child billing items if they exist.' - -
- - - Type: - - - float - - -

- -
- - - - - -
-
-

nextInvoiceTotalOneTimeTaxAmount

-

- - A Billing Item’s total, including any child billing items if they exist.' - -
- - - Type: - - - float - - -

- -
- - - - - -
-
-

nextInvoiceTotalRecurringAmount

-

- - A Billing Item’s total, including any child billing items and associated billing items if they exist.' - -
- - - Type: - - - float - - -

- -
- - - - - -
-
-

nextInvoiceTotalRecurringTaxAmount

-

- - This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only. - -
- - - Type: - - - float - - -

- -
- - - - - -
-
-

nonZeroNextInvoiceChildren

-

- - A Billing Item’s associated child billing items, excluding ALL items with a $0.00 recurring fee. - -
- - - - - Type: - - - SoftLayer_Billing_Item[] - - -

- -
- - - - - - - - - - - - - -
-
-

orderItem

-

- - A billing item’s original order item. Simply a reference to the original order from which this billing item was created. - -
- - - Type: - - - SoftLayer_Billing_Order_Item - - -

- -
- - - - - - - -
-
-

originalLocation

-

- - The original physical location for this billing item–may differ from current. - -
- - - Type: - - - SoftLayer_Location - - -

- -
- - - - - -
-
-

package

-

- - The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms. - -
- - - Type: - - - SoftLayer_Product_Package - - -

- -
- - - - - - - -
-
-

parent

-

- - A billing item’s parent item. If a billing item has no parent item then this value is null. - -
- - - Type: - - - SoftLayer_Billing_Item - - -

- -
- - - - - - - -
-
-

parentVirtualGuestBillingItem

-

- - A billing item’s parent item. If a billing item has no parent item then this value is null. - -
- - - Type: - - - SoftLayer_Billing_Item_Virtual_Guest - - -

- -
- - - - - -
-
-

pendingCancellationFlag

-

- - This flag indicates whether a billing item is scheduled to be canceled or not. - -
- - - Type: - - - boolean - - -

- -
- - - - - -
-
-

pendingOrderItem

-

- - The new order item that will replace this billing item. - -
- - - Type: - - - SoftLayer_Billing_Order_Item - - -

- -
- - - - - -
-
-

provisionTransaction

-

- - Provisioning transaction for this billing item - -
- - - Type: - - - SoftLayer_Provisioning_Version1_Transaction - - -

- -
- - - - - - - - - - - -
-
-

resource

-

- - The IPsec VPN that a network tunnel billing item is associated with. - -
- - - Type: - - - SoftLayer_Network_Tunnel_Module_Context - - -

- -
- - - - - - - - - - - -
-
-

softwareDescription

-

- - A friendly description of software component - -
- - - Type: - - - SoftLayer_Software_Description - - -

- -
- - - - - -
-
-

upgradeItem

-

- - Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path. - -
- - - Type: - - - SoftLayer_Product_Item - - -

- -
- - - - - - - -
-
-

upgradeItems

-

- - Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. - -
- - - - - Type: - - - SoftLayer_Product_Item[] - - -

- -
- - - - -

Count

- - - - - - - - - - - - -
-
-

activeAssociatedChildrenCount

-

- - A count of a billing item’s active associated child billing items. This includes “floating” items that are not necessarily child items of this billing item. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - -
-
-

activeAssociatedGuestDiskBillingItemCount

-

- - A count of - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - -
-
-

activeBundledItemCount

-

- - A count of a Billing Item’s active bundled billing items. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - -
-
-

activeChildrenCount

-

- - A count of a Billing Item’s active child billing items. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - -
-
-

activeSparePoolAssociatedGuestDiskBillingItemCount

-

- - A count of - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - -
-
-

activeSparePoolBundledItemCount

-

- - A count of a Billing Item’s spare pool bundled billing items. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - - - -
-
-

associatedBillingItemHistoryCount

-

- - A count of a history of billing items which a billing item has been associated with. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - -
-
-

associatedChildrenCount

-

- - A count of a Billing Item’s associated child billing items. This includes “floating” items that are not necessarily child billing items of this billing item. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - -
-
-

associatedParentCount

-

- - A count of a billing item’s associated parent billing item. This object will be the same as the parent billing item if parentId is set. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - -
-
-

availableMatchingVlanCount

-

- - A count of - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - -
-
-

billableChildrenCount

-

- - A count of a billing item’s recurring child items that have once been billed and are scheduled to be billed in the future. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - -
-
-

bundledItemCount

-

- - A count of a Billing Item’s bundled billing items. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - -
-
-

canceledChildrenCount

-

- - A count of a Billing Item’s active child billing items. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - -
-
-

cancellationRequestCount

-

- - A count of this will return any cancellation requests that are associated with this billing item. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - - - -
-
-

childrenCount

-

- - A count of a Billing Item’s child billing items' - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - -
-
-

childrenWithActiveAgreementCount

-

- - A count of a Billing Item’s active child billing items. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - - - - - -
-
-

downgradeItemCount

-

- - A count of for product items which have a downgrade path defined, this will return those product items. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - -
-
-

filteredNextInvoiceChildrenCount

-

- - A count of a Billing Item’s associated child billing items, excluding some items with a $0.00 recurring fee. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - - - - - - - -
-
-

invoiceItemCount

-

- - A count of all invoice items associated with the billing item - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - - - - - - - - - - - - - -
-
-

nextInvoiceChildrenCount

-

- - A count of a Billing Item’s child billing items and associated items' - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - - - - - -
-
-

nonZeroNextInvoiceChildrenCount

-

- - A count of a Billing Item’s associated child billing items, excluding ALL items with a $0.00 recurring fee. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-

upgradeItemCount

-

- - A count of billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Container_Account_Historical_Summary/index.html b/reference/datatypes/SoftLayer_Container_Account_Historical_Summary/index.html deleted file mode 100644 index aded31da010..00000000000 --- a/reference/datatypes/SoftLayer_Container_Account_Historical_Summary/index.html +++ /dev/null @@ -1,381 +0,0 @@ - - - - - - - - - - - - SoftLayer_Container_Account_Historical_Summary - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Container_Account_Historical_Summary

-
-
-
-
-
- Classes - - SoftLayer_Container_Account_Historical_Summary - -
- Tags - - datatype - - sldn - - container - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Container_Account_Historical_Summary

- -
- -
- - -

Description

- - Historical Summary Container for account resource details - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

details

-

- - Array of server uptime detail containers - -
- - - - - Type: - - - SoftLayer_Container_Account_Historical_Summary_Detail[] - - -

- -
- - - - - -
-
-

endDate

-

- - The maximum date included in the summary. - -
- - - Type: - - - dateTime - - -

- -
- - - - - -
-
-

startDate

-

- - The minimum date included in the summary. - -
- - - Type: - - - dateTime - - -

- -
- - -
-
-

Relational

- - - - - - - - - -

Count

- - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Container_Account_Historical_Summary_Detail/index.html b/reference/datatypes/SoftLayer_Container_Account_Historical_Summary_Detail/index.html deleted file mode 100644 index d9e7aaef15b..00000000000 --- a/reference/datatypes/SoftLayer_Container_Account_Historical_Summary_Detail/index.html +++ /dev/null @@ -1,351 +0,0 @@ - - - - - - - - - - - - SoftLayer_Container_Account_Historical_Summary_Detail - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Container_Account_Historical_Summary_Detail

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Container_Account_Historical_Summary_Detail

- -
- -
- - -

Description

- - Historical Summary Details Container for a resource’s data - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

endDate

-

- - The maximum date included in the detail. - -
- - - Type: - - - dateTime - - -

- -
- - - - - -
-
-

startDate

-

- - The minimum date included in the detail. - -
- - - Type: - - - dateTime - - -

- -
- - -
-
-

Relational

- - - - - - - -

Count

- - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Container_Account_Historical_Summary_Detail_Uptime/index.html b/reference/datatypes/SoftLayer_Container_Account_Historical_Summary_Detail_Uptime/index.html deleted file mode 100644 index 92cb905259c..00000000000 --- a/reference/datatypes/SoftLayer_Container_Account_Historical_Summary_Detail_Uptime/index.html +++ /dev/null @@ -1,437 +0,0 @@ - - - - - - - - - - - - SoftLayer_Container_Account_Historical_Summary_Detail_Uptime - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Container_Account_Historical_Summary_Detail_Uptime

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Container_Account_Historical_Summary_Detail_Uptime

- -
- -
- - -

Description

- - Historical Summary Details Container for a host resource uptime - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

cloudComputingInstance

-

- - The hardware for uptime details. - -
- - - Type: - - - SoftLayer_Virtual_Guest - - -

- -
- - - - - -
-
-

data

-

- - The data associated with a host uptime details. - -
- - - - - Type: - - - SoftLayer_Metric_Tracking_Object_Data[] - - -

- -
- - - - - -
-
-

endDate

-

- - The maximum date included in the detail. - -
- - - Type: - - - dateTime - - -

- -
- - - - - -
-
-

hardware

-

- - The hardware for uptime details. - -
- - - Type: - - - SoftLayer_Hardware - - -

- -
- - - - - -
-
-

startDate

-

- - The minimum date included in the detail. - -
- - - Type: - - - dateTime - - -

- -
- - -
-
-

Relational

- - - - - - - - - - - - - -

Count

- - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Container_Account_Historical_Summary_Uptime/index.html b/reference/datatypes/SoftLayer_Container_Account_Historical_Summary_Uptime/index.html deleted file mode 100644 index 0dfd542bb99..00000000000 --- a/reference/datatypes/SoftLayer_Container_Account_Historical_Summary_Uptime/index.html +++ /dev/null @@ -1,381 +0,0 @@ - - - - - - - - - - - - SoftLayer_Container_Account_Historical_Summary_Uptime - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Container_Account_Historical_Summary_Uptime

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Container_Account_Historical_Summary_Uptime

- -
- -
- - -

Description

- - Historical Summary Container for account host’s resource uptime details - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

details

-

- - Array of server uptime detail containers - -
- - - - - Type: - - - SoftLayer_Container_Account_Historical_Summary_Detail[] - - -

- -
- - - - - -
-
-

endDate

-

- - The maximum date included in the summary. - -
- - - Type: - - - dateTime - - -

- -
- - - - - -
-
-

startDate

-

- - The minimum date included in the summary. - -
- - - Type: - - - dateTime - - -

- -
- - -
-
-

Relational

- - - - - - - - - -

Count

- - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Container_Auxiliary_Network_Status_Reading/index.html b/reference/datatypes/SoftLayer_Container_Auxiliary_Network_Status_Reading/index.html deleted file mode 100644 index 1118cc42b92..00000000000 --- a/reference/datatypes/SoftLayer_Container_Auxiliary_Network_Status_Reading/index.html +++ /dev/null @@ -1,809 +0,0 @@ - - - - - - - - - - - - SoftLayer_Container_Auxiliary_Network_Status_Reading - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Container_Auxiliary_Network_Status_Reading

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Container_Auxiliary_Network_Status_Reading

- -
- -
- - -

Description

- -
Deprecated
- - - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - - - -
-
-

averagePing

-

- - None - -
- - - Type: - - - float - - -

- -

Deprecated

- -
- - - - - - - -
-
-

fails

-

- - None - -
- - - Type: - - - int - - -

- -

Deprecated

- -
- - - - - - - -
-
-

frequency

-

- - None - -
- - - Type: - - - int - - -

- -

Deprecated

- -
- - - - - - - -
-
-

label

-

- - None - -
- - - Type: - - - string - - -

- -

Deprecated

- -
- - - - - - - -
-
-

lastCheckDate

-

- - None - -
- - - Type: - - - dateTime - - -

- -

Deprecated

- -
- - - - - - - -
-
-

lastDownDate

-

- - None - -
- - - Type: - - - dateTime - - -

- -

Deprecated

- -
- - - - - - - -
-
-

latency

-

- - None - -
- - - Type: - - - float - - -

- -

Deprecated

- -
- - - - - - - -
-
-

location

-

- - None - -
- - - Type: - - - string - - -

- -

Deprecated

- -
- - - - - - - -
-
-

maximumPing

-

- - None - -
- - - Type: - - - float - - -

- -

Deprecated

- -
- - - - - - - -
-
-

minimumPing

-

- - None - -
- - - Type: - - - float - - -

- -

Deprecated

- -
- - - - - - - -
-
-

pingLoss

-

- - None - -
- - - Type: - - - float - - -

- -

Deprecated

- -
- - - - - - - -
-
-

startDate

-

- - None - -
- - - Type: - - - dateTime - - -

- -

Deprecated

- -
- - - - - - - -
-
-

statusCode

-

- - None - -
- - - Type: - - - string - - -

- -

Deprecated

- -
- - - - - - - -
-
-

statusMessage

-

- - None - -
- - - Type: - - - string - - -

- -

Deprecated

- -
- - - - - - - -
-
-

target

-

- - None - -
- - - Type: - - - string - - -

- -

Deprecated

- -
- - - - - - - -
-
-

targetType

-

- - None - -
- - - Type: - - - string - - -

- -

Deprecated

- -
- - -
-
-

Relational

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Count

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Container_Bandwidth_GraphInputs/index.html b/reference/datatypes/SoftLayer_Container_Bandwidth_GraphInputs/index.html deleted file mode 100644 index 73603ae1aaa..00000000000 --- a/reference/datatypes/SoftLayer_Container_Bandwidth_GraphInputs/index.html +++ /dev/null @@ -1,438 +0,0 @@ - - - - - - - - - - - - SoftLayer_Container_Bandwidth_GraphInputs - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Container_Bandwidth_GraphInputs

-
-
-
-
-
- Classes - - SoftLayer_Container_Bandwidth_GraphInputs - -
- Tags - - datatype - - sldn - - container - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Container_Bandwidth_GraphInputs

- -
- -
- - -

Description

- - SoftLayer_Container_Bandwidth_GraphInputs models a single inbound object for a given bandwidth graph. - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

endDate

-

- - This is a unix timestamp that represents the stop date/time for a graph. - -
- - - Type: - - - dateTime - - -

- -
- - - - - -
-
-

networkInterfaceId

-

- - The front-end or back-end network uplink interface associated with this server. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

pod

-

- -

    -
  • -
- - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

serverName

-

- - This is a human readable name for the server or rack being graphed. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

startDate

-

- - This is a unix timestamp that represents the begin date/time for a graph. - -
- - - Type: - - - dateTime - - -

- -
- - -
-
-

Relational

- - - - - - - - - - - - - -

Count

- - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Container_Bandwidth_GraphOutputs/index.html b/reference/datatypes/SoftLayer_Container_Bandwidth_GraphOutputs/index.html deleted file mode 100644 index ce07dbda393..00000000000 --- a/reference/datatypes/SoftLayer_Container_Bandwidth_GraphOutputs/index.html +++ /dev/null @@ -1,407 +0,0 @@ - - - - - - - - - - - - SoftLayer_Container_Bandwidth_GraphOutputs - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Container_Bandwidth_GraphOutputs

-
-
-
-
-
- Classes - - SoftLayer_Container_Bandwidth_GraphOutputs - -
- Tags - - datatype - - sldn - - container - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Container_Bandwidth_GraphOutputs

- -
- -
- - -

Description

- - SoftLayer_Container_Bandwidth_GraphOutputs models a single outbound object for a given bandwidth graph. - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

graphImage

-

- - The raw PNG binary data to be displayed once the graph is drawn. - -
- - - Type: - - - base64Binary - - -

- -
- - - - - -
-
-

graphTitle

-

- - The title that ended up being displayed as part of the graph image. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

maxEndDate

-

- - The maximum date included in this graph. - -
- - - Type: - - - dateTime - - -

- -
- - - - - -
-
-

minStartDate

-

- - The minimum date included in this graph. - -
- - - Type: - - - dateTime - - -

- -
- - -
-
-

Relational

- - - - - - - - - - - -

Count

- - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Container_Bandwidth_Projection/index.html b/reference/datatypes/SoftLayer_Container_Bandwidth_Projection/index.html deleted file mode 100644 index e194fa0930c..00000000000 --- a/reference/datatypes/SoftLayer_Container_Bandwidth_Projection/index.html +++ /dev/null @@ -1,463 +0,0 @@ - - - - - - - - - - - - SoftLayer_Container_Bandwidth_Projection - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Container_Bandwidth_Projection

-
-
-
-
-
- Classes - - SoftLayer_Container_Bandwidth_Projection - -
- Tags - - datatype - - sldn - - container - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Container_Bandwidth_Projection

- -
- -
- - -

Description

- - SoftLayer_Container_Bandwidth_Projection models projected bandwidth use over a time range. - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

allowedUsage

-

- - Bandwidth limit for this hardware. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

estimatedUsage

-

- - Estimated bandwidth usage so far this billing cycle. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

hardwareId

-

- - Hardware ID of server to monitor. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

projectedUsage

-

- - Projected usage for this hardware based on previous usage this billing cycle. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

serverName

-

- - the text name of the server being monitored. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

startDate

-

- - The minimum date included in this list. - -
- - - Type: - - - dateTime - - -

- -
- - -
-
-

Relational

- - - - - - - - - - - - - - - -

Count

- - - - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Contact/index.html b/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Contact/index.html deleted file mode 100644 index 42aa10a2ba9..00000000000 --- a/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Contact/index.html +++ /dev/null @@ -1,642 +0,0 @@ - - - - - - - - - - - - SoftLayer_Container_Dns_Domain_Registration_Contact - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Container_Dns_Domain_Registration_Contact

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Container_Dns_Domain_Registration_Contact

- -
- -
- - -

Description

- - Contact information container for domain registration - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

address1

-

- - The street address of the contact. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

address2

-

- - The second line in the address of the contact. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

address3

-

- - The third line in the address of the contact. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

city

-

- - The city of the contact. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

country

-

- - The 2-character Country code. (i.e. US) - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

email

-

- - The email address of the contact. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

fax

-

- - The fax number of the contact. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

firstName

-

- - The first name of the contact. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

lastName

-

- - The last name of the contact. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

organizationName

-

- - The organization name of the contact. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

phone

-

- - The phone number of the contact. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

postalCode

-

- - The postal code of the contact. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

state

-

- - The state of the contact. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

type

-

- -

The type of contact. The following are the valid types of contacts:

-
    -
  • admin
  • -
  • owner
  • -
  • billing
  • -
  • tech
  • -
- -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Count

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute/index.html b/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute/index.html deleted file mode 100644 index f6d74517911..00000000000 --- a/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute/index.html +++ /dev/null @@ -1,414 +0,0 @@ - - - - - - - - - - - - SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute

- -
- -
- - -

Description

- - This container data type contains extended attributes information for a domain of country code TLD. - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

childFlag

-

- - Indicates if this is a child of another extended attribute. - -
- - - Type: - - - boolean - - -

- -
- - - - - -
-
-

description

-

- - The description of an extended attribute. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

name

-

- - The name of an extended attribute. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

options

-

- - The collection of options for an extended attribute. - -
- - - - - Type: - - - SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Option[] - - -

- -
- - - - - -
-
-

requiredFlag

-

- - Indicates if extended attribute is required. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

userDefinedFlag

-

- - User defined indicates that the value is required from outside sources. - -
- - - Type: - - - boolean - - -

- -
- - -
-
-

Relational

- - - - - - - - - - - - - - - -

Count

- - - - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Configuration/index.html b/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Configuration/index.html deleted file mode 100644 index 72327e27080..00000000000 --- a/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Configuration/index.html +++ /dev/null @@ -1,300 +0,0 @@ - - - - - - - - - - - - SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Configuration - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Configuration

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Configuration

- -
- -
- - -

Description

- - This is the data type that may need to be populated to complete registraton for domains that are country code TLD’s. - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

name

-

- - The extended attribute name. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

value

-

- - The extended attribute option value. - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - - - - -

Count

- - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Option/index.html b/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Option/index.html deleted file mode 100644 index 09c099643c0..00000000000 --- a/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Option/index.html +++ /dev/null @@ -1,358 +0,0 @@ - - - - - - - - - - - - SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Option - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Option

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Option

- -
- -
- - -

Description

- - This container data type contains extended attribute options information for a domain of country code TLD. - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

description

-

- - The description of an option. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

requireExtendedAttributes

-

- - Extended Attribute that is required for an option. - -
- - - - - Type: - - - SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Option_Require[] - - -

- -
- - - - - -
-
-

title

-

- - The title of an option. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

value

-

- - The value of an option. - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - - - - - - - - -

Count

- - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Option_Require/index.html b/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Option_Require/index.html deleted file mode 100644 index 3901f350cb5..00000000000 --- a/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Option_Require/index.html +++ /dev/null @@ -1,272 +0,0 @@ - - - - - - - - - - - - SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Option_Require - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Option_Require

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Option_Require

- -
- -
- - -

Description

- - This container data type contains the extended attribute name that is required by an extended attribute option. - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

name

-

- - The name of an extended attribute that is required by an extended attribute option. - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - - -

Count

- - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Information/index.html b/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Information/index.html deleted file mode 100644 index 137fdf41af4..00000000000 --- a/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Information/index.html +++ /dev/null @@ -1,416 +0,0 @@ - - - - - - - - - - - - SoftLayer_Container_Dns_Domain_Registration_Information - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Container_Dns_Domain_Registration_Information

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Container_Dns_Domain_Registration_Information

- -
- -
- - -

Description

- - Information container for domain registration - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

contacts

-

- - The information of the registered domain. - -
- - - - - Type: - - - SoftLayer_Container_Dns_Domain_Registration_Contact[] - - -

- -
- - - - - -
-
-

expireDate

-

- - The date that a domain is set to expire. - -
- - - Type: - - - dateTime - - -

- -
- - - - - -
-
-

nameservers

-

- - The list of nameservers for the domain. - -
- - - - - Type: - - - SoftLayer_Container_Dns_Domain_Registration_Nameserver[] - - -

- -
- - - - - -
-
-

registryCreateDate

-

- - None - -
- - - Type: - - - dateTime - - -

- -
- - - - - -
-
-

registryExpireDate

-

- - None - -
- - - Type: - - - dateTime - - -

- -
- - - - - -
-
-

registryUpdateDate

-

- - None - -
- - - Type: - - - dateTime - - -

- -
- - -
-
-

Relational

- - - - - - - - - - - - - - - -

Count

- - - - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_List/index.html b/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_List/index.html deleted file mode 100644 index 2f5578cb45d..00000000000 --- a/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_List/index.html +++ /dev/null @@ -1,360 +0,0 @@ - - - - - - - - - - - - SoftLayer_Container_Dns_Domain_Registration_List - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Container_Dns_Domain_Registration_List

-
-
-
-
-
- Classes - - SoftLayer_Container_Dns_Domain_Registration_List - -
- Tags - - datatype - - sldn - - container - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Container_Dns_Domain_Registration_List

- -
- -
- - -

Description

- - - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

domainName

-

- - The domain name. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

encodingType

-

- - Three-character language tag for the IDN domain that you’re trying to register. This is only required for IDN domains. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

extendedAttributeConfiguration

-

- -

Data required by the Registry for some country code top level domains (i.e. example.us).

-

In order to determine if a domain requires extended attributes, use SoftLayer_Dns_Domain_Registration::getExtendedAttributes service.

- - -
- - - - - Type: - - - SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Configuration[] - - -

- -
- - - - - -
-
-

registrationPeriod

-

- - The length of the registration period in years. Valid values are 1 – 10. - -
- - - Type: - - - int - - -

- -
- - -
-
-

Relational

- - - - - - - - - - - -

Count

- - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Lookup/index.html b/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Lookup/index.html deleted file mode 100644 index 87cd0d16ad5..00000000000 --- a/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Lookup/index.html +++ /dev/null @@ -1,274 +0,0 @@ - - - - - - - - - - - - SoftLayer_Container_Dns_Domain_Registration_Lookup - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Container_Dns_Domain_Registration_Lookup

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Container_Dns_Domain_Registration_Lookup

- -
- -
- - -

Description

- - Lookup domain container for domain registration - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

items

-

- - The list of available and taken domain names. - -
- - - - - Type: - - - SoftLayer_Container_Dns_Domain_Registration_Lookup_Items[] - - -

- -
- - -
-
-

Relational

- - - - - -

Count

- - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Lookup_Items/index.html b/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Lookup_Items/index.html deleted file mode 100644 index 566dfe64511..00000000000 --- a/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Lookup_Items/index.html +++ /dev/null @@ -1,300 +0,0 @@ - - - - - - - - - - - - SoftLayer_Container_Dns_Domain_Registration_Lookup_Items - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Container_Dns_Domain_Registration_Lookup_Items

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Container_Dns_Domain_Registration_Lookup_Items

- -
- -
- - -

Description

- - Lookup items container for domain registration - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

domainName

-

- - The domain name. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

status

-

- - The status of the domain name if available and can be registered. - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - - - - -

Count

- - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Nameserver/index.html b/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Nameserver/index.html deleted file mode 100644 index 1446b8e4452..00000000000 --- a/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Nameserver/index.html +++ /dev/null @@ -1,274 +0,0 @@ - - - - - - - - - - - - SoftLayer_Container_Dns_Domain_Registration_Nameserver - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Container_Dns_Domain_Registration_Nameserver

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Container_Dns_Domain_Registration_Nameserver

- -
- -
- - -

Description

- - Nameserver container for domain registration - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

nameservers

-

- - The list of fully qualified names of the nameserver. - -
- - - - - Type: - - - SoftLayer_Container_Dns_Domain_Registration_Nameserver_List[] - - -

- -
- - -
-
-

Relational

- - - - - -

Count

- - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Nameserver_List/index.html b/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Nameserver_List/index.html deleted file mode 100644 index 9459e0e9b5e..00000000000 --- a/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Nameserver_List/index.html +++ /dev/null @@ -1,356 +0,0 @@ - - - - - - - - - - - - SoftLayer_Container_Dns_Domain_Registration_Nameserver_List - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Container_Dns_Domain_Registration_Nameserver_List

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Container_Dns_Domain_Registration_Nameserver_List

- -
- -
- - -

Description

- - Nameservers list container for domain registration - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

ipv4Address

-

- - The IPv4 address of the nameserver. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

ipv6Address

-

- - The IPv6 address of the nameserver. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

name

-

- - The fully qualified name of the nameserver - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

sortOrder

-

- - The sort order of the nameserver - -
- - - Type: - - - int - - -

- -
- - -
-
-

Relational

- - - - - - - - - - - -

Count

- - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Registrant_Verification_StatusDetail/index.html b/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Registrant_Verification_StatusDetail/index.html deleted file mode 100644 index c85d3ecd2f0..00000000000 --- a/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Registrant_Verification_StatusDetail/index.html +++ /dev/null @@ -1,300 +0,0 @@ - - - - - - - - - - - - SoftLayer_Container_Dns_Domain_Registration_Registrant_Verification_StatusDetail - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Container_Dns_Domain_Registration_Registrant_Verification_StatusDetail

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Container_Dns_Domain_Registration_Registrant_Verification_StatusDetail

- -
- -
- - -

Description

- - - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

status

-

- - The current status of the verification. - -
- - - Type: - - - SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status - - -

- -
- - - - - -
-
-

verificationDeadlineDate

-

- - The adate when the domain will be suspended. - -
- - - Type: - - - dateTime - - -

- -
- - -
-
-

Relational

- - - - - - - -

Count

- - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Transfer_Information/index.html b/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Transfer_Information/index.html deleted file mode 100644 index c752ad55625..00000000000 --- a/reference/datatypes/SoftLayer_Container_Dns_Domain_Registration_Transfer_Information/index.html +++ /dev/null @@ -1,384 +0,0 @@ - - - - - - - - - - - - SoftLayer_Container_Dns_Domain_Registration_Transfer_Information - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Container_Dns_Domain_Registration_Transfer_Information

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Container_Dns_Domain_Registration_Transfer_Information

- -
- -
- - -

Description

- - Transfer Information container for domain registration - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

reason

-

- - The reason why a domain is not transferable. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

registrantEmail

-

- - The registrant email. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

status

-

- - The status of the latest transfer on the domain. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

timeStamp

-

- - The date and time of the most recent update to the state of the transfer. - -
- - - Type: - - - dateTime - - -

- -
- - - - - -
-
-

transferrable

-

- - Indicates if the domain can be transferred. - -
- - - Type: - - - int - - -

- -
- - -
-
-

Relational

- - - - - - - - - - - - - -

Count

- - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Container_Monitoring_Alarm_History/index.html b/reference/datatypes/SoftLayer_Container_Monitoring_Alarm_History/index.html deleted file mode 100644 index 932803394a8..00000000000 --- a/reference/datatypes/SoftLayer_Container_Monitoring_Alarm_History/index.html +++ /dev/null @@ -1,527 +0,0 @@ - - - - - - - - - - - - SoftLayer_Container_Monitoring_Alarm_History - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Container_Monitoring_Alarm_History

-
-
-
-
-
- Classes - - SoftLayer_Container_Monitoring_Alarm_History - -
- Tags - - datatype - - sldn - - container - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Container_Monitoring_Alarm_History

- -
- -
- - -

Description

- - The SoftLayer_Container_Monitoring_Alarm_History data type contains information relating to SoftLayer monitoring alarm history. - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

accountId

-

- - Account ID that this alarm belongs to - -
- - - Type: - - - int - - -

- -
- - - - - - - -
-
-

agentId

-

- - DEPRECATED. ID of the monitoring agent that triggered this alarm - -
- - - Type: - - - int - - -

- -

Deprecated

- -
- - - - - -
-
-

alarmId

-

- - Alarm ID - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

closedDate

-

- - Time that an alarm was closed. - -
- - - Type: - - - dateTime - - -

- -
- - - - - -
-
-

createDate

-

- - Time that an alarm was triggered - -
- - - Type: - - - dateTime - - -

- -
- - - - - -
-
-

message

-

- - Alarm message - -
- - - Type: - - - string - - -

- -
- - - - - - - -
-
-

robotId

-

- - DEPRECATED. Robot ID - -
- - - Type: - - - int - - -

- -

Deprecated

- -
- - - - - -
-
-

severity

-

- - Severity of an alarm - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - - - - - - - - - - - - - - - - -

Count

- - - - - - - - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Container_Network_Authentication_Data/index.html b/reference/datatypes/SoftLayer_Container_Network_Authentication_Data/index.html deleted file mode 100644 index fa709cdaab8..00000000000 --- a/reference/datatypes/SoftLayer_Container_Network_Authentication_Data/index.html +++ /dev/null @@ -1,435 +0,0 @@ - - - - - - - - - - - - SoftLayer_Container_Network_Authentication_Data - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Container_Network_Authentication_Data

-
-
-
-
-
- Classes - - SoftLayer_Container_Network_Authentication_Data - -
- Tags - - datatype - - sldn - - container - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Container_Network_Authentication_Data

- -
- -
- - -

Description

- - This object holds authentication data to a server. - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

host

-

- - The name of a host - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

password

-

- - The authentication password - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

port

-

- - The port number - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

type

-

- - The type of network protocol. This can be ftp, ssh and so on. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

username

-

- - The authentication username - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - - - - - - - - - - -

Count

- - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/index.html b/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/index.html deleted file mode 100644 index 9e9f70c0d0b..00000000000 --- a/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/index.html +++ /dev/null @@ -1,495 +0,0 @@ - - - - - - - - - - - - SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader

- -
- -
- - -

Description

- -
Deprecated
- - DEPRECATED - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

delimiter

-

- - Specifies the delimiter to be used when indicating multiple values for a header. Valid delimiter is, a , , (comma), ; (semicolon), , (comma and space), or ; (semicolon and space). - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

description

-

- - The description of modify response header. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

headers

-

- - A collection of key value pairs that specify the headers and associated values to be modified. The header name and header value must be separated by colon (:). Example: [‘header1:value1’,‘header2:Value2’] - -
- - - - - Type: - - - string[] - - -

- -
- - - - - -
-
-

modResHeaderUniqueId

-

- - The uniqueId of the modify response header to which the existing behavior belongs. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

path

-

- - The path, relative to the domain that is accessed via modify response header. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

type

-

- - The type of the modify response header, could be append/modify/delete. Set this to append to add a given header value to a header name set in the headerList. Set this to delete to remove a given header value from a header name set in the headerList. Set this to overwrite to match on a specified header name and replace its existing header value with a new one you specify. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

uniqueId

-

- - The uniqueId of the mapping to which the existing behavior belongs. - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - - - - - - - - - - - - - - -

Count

- - - - - - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/index.html b/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/index.html deleted file mode 100644 index 722c729b090..00000000000 --- a/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/index.html +++ /dev/null @@ -1,577 +0,0 @@ - - - - - - - - - - - - SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_TokenAuth - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_TokenAuth

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_TokenAuth

- -
- -
- - -

Description

- -
Deprecated
- - DEPRECATED - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

aclDelimiter

-

- - Specifies a single character to separate access control list (ACL) fields. The default value is ‘!’. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

escapeTokenInputs

-

- - Possible values ‘0’ and ‘1’. If set to ‘1’, input values are escaped before adding them to the token. Default value is ‘1’. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

hmacAlgorithm

-

- - Specifies the algorithm to use for the token’s hash-based message authentication code (HMAC) field. Valid entries are ‘SHA256’, ‘SHA1’, or ‘MD5’. The default value is ‘SHA256’. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

ignoreQueryString

-

- - Possible values ‘0’ and ‘1’. If set to ‘1’, query strings are removed from a URL when computing the token’s HMAC algorithm. Default value is ‘0’. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

name

-

- - The token name. If this value is empty, then it is set to the default value ‘token’. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

path

-

- - The path, relative to the domain that is accessed via token authentication. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

tokenDelimiter

-

- - Specifies a single character to separate the individual token fields. The default value is ‘~’. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

tokenKey

-

- - The token encryption key, which specifies an even number of hex digits for the token key. An entry can be up to 64 characters in length. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

transitionKey

-

- - The token transition key, which specifies an even number of hex digits for the token transition key. An entry can be up to 64 characters in length. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

uniqueId

-

- - The uniqueId of the mapping to which the existing behavior belongs. - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - - - - - - - - - - - - - - - - - - - - -

Count

- - - - - - - - - - - - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_Purge/index.html b/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_Purge/index.html deleted file mode 100644 index 5a8002ad40e..00000000000 --- a/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_Purge/index.html +++ /dev/null @@ -1,409 +0,0 @@ - - - - - - - - - - - - SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_Purge - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_Purge

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_Purge

- -
- -
- - -

Description

- -
Deprecated
- - DEPRECATED - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

date

-

- - None - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

path

-

- - None - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

saved

-

- - None - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

status

-

- - None - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - - - - - - - - -

Count

- - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/index.html b/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/index.html deleted file mode 100644 index 83e55e319ea..00000000000 --- a/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/index.html +++ /dev/null @@ -1,579 +0,0 @@ - - - - - - - - - - - - SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_PurgeGroup - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_PurgeGroup

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_PurgeGroup

- -
- -
- - -

Description

- -
Deprecated
- - DEPRECATED - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

createDate

-

- - Date in which record is created - -
- - - Type: - - - dateTime - - -

- -
- - - - - -
-
-

groupUniqueId

-

- - A identifier that is unique to purge group. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

lastPurgeDate

-

- - The Unix timestamp of the last purge. - -
- - - Type: - - - dateTime - - -

- -
- - - - - -
-
-

name

-

- - Purge Group name. The favorite group name must be unique, but non-favorite groups do not have this limitation - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

option

-

- - The following options are available to create a Purge Group: option 1: only purge the paths in the group, but don’t save as favorite. option 2: only save the purge group as favorite, but don’t purge paths. option 3: save the purge group as favorite and also purge paths. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

pathCount

-

- - Total number of purge paths. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

paths

-

- - A collection of purge paths. - -
- - - - - Type: - - - string[] - - -

- -
- - - - - -
-
-

purgeStatus

-

- - The purge’s status when the input option field is 1 or 3. Status can be SUCCESS, FAILED, or IN_PROGRESS. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

saved

-

- - Type of the Purge Group, currently SAVED or UNSAVED. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

uniqueId

-

- - A identifier that is unique to domain mapping. - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - - - - - - - - - - - - - - - - - - - - -

Count

- - - - - - - - - - - - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_PurgeGroupHistory/index.html b/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_PurgeGroupHistory/index.html deleted file mode 100644 index a9cf4c4e15a..00000000000 --- a/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_PurgeGroupHistory/index.html +++ /dev/null @@ -1,437 +0,0 @@ - - - - - - - - - - - - SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_PurgeGroupHistory - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_PurgeGroupHistory

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_PurgeGroupHistory

- -
- -
- - -

Description

- -
Deprecated
- - DEPRECATED - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

createDate

-

- - Date in which record is created - -
- - - Type: - - - dateTime - - -

- -
- - - - - -
-
-

groupName

-

- - Purge Group name. The favorite group name must be unique, but un-favorite groups do not have this limitation - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

groupUniqueId

-

- - Purge group unique ID - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

status

-

- - The purge’s status. Status can be SUCCESS, FAILED, or IN_PROGRESS. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

uniqueId

-

- - Domain mapping unique ID. - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - - - - - - - - - - -

Count

- - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Input/index.html b/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Input/index.html deleted file mode 100644 index 30a77a7a74b..00000000000 --- a/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Input/index.html +++ /dev/null @@ -1,941 +0,0 @@ - - - - - - - - - - - - SoftLayer_Container_Network_CdnMarketplace_Configuration_Input - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Container_Network_CdnMarketplace_Configuration_Input

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Container_Network_CdnMarketplace_Configuration_Input

- -
- -
- - -

Description

- -
Deprecated
- - - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

bucketName

-

- - None - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

cacheKeyQueryRule

-

- - None - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

certificateType

-

- - None - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

cname

-

- - None - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

domain

-

- - None - -
- - - Type: - - - string - - -

- -
- - - - - - - - - - - -
-
-

fileExtension

-

- - None - -
- - - Type: - - - string - - -

- -
- - - - - - - - - - - -
-
- -

- - None - -
- - - Type: - - - string - - -

- -
- - - - - - - - - - - -
-
-

httpPort

-

- - None - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

httpsPort

-

- - None - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

oldPath

-

- - Used by the following method: updateOriginPath(). This property will store the path of the path record to be saved. The $path attribute stores the new path. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

origin

-

- - None - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

originType

-

- - None - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

path

-

- - None - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

performanceConfiguration

-

- - None - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

protocol

-

- - None - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

respectHeaders

-

- - None - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

serveStale

-

- - None - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

status

-

- - None - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

uniqueId

-

- - None - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

vendorName

-

- - None - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Count

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Mapping/index.html b/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Mapping/index.html deleted file mode 100644 index c19cf8a648f..00000000000 --- a/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Mapping/index.html +++ /dev/null @@ -1,1025 +0,0 @@ - - - - - - - - - - - - SoftLayer_Container_Network_CdnMarketplace_Configuration_Mapping - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Container_Network_CdnMarketplace_Configuration_Mapping

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Container_Network_CdnMarketplace_Configuration_Mapping

- -
- -
- - -

Description

- -
Deprecated
- - - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

akamaiCname

-

- - None - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

bucketName

-

- - None - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

cacheKeyQueryRule

-

- - None - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

certificateType

-

- - None - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

cname

-

- - None - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

createDate

-

- - None - -
- - - Type: - - - dateTime - - -

- -
- - - - - -
-
-

domain

-

- - None - -
- - - Type: - - - string - - -

- -
- - - - - - - - - - - -
-
-

fileExtension

-

- - None - -
- - - Type: - - - string - - -

- -
- - - - - -
-
- -

- - None - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

httpPort

-

- - None - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

httpsChallengeRedirectUrl

-

- - None - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

httpsChallengeResponse

-

- - None - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

httpsChallengeUrl

-

- - None - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

httpsPort

-

- - None - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

modifyDate

-

- - None - -
- - - Type: - - - dateTime - - -

- -
- - - - - -
-
-

originHost

-

- - None - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

originType

-

- - None - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

path

-

- - None - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

performanceConfiguration

-

- - None - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

protocol

-

- - None - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

respectHeaders

-

- - None - -
- - - Type: - - - boolean - - -

- -
- - - - - -
-
-

serveStale

-

- - None - -
- - - Type: - - - boolean - - -

- -
- - - - - -
-
-

status

-

- - None - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

uniqueId

-

- - None - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

vendorName

-

- - None - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Count

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Mapping_Path/index.html b/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Mapping_Path/index.html deleted file mode 100644 index 57d9a953076..00000000000 --- a/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Mapping_Path/index.html +++ /dev/null @@ -1,661 +0,0 @@ - - - - - - - - - - - - SoftLayer_Container_Network_CdnMarketplace_Configuration_Mapping_Path - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Container_Network_CdnMarketplace_Configuration_Mapping_Path

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Container_Network_CdnMarketplace_Configuration_Mapping_Path

- -
- -
- - -

Description

- -
Deprecated
- - DEPRECATED - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

bucketName

-

- - None - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

cacheKeyQueryRule

-

- - None - -
- - - Type: - - - string - - -

- -
- - - - - - - - - - - -
-
-

fileExtension

-

- - None - -
- - - Type: - - - string - - -

- -
- - - - - -
-
- -

- - None - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

httpPort

-

- - None - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

httpsPort

-

- - None - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

mappingUniqueId

-

- - None - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

origin

-

- - None - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

originType

-

- - None - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

path

-

- - None - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

performanceConfiguration

-

- - None - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

status

-

- - None - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Count

- - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Performance_DynamicContentAcceleration/index.html b/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Performance_DynamicContentAcceleration/index.html deleted file mode 100644 index 9a631969c21..00000000000 --- a/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Configuration_Performance_DynamicContentAcceleration/index.html +++ /dev/null @@ -1,381 +0,0 @@ - - - - - - - - - - - - SoftLayer_Container_Network_CdnMarketplace_Configuration_Performance_DynamicContentAcceleration - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Container_Network_CdnMarketplace_Configuration_Performance_DynamicContentAcceleration

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Container_Network_CdnMarketplace_Configuration_Performance_DynamicContentAcceleration

- -
- -
- - -

Description

- -
Deprecated
- - - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

detectionPath

-

- - DEPRECATED - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

mobileImageCompressionEnabled

-

- - DEPRECATED - -
- - - Type: - - - boolean - - -

- -
- - - - - -
-
-

prefetchEnabled

-

- - DEPRECATED - -
- - - Type: - - - boolean - - -

- -
- - -
-
-

Relational

- - - - - - - - - -

Count

- - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Metrics/index.html b/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Metrics/index.html deleted file mode 100644 index 63f4075608d..00000000000 --- a/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Metrics/index.html +++ /dev/null @@ -1,1105 +0,0 @@ - - - - - - - - - - - - SoftLayer_Container_Network_CdnMarketplace_Metrics - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Container_Network_CdnMarketplace_Metrics

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Container_Network_CdnMarketplace_Metrics

- -
- -
- - -

Description

- -
Deprecated
- - - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

descriptions

-

- - None - -
- - - - - Type: - - - string[] - - -

- -
- - - - - -
-
-

names

-

- - None - -
- - - - - Type: - - - string[] - - -

- -
- - - - - -
-
-

percentage

-

- - None - -
- - - - - Type: - - - string[] - - -

- -
- - - - - -
-
-

time

-

- - None - -
- - - - - Type: - - - int[] - - -

- -
- - - - - -
-
-

totals

-

- - None - -
- - - - - Type: - - - string[] - - -

- -
- - - - - -
-
-

type

-

- - None - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

xaxis

-

- - None - -
- - - - - Type: - - - string[] - - -

- -
- - - - - -
-
-

yaxis1

-

- - None - -
- - - - - Type: - - - string[] - - -

- -
- - - - - -
-
-

yaxis10

-

- - None - -
- - - - - Type: - - - string[] - - -

- -
- - - - - -
-
-

yaxis11

-

- - None - -
- - - - - Type: - - - string[] - - -

- -
- - - - - -
-
-

yaxis12

-

- - None - -
- - - - - Type: - - - string[] - - -

- -
- - - - - -
-
-

yaxis13

-

- - None - -
- - - - - Type: - - - string[] - - -

- -
- - - - - -
-
-

yaxis14

-

- - None - -
- - - - - Type: - - - string[] - - -

- -
- - - - - -
-
-

yaxis15

-

- - None - -
- - - - - Type: - - - string[] - - -

- -
- - - - - -
-
-

yaxis16

-

- - None - -
- - - - - Type: - - - string[] - - -

- -
- - - - - -
-
-

yaxis17

-

- - None - -
- - - - - Type: - - - string[] - - -

- -
- - - - - -
-
-

yaxis18

-

- - None - -
- - - - - Type: - - - string[] - - -

- -
- - - - - -
-
-

yaxis19

-

- - None - -
- - - - - Type: - - - string[] - - -

- -
- - - - - -
-
-

yaxis2

-

- - None - -
- - - - - Type: - - - string[] - - -

- -
- - - - - -
-
-

yaxis20

-

- - None - -
- - - - - Type: - - - string[] - - -

- -
- - - - - -
-
-

yaxis3

-

- - None - -
- - - - - Type: - - - string[] - - -

- -
- - - - - -
-
-

yaxis4

-

- - None - -
- - - - - Type: - - - string[] - - -

- -
- - - - - -
-
-

yaxis5

-

- - None - -
- - - - - Type: - - - string[] - - -

- -
- - - - - -
-
-

yaxis6

-

- - None - -
- - - - - Type: - - - string[] - - -

- -
- - - - - -
-
-

yaxis7

-

- - None - -
- - - - - Type: - - - string[] - - -

- -
- - - - - -
-
-

yaxis8

-

- - None - -
- - - - - Type: - - - string[] - - -

- -
- - - - - -
-
-

yaxis9

-

- - None - -
- - - - - Type: - - - string[] - - -

- -
- - -
-
-

Relational

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Count

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Vendor/index.html b/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Vendor/index.html deleted file mode 100644 index 997ea01b484..00000000000 --- a/reference/datatypes/SoftLayer_Container_Network_CdnMarketplace_Vendor/index.html +++ /dev/null @@ -1,409 +0,0 @@ - - - - - - - - - - - - SoftLayer_Container_Network_CdnMarketplace_Vendor - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Container_Network_CdnMarketplace_Vendor

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Container_Network_CdnMarketplace_Vendor

- -
- -
- - -

Description

- -
Deprecated
- - - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

featureSummary

-

- - None - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

features

-

- - None - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

status

-

- - None - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

vendorName

-

- - None - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - - - - - - - - -

Count

- - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Container_Network_Directory_Listing/index.html b/reference/datatypes/SoftLayer_Container_Network_Directory_Listing/index.html deleted file mode 100644 index fa6bdb7f5d1..00000000000 --- a/reference/datatypes/SoftLayer_Container_Network_Directory_Listing/index.html +++ /dev/null @@ -1,379 +0,0 @@ - - - - - - - - - - - - SoftLayer_Container_Network_Directory_Listing - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Container_Network_Directory_Listing

-
-
-
-
-
- Classes - - SoftLayer_Container_Network_Directory_Listing - -
- Tags - - datatype - - sldn - - container - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Container_Network_Directory_Listing

- -
- -
- - -

Description

- - SoftLayer_Container_Network_Directory_Listing represents a single entry in a listing of files within a remote directory. API methods that return remote directory listings typically return arrays of SoftLayer_Container_Network_Directory_Listing objects. - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

fileCount

-

- - If the file in a directory listing is a directory itself then fileCount is the number of files within the directory. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

name

-

- - The name of a directory or a file within a directory listing. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

type

-

- - The type of file in a directory listing. If a directory listing entry is a directory itself then type is set to “directory”. Otherwise, type is a blank string. - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - - - - - - -

Count

- - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Container_Network_Media_Information/index.html b/reference/datatypes/SoftLayer_Container_Network_Media_Information/index.html deleted file mode 100644 index 26618502285..00000000000 --- a/reference/datatypes/SoftLayer_Container_Network_Media_Information/index.html +++ /dev/null @@ -1,720 +0,0 @@ - - - - - - - - - - - - SoftLayer_Container_Network_Media_Information - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Container_Network_Media_Information

-
-
-
-
-
- Classes - - SoftLayer_Container_Network_Media_Information - -
- Tags - - datatype - - sldn - - container - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Container_Network_Media_Information

- -
- -
- - -

Description

- - This container class holds information on a media file such as file name, codec, frame rate and so on - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

audioBitRate

-

- - The audio bit rate - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

audioChannelMode

-

- - The audio channel mode - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

audioChannels

-

- - The number of audio channels - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

audioCodec

-

- - The audio codec name - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

audioSampleRate

-

- - The audio sample rate - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

duration

-

- - The duration of a media - -
- - - Type: - - - float - - -

- -
- - - - - -
-
-

errorMessage

-

- - The error message if any. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

file

-

- - The name of a media file - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

fileFormat

-

- - The file format - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

fileSize

-

- - The size of a media file in byte - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - -
-
-

frameRate

-

- - The frame rate - -
- - - Type: - - - float - - -

- -
- - - - - -
-
-

sizeX

-

- - The width of a media in pixel - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

sizeY

-

- - The height of a media in pixel - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

totalFrames

-

- - The total of frames - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - -
-
-

videoAspectX

-

- - The width in a video’s width to height aspect ratio - -
- - - Type: - - - float - - -

- -
- - - - - -
-
-

videoAspectY

-

- - The height in a video’s width to height aspect ratio - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

videoCodec

-

- - The video codec name - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Count

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Container_Network_Media_Transcode_Job_Watermark/index.html b/reference/datatypes/SoftLayer_Container_Network_Media_Transcode_Job_Watermark/index.html deleted file mode 100644 index b6acca06afa..00000000000 --- a/reference/datatypes/SoftLayer_Container_Network_Media_Transcode_Job_Watermark/index.html +++ /dev/null @@ -1,412 +0,0 @@ - - - - - - - - - - - - SoftLayer_Container_Network_Media_Transcode_Job_Watermark - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Container_Network_Media_Transcode_Job_Watermark

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Container_Network_Media_Transcode_Job_Watermark

- -
- -
- - -

Description

- - - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

endTime

-

- - Time to stop showing watermark in milliseconds - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

fileName

-

- - Filename of image to use as watermark in transcoding job - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

position

-

- - Position to place watermark at - -
- - - Type: - - - SoftLayer_Container_Network_Media_Transcode_Job_Watermark_Position - - -

- -
- - - - - -
-
-

startTime

-

- - Time to start showing watermark in milliseconds - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

text

-

- - Text to Place in Watermark - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

transparencyPercentage

-

- - Percentage Transparent watermark should be - -
- - - Type: - - - int - - -

- -
- - -
-
-

Relational

- - - - - - - - - - - - - - - -

Count

- - - - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Container_Network_Media_Transcode_Job_Watermark_Position/index.html b/reference/datatypes/SoftLayer_Container_Network_Media_Transcode_Job_Watermark_Position/index.html deleted file mode 100644 index 2b7ca0cbbcb..00000000000 --- a/reference/datatypes/SoftLayer_Container_Network_Media_Transcode_Job_Watermark_Position/index.html +++ /dev/null @@ -1,300 +0,0 @@ - - - - - - - - - - - - SoftLayer_Container_Network_Media_Transcode_Job_Watermark_Position - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Container_Network_Media_Transcode_Job_Watermark_Position

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Container_Network_Media_Transcode_Job_Watermark_Position

- -
- -
- - -

Description

- - - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

x

-

- - X Coordinate of Watermark - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

y

-

- - vertical Coordinate of Watermark - -
- - - Type: - - - int - - -

- -
- - -
-
-

Relational

- - - - - - - -

Count

- - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Container_Network_Media_Transcode_Preset/index.html b/reference/datatypes/SoftLayer_Container_Network_Media_Transcode_Preset/index.html deleted file mode 100644 index 92da78f23ce..00000000000 --- a/reference/datatypes/SoftLayer_Container_Network_Media_Transcode_Preset/index.html +++ /dev/null @@ -1,356 +0,0 @@ - - - - - - - - - - - - SoftLayer_Container_Network_Media_Transcode_Preset - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Container_Network_Media_Transcode_Preset

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Container_Network_Media_Transcode_Preset

- -
- -
- - -

Description

- - Transcode preset is a set of configuration parameters that defines a Transcode output format. SoftLayer_Container_Network_Media_Transcode_Preset contains a preset information defined on a Transcode server - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

GUID

-

- - The unique id that is used by a Transcode server - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

category

-

- - The category that a preset belongs to - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

description

-

- - The description of the preset - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

name

-

- - The friendly name of a preset - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - - - - - - - - -

Count

- - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Container_Network_Media_Transcode_Preset_Element/index.html b/reference/datatypes/SoftLayer_Container_Network_Media_Transcode_Preset_Element/index.html deleted file mode 100644 index 2020a0dc832..00000000000 --- a/reference/datatypes/SoftLayer_Container_Network_Media_Transcode_Preset_Element/index.html +++ /dev/null @@ -1,554 +0,0 @@ - - - - - - - - - - - - SoftLayer_Container_Network_Media_Transcode_Preset_Element - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Container_Network_Media_Transcode_Preset_Element

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Container_Network_Media_Transcode_Preset_Element

- -
- -
- - -

Description

- - Transcode preset element - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

additionalElements

-

- - The additional elements for DROPDOWNLIST element - -
- - - - - Type: - - - SoftLayer_Container_Network_Media_Transcode_Preset_Element_Option[] - - -

- -
- - - - - -
-
-

defaultValue

-

- - The default value of an element. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

description

-

- - The description of a preset element - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

enabled

-

- - The flag that indicates whether an element is enabled or not - -
- - - Type: - - - boolean - - -

- -
- - - - - -
-
-

extendedDescription

-

- - The extended description of a preset element - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

hidden

-

- - The flag that indicates whether an element is hidden or not - -
- - - Type: - - - boolean - - -

- -
- - - - - -
-
-

maximumValue

-

- - The maximum value of an element - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

minimumValue

-

- - The minimum value of an element - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

name

-

- - The name of an preset element - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

parentName

-

- - The name of a parent element - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

type

-

- - The type of an preset element. - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - - - - - - - - - - - - - - - - - - - - - - -

Count

- - - - - - - - - - - - - - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Container_Network_Media_Transcode_Preset_Element_Option/index.html b/reference/datatypes/SoftLayer_Container_Network_Media_Transcode_Preset_Element_Option/index.html deleted file mode 100644 index 209da8b64aa..00000000000 --- a/reference/datatypes/SoftLayer_Container_Network_Media_Transcode_Preset_Element_Option/index.html +++ /dev/null @@ -1,300 +0,0 @@ - - - - - - - - - - - - SoftLayer_Container_Network_Media_Transcode_Preset_Element_Option - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Container_Network_Media_Transcode_Preset_Element_Option

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Container_Network_Media_Transcode_Preset_Element_Option

- -
- -
- - -

Description

- - Transcode preset element - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

name

-

- - The name of a additional preset element - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

value

-

- - The value of a additional preset element - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - - - - -

Count

- - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Container_Network_Storage_Hub_ObjectStorage_ContentDeliveryUrl/index.html b/reference/datatypes/SoftLayer_Container_Network_Storage_Hub_ObjectStorage_ContentDeliveryUrl/index.html deleted file mode 100644 index f9d36a08530..00000000000 --- a/reference/datatypes/SoftLayer_Container_Network_Storage_Hub_ObjectStorage_ContentDeliveryUrl/index.html +++ /dev/null @@ -1,379 +0,0 @@ - - - - - - - - - - - - SoftLayer_Container_Network_Storage_Hub_ObjectStorage_ContentDeliveryUrl - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Container_Network_Storage_Hub_ObjectStorage_ContentDeliveryUrl

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Container_Network_Storage_Hub_ObjectStorage_ContentDeliveryUrl

- -
- -
- - -

Description

- - SoftLayer_Container_Network_Storage_Hub_ObjectStorage_ContentDeliveryUrl provides specific details is a container which contains the cdn urls associated with an object storage account - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

datacenter

-

- - None - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

flashUrl

-

- - None - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

httpUrl

-

- - None - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - - - - - - -

Count

- - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Container_Network_Storage_MassDataMigration_Request_Address/index.html b/reference/datatypes/SoftLayer_Container_Network_Storage_MassDataMigration_Request_Address/index.html deleted file mode 100644 index 997d160fd9f..00000000000 --- a/reference/datatypes/SoftLayer_Container_Network_Storage_MassDataMigration_Request_Address/index.html +++ /dev/null @@ -1,547 +0,0 @@ - - - - - - - - - - - - SoftLayer_Container_Network_Storage_MassDataMigration_Request_Address - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Container_Network_Storage_MassDataMigration_Request_Address

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Container_Network_Storage_MassDataMigration_Request_Address

- -
- -
- - -

Description

- - - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

address1

-

- - Line 1 of the address - typically the number and street address the MDMS device will be delivered to - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

address2

-

- - Line 2 of the address - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

addressAttention

-

- - First and last name of the customer on the shipping address - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

addressNickname

-

- - The datacenter name where the MDMS device will be shipped to - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

city

-

- - The shipping address city - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

companyName

-

- - Name of the company device is being shipped to - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

country

-

- - The shipping address country - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

postalCode

-

- - The shipping address postal code - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

state

-

- - The shipping address state - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - - - - - - - - - - - - - - - - - - -

Count

- - - - - - - - - - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Container_Network_Subnet_Registration_SubnetReference/index.html b/reference/datatypes/SoftLayer_Container_Network_Subnet_Registration_SubnetReference/index.html deleted file mode 100644 index 776896c76f6..00000000000 --- a/reference/datatypes/SoftLayer_Container_Network_Subnet_Registration_SubnetReference/index.html +++ /dev/null @@ -1,351 +0,0 @@ - - - - - - - - - - - - SoftLayer_Container_Network_Subnet_Registration_SubnetReference - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Container_Network_Subnet_Registration_SubnetReference

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Container_Network_Subnet_Registration_SubnetReference

- -
- -
- - -

Description

- - SoftLayer_Container_Network_Subnet_Registration_SubnetReference is provided to reference SoftLayer_Network_Subnet_Registration object and the SoftLayer_Network_Subnet it references, in CIDR form. - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

registrationId

-

- - The ID of the SoftLayer_Network_Subnet_Registration object. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

subnetCidr

-

- - The subnet address in CIDR form. - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - - - - -

Count

- - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Container_Network_Subnet_Registration_TransactionDetails/index.html b/reference/datatypes/SoftLayer_Container_Network_Subnet_Registration_TransactionDetails/index.html deleted file mode 100644 index 0ca50bc5f90..00000000000 --- a/reference/datatypes/SoftLayer_Container_Network_Subnet_Registration_TransactionDetails/index.html +++ /dev/null @@ -1,353 +0,0 @@ - - - - - - - - - - - - SoftLayer_Container_Network_Subnet_Registration_TransactionDetails - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Container_Network_Subnet_Registration_TransactionDetails

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Container_Network_Subnet_Registration_TransactionDetails

- -
- -
- - -

Description

- - SoftLayer_Container_Subnet_Registration_TransactionDetails is provided to return details of a newly created Subnet Registration Transaction. - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

subnetReferences

-

- - The IDs and Subnets of the SoftLayer_Network_Subnet_Registration object. - -
- - - - - Type: - - - SoftLayer_Container_Network_Subnet_Registration_SubnetReference[] - - -

- -
- - - - - -
-
-

transactionId

-

- - The ID of the Transaction object. - -
- - - Type: - - - int - - -

- -
- - -
-
-

Relational

- - - - - - - -

Count

- - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Container_Product_Order_Account_Media_Data_Transfer_Request/index.html b/reference/datatypes/SoftLayer_Container_Product_Order_Account_Media_Data_Transfer_Request/index.html deleted file mode 100644 index 3c064125e9e..00000000000 --- a/reference/datatypes/SoftLayer_Container_Product_Order_Account_Media_Data_Transfer_Request/index.html +++ /dev/null @@ -1,2264 +0,0 @@ - - - - - - - - - - - - SoftLayer_Container_Product_Order_Account_Media_Data_Transfer_Request - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Container_Product_Order_Account_Media_Data_Transfer_Request

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Container_Product_Order_Account_Media_Data_Transfer_Request

- -
- -
- - -

Description

- - This datatype is to be used for data transfer requests. - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - - - -
-
-

bigDataOrderFlag

-

- - Deprecated. - -
- - - Type: - - - boolean - - -

- -

Deprecated

- -
- - - - - -
-
-

billingInformation

-

- - Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. - -
- - - Type: - - - SoftLayer_Container_Product_Order_Billing_Information - - -

- -
- - - - - -
-
-

billingOrderItemId

-

- - This is the ID of the SoftLayer_Billing_Order_Item of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

cancelUrl

-

- - The URL to which PayPal redirects browser after checkout has been canceled before completion of a payment. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

containerIdentifier

-

- - User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it’s tied to a specific order container. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

containerSplHash

-

- - This hash is internally-generated and is used to for tracking order containers. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

currencyShortName

-

- - The currency type chosen at checkout. - -
- - - Type: - - - string - - -

- -
- - - - - - - -
-
-

deviceFingerprintId

-

- - Device Fingerprint Identifier - Optional. - -
- - - Type: - - - string - - -

- -

Deprecated

- -
- - - - - - - -
-
-

displayLayerSessionId

-

- - This has been deprecated. It is the identifier used to track configurations in legacy order forms. - -
- - - Type: - - - string - - -

- -

Deprecated

- -
- - - - - -
-
-

extendedHardwareTesting

-

- - None - -
- - - Type: - - - boolean - - -

- -
- - - - - -
-
-

flexibleCreditProgramPrice

-

- - The SoftLayer_Product_Item_Price for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. - -
- - - Type: - - - SoftLayer_Product_Item_Price - - -

- -
- - - - - -
-
-

gdprConsentFlag

-

- - This flag indicates that the customer consented to the GDPR terms for the quote. - -
- - - Type: - - - boolean - - -

- -
- - - - - -
-
-

hardware

-

- - For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of SoftLayer_Hardware objects. The hostname and domain properties are required for each hardware object. Note that virtual server (SoftLayer_Container_Product_Order_Virtual_Guest) orders may populate this field instead of the virtualGuests property. - -
- - - - - Type: - - - SoftLayer_Hardware[] - - -

- -
- - - - - -
-
-

imageTemplateGlobalIdentifier

-

- - An optional virtual disk image template identifier to be used as an installation base for a computing instance order - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

imageTemplateId

-

- - An optional virtual disk image template identifier to be used as an installation base for a computing instance order - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

isManagedOrder

-

- - Flag to identify a “managed” order. This value is set internally. - -
- - - Type: - - - int - - -

- -
- - - - - - - -
-
-

itemCategoryQuestionAnswers

-

- - The collection of SoftLayer_Container_Product_Item_Category_Question_Answer for any product category that has additional questions requiring user input. - -
- - - - - Type: - - - SoftLayer_Container_Product_Item_Category_Question_Answer[] - - -

- -

Deprecated

- -
- - - - - -
-
-

location

-

- - The SoftLayer_Location_Region keyname or specific SoftLayer_Location_Datacenter id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

locationObject

-

- - This SoftLayer_Location object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. - -
- - - Type: - - - SoftLayer_Location - - -

- -
- - - - - -
-
-

message

-

- - A generic message about the order. Does not need to be sent in with any orders. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

orderContainers

-

- -

Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another.

-

If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that’s not specific to a single order container (but the order as a whole) it must be populated on the base container.

- - -
- - - - - Type: - - - SoftLayer_Container_Product_Order[] - - -

- -
- - - - - -
-
-

orderHostnames

-

- - This is deprecated and does not do anything. - -
- - - - - Type: - - - string[] - - -

- -
- - - - - -
-
-

orderVerificationExceptions

-

- - Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. - -
- - - - - Type: - - - SoftLayer_Container_Exception[] - - -

- -
- - - - - -
-
-

packageId

-

- - The SoftLayer_Product_Package id for an order container. This is required to place an order. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

paymentType

-

- - The Payment Type is Optional. If nothing is sent in, then the normal method of payment will be used. For paypal customers, this means a paypalToken will be returned in the receipt. This token is to be used on the paypal website to complete the order. For Credit Card customers, the card on file in our system will be used to make an initial authorization. To force the order to use a payment type, use one of the following: CARD_ON_FILE or PAYPAL - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

postTaxRecurring

-

- - The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

postTaxRecurringHourly

-

- - The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

postTaxRecurringMonthly

-

- - The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

postTaxSetup

-

- - The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

preTaxRecurring

-

- - The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

preTaxRecurringHourly

-

- - The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

preTaxRecurringMonthly

-

- - The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

preTaxSetup

-

- - The pre-tax setup fee total of the order. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

presaleEvent

-

- - If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See SoftLayer_Sales_Presale_Event for more info. - -
- - - Type: - - - SoftLayer_Sales_Presale_Event - - -

- -
- - - - - -
-
-

presetId

-

- - A preset configuration id for the package. Is required if not submitting any prices. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

prices

-

- - This is a collection of SoftLayer_Product_Item_Price objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the SoftLayer_Product_Package associated with the order allows for preset prices, this property is required to place an order. - -
- - - - - Type: - - - SoftLayer_Product_Item_Price[] - - -

- -
- - - - - -
-
-

primaryDiskPartitionId

-

- - The id of a SoftLayer_Hardware_Component_Partition_Template. This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the SoftLayer_Hardware_Component_Partition_OperatingSystem service, getPartitionTemplates will return those available for the particular operating system. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

priorities

-

- - Priorities to set on replication set servers. - -
- - - - - Type: - - - string[] - - -

- -
- - - - - - - -
-
-

privateCloudOrderFlag

-

- - Deprecated. - -
- - - Type: - - - boolean - - -

- -

Deprecated

- -
- - - - - - - -
-
-

privateCloudOrderType

-

- - Deprecated. - -
- - - Type: - - - string - - -

- -

Deprecated

- -
- - - - - -
-
-

promotionCode

-

- - Optional promotion code for an order. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

properties

-

- - Generic properties. - -
- - - - - Type: - - - SoftLayer_Container_Product_Order_Property[] - - -

- -
- - - - - -
-
-

proratedInitialCharge

-

- - The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here’s how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

proratedOrderTotal

-

- - This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

provisionScripts

-

- - The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. - -
- - - - - Type: - - - string[] - - -

- -
- - - - - -
-
-

quantity

-

- - The quantity of the item being ordered - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

quoteName

-

- - A custom name to be assigned to the quote. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

regionalGroup

-

- -

Specifying a regional group name allows you to not worry about placing your server or service at a specific datacenter, but to any datacenter within that regional group. See SoftLayer_Location_Group_Regional to get a list of available regional group names.

-

location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed.

-

If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object.

- - -
- - - Type: - - - string - - -

- -
- - - - - - - - - - - - - -
-
-

resourceGroupId

-

- - Deprecated. - -
- - - Type: - - - int - - -

- -

Deprecated

- -
- - - - - - - -
-
-

resourceGroupName

-

- - Deprecated. - -
- - - Type: - - - string - - -

- -

Deprecated

- -
- - - - - -
-
-

resourceGroupTemplateId

-

- - An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

returnUrl

-

- - The URL to which PayPal redirects browser after a payment is completed. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

sendQuoteEmailFlag

-

- - This flag indicates that the quote should be sent to the email address associated with the account or order. - -
- - - Type: - - - boolean - - -

- -
- - - - - -
-
-

serverCoreCount

-

- - The number of cores for the server being ordered. This value is set internally. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

serviceToken

-

- - The token of a requesting service. Do not set. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

sourceVirtualGuestId

-

- - An optional computing instance identifier to be used as an installation base for a computing instance order - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

sshKeys

-

- - The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. - -
- - - - - Type: - - - SoftLayer_Container_Product_Order_SshKeys[] - - -

- -
- - - - - -
-
-

stepId

-

- - An optional parameter for step-based order processing. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

storageGroups

-

- -

For orders that want to add storage groups such as RAID across multiple disks, simply add SoftLayer_Container_Product_Order_Storage_Group objects to this array. Storage groups will only be used if the ‘RAID’ disk controller price is selected. Any other disk controller types will ignore the storage groups set here.

-

The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage.

- - -
- - - - - Type: - - - SoftLayer_Container_Product_Order_Storage_Group[] - - -

- -
- - - - - -
-
-

taxCacheHash

-

- - The order container may not contain the final tax rates when it is returned from SoftLayer_Product_Order::verifyOrder. This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

taxCompletedFlag

-

- - Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from SoftLayer_Product_Order::verifyOrder. - -
- - - Type: - - - boolean - - -

- -
- - - - - -
-
-

techIncubatorItemPrice

-

- - The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. - -
- - - Type: - - - SoftLayer_Product_Item_Price - - -

- -
- - - - - -
-
-

totalRecurringTax

-

- - The total tax portion of the recurring fees. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

totalSetupTax

-

- - The tax amount of the setup fees. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

usagePrices

-

- - This is a collection of SoftLayer_Product_Item_Price objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. - -
- - - - - Type: - - - SoftLayer_Product_Item_Price[] - - -

- -
- - - - - -
-
-

useHourlyPricing

-

- - An optional flag to use hourly pricing instead of standard monthly pricing. - -
- - - Type: - - - boolean - - -

- -
- - - - - -
-
-

virtualGuests

-

- - For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of SoftLayer_Virtual_Guest objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. - -
- - - - - Type: - - - SoftLayer_Virtual_Guest[] - - -

- -
- - -
-
-

Relational

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Count

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Container_Product_Order_Dns_Domain_Registration/index.html b/reference/datatypes/SoftLayer_Container_Product_Order_Dns_Domain_Registration/index.html deleted file mode 100644 index 655f5a57dfe..00000000000 --- a/reference/datatypes/SoftLayer_Container_Product_Order_Dns_Domain_Registration/index.html +++ /dev/null @@ -1,2327 +0,0 @@ - - - - - - - - - - - - SoftLayer_Container_Product_Order_Dns_Domain_Registration - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Container_Product_Order_Dns_Domain_Registration

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Container_Product_Order_Dns_Domain_Registration

- -
- -
- - -

Description

- - This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. The SoftLayer_Container_Product_Order_Dns_Domain_Registration datatype contains everything required to place a domain registration order with SoftLayer. - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

administrativeContact

-

- - Administrative contact information associated with an registraton or transfer. This is required if registration type is ’new’ or ’transfer'. - -
- - - Type: - - - SoftLayer_Container_Dns_Domain_Registration_Contact - - -

- -
- - - - - -
-
-

bigDataOrderFlag

-

- - Flag for identifying an order for Big Data Deployment. - -
- - - Type: - - - boolean - - -

- -
- - - - - -
-
-

billingContact

-

- - Billing contact information associated with an registraton or transfer. This is required if registration type is ’new’ or ’transfer'. - -
- - - Type: - - - SoftLayer_Container_Dns_Domain_Registration_Contact - - -

- -
- - - - - -
-
-

billingInformation

-

- - Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. - -
- - - Type: - - - SoftLayer_Container_Product_Order_Billing_Information - - -

- -
- - - - - -
-
-

billingOrderItemId

-

- - This is the ID of the SoftLayer_Billing_Order_Item of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

cancelUrl

-

- - The URL to which PayPal redirects browser after checkout has been canceled before completion of a payment. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

containerIdentifier

-

- - User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it’s tied to a specific order container. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

containerSplHash

-

- - This hash is internally-generated and is used to for tracking order containers. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

currencyShortName

-

- - The currency type chosen at checkout. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

deviceFingerprintId

-

- - Device Fingerprint Identifier - Optional. - -
- - - Type: - - - string - - -

- -
- - - - - - - -
-
-

displayLayerSessionId

-

- - This has been deprecated. It is the identifier used to track configurations in legacy order forms. - -
- - - Type: - - - string - - -

- -

Deprecated

- -
- - - - - -
-
-

domainRegistrationList

-

- - The list of domains to be registered. This is required if registration type is ’new’, ‘renew’, or ’transfer’. - -
- - - - - Type: - - - SoftLayer_Container_Dns_Domain_Registration_List[] - - -

- -
- - - - - -
-
-

extendedHardwareTesting

-

- - None - -
- - - Type: - - - boolean - - -

- -
- - - - - -
-
-

flexibleCreditProgramPrice

-

- - The SoftLayer_Product_Item_Price for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. - -
- - - Type: - - - SoftLayer_Product_Item_Price - - -

- -
- - - - - -
-
-

gdprConsentFlag

-

- - This flag indicates that the customer consented to the GDPR terms for the quote. - -
- - - Type: - - - boolean - - -

- -
- - - - - -
-
-

hardware

-

- - For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of SoftLayer_Hardware objects. The hostname and domain properties are required for each hardware object. Note that virtual server (SoftLayer_Container_Product_Order_Virtual_Guest) orders may populate this field instead of the virtualGuests property. - -
- - - - - Type: - - - SoftLayer_Hardware[] - - -

- -
- - - - - -
-
-

imageTemplateGlobalIdentifier

-

- - An optional virtual disk image template identifier to be used as an installation base for a computing instance order - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

imageTemplateId

-

- - An optional virtual disk image template identifier to be used as an installation base for a computing instance order - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

isManagedOrder

-

- - Flag to identify a “managed” order. This value is set internally. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

itemCategoryQuestionAnswers

-

- - The collection of SoftLayer_Container_Product_Item_Category_Question_Answer for any product category that has additional questions requiring user input. - -
- - - - - Type: - - - SoftLayer_Container_Product_Item_Category_Question_Answer[] - - -

- -
- - - - - -
-
-

location

-

- - The SoftLayer_Location_Region keyname or specific SoftLayer_Location_Datacenter id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

locationObject

-

- - This SoftLayer_Location object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. - -
- - - Type: - - - SoftLayer_Location - - -

- -
- - - - - -
-
-

message

-

- - A generic message about the order. Does not need to be sent in with any orders. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

orderContainers

-

- -

Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another.

-

If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that’s not specific to a single order container (but the order as a whole) it must be populated on the base container.

- - -
- - - - - Type: - - - SoftLayer_Container_Product_Order[] - - -

- -
- - - - - -
-
-

orderHostnames

-

- - This is deprecated and does not do anything. - -
- - - - - Type: - - - string[] - - -

- -
- - - - - -
-
-

orderVerificationExceptions

-

- - Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. - -
- - - - - Type: - - - SoftLayer_Container_Exception[] - - -

- -
- - - - - -
-
-

ownerContact

-

- - Owner contact information associated with an registraton or transfer. This is required if registration type is ’new’ or ’transfer'. - -
- - - Type: - - - SoftLayer_Container_Dns_Domain_Registration_Contact - - -

- -
- - - - - -
-
-

packageId

-

- - The SoftLayer_Product_Package id for an order container. This is required to place an order. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

paymentType

-

- - The Payment Type is Optional. If nothing is sent in, then the normal method of payment will be used. For paypal customers, this means a paypalToken will be returned in the receipt. This token is to be used on the paypal website to complete the order. For Credit Card customers, the card on file in our system will be used to make an initial authorization. To force the order to use a payment type, use one of the following: CARD_ON_FILE or PAYPAL - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

postTaxRecurring

-

- - The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

postTaxRecurringHourly

-

- - The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

postTaxRecurringMonthly

-

- - The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

postTaxSetup

-

- - The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

preTaxRecurring

-

- - The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

preTaxRecurringHourly

-

- - The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

preTaxRecurringMonthly

-

- - The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

preTaxSetup

-

- - The pre-tax setup fee total of the order. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

presaleEvent

-

- - If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See SoftLayer_Sales_Presale_Event for more info. - -
- - - Type: - - - SoftLayer_Sales_Presale_Event - - -

- -
- - - - - -
-
-

presetId

-

- - A preset configuration id for the package. Is required if not submitting any prices. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

prices

-

- - This is a collection of SoftLayer_Product_Item_Price objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the SoftLayer_Product_Package associated with the order allows for preset prices, this property is required to place an order. - -
- - - - - Type: - - - SoftLayer_Product_Item_Price[] - - -

- -
- - - - - -
-
-

primaryDiskPartitionId

-

- - The id of a SoftLayer_Hardware_Component_Partition_Template. This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the SoftLayer_Hardware_Component_Partition_OperatingSystem service, getPartitionTemplates will return those available for the particular operating system. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

priorities

-

- - Priorities to set on replication set servers. - -
- - - - - Type: - - - string[] - - -

- -
- - - - - -
-
-

privateCloudOrderFlag

-

- - Flag for identifying a container as Virtual Server (Private Node). - -
- - - Type: - - - boolean - - -

- -
- - - - - -
-
-

privateCloudOrderType

-

- - Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

promotionCode

-

- - Optional promotion code for an order. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

properties

-

- - Generic properties. - -
- - - - - Type: - - - SoftLayer_Container_Product_Order_Property[] - - -

- -
- - - - - -
-
-

proratedInitialCharge

-

- - The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here’s how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

proratedOrderTotal

-

- - This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

provisionScripts

-

- - The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. - -
- - - - - Type: - - - string[] - - -

- -
- - - - - -
-
-

quantity

-

- - The quantity of the item being ordered - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

quoteName

-

- - A custom name to be assigned to the quote. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

regionalGroup

-

- -

Specifying a regional group name allows you to not worry about placing your server or service at a specific datacenter, but to any datacenter within that regional group. See SoftLayer_Location_Group_Regional to get a list of available regional group names.

-

location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed.

-

If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object.

- - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

registrationType

-

- - The type of a domain registration order. The registration type is Required. Allowed values are new, transfer, and renew - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

resourceGroupId

-

- - An optional resource group identifier specifying the resource group to attach the order to - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

resourceGroupName

-

- - This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

resourceGroupTemplateId

-

- - An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

returnUrl

-

- - The URL to which PayPal redirects browser after a payment is completed. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

sendQuoteEmailFlag

-

- - This flag indicates that the quote should be sent to the email address associated with the account or order. - -
- - - Type: - - - boolean - - -

- -
- - - - - -
-
-

serverCoreCount

-

- - The number of cores for the server being ordered. This value is set internally. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

serviceToken

-

- - The token of a requesting service. Do not set. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

sourceVirtualGuestId

-

- - An optional computing instance identifier to be used as an installation base for a computing instance order - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

sshKeys

-

- - The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. - -
- - - - - Type: - - - SoftLayer_Container_Product_Order_SshKeys[] - - -

- -
- - - - - -
-
-

stepId

-

- - An optional parameter for step-based order processing. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

storageGroups

-

- -

For orders that want to add storage groups such as RAID across multiple disks, simply add SoftLayer_Container_Product_Order_Storage_Group objects to this array. Storage groups will only be used if the ‘RAID’ disk controller price is selected. Any other disk controller types will ignore the storage groups set here.

-

The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage.

- - -
- - - - - Type: - - - SoftLayer_Container_Product_Order_Storage_Group[] - - -

- -
- - - - - -
-
-

taxCacheHash

-

- - The order container may not contain the final tax rates when it is returned from SoftLayer_Product_Order::verifyOrder. This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

taxCompletedFlag

-

- - Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from SoftLayer_Product_Order::verifyOrder. - -
- - - Type: - - - boolean - - -

- -
- - - - - -
-
-

techIncubatorItemPrice

-

- - The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. - -
- - - Type: - - - SoftLayer_Product_Item_Price - - -

- -
- - - - - -
-
-

technicalContact

-

- - Technical contact information associated with an registraton or transfer. This is required if registration type is ’new’ or ’transfer'. - -
- - - Type: - - - SoftLayer_Container_Dns_Domain_Registration_Contact - - -

- -
- - - - - -
-
-

totalRecurringTax

-

- - The total tax portion of the recurring fees. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

totalSetupTax

-

- - The tax amount of the setup fees. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

usagePrices

-

- - This is a collection of SoftLayer_Product_Item_Price objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. - -
- - - - - Type: - - - SoftLayer_Product_Item_Price[] - - -

- -
- - - - - -
-
-

useHourlyPricing

-

- - An optional flag to use hourly pricing instead of standard monthly pricing. - -
- - - Type: - - - boolean - - -

- -
- - - - - -
-
-

virtualGuests

-

- - For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of SoftLayer_Virtual_Guest objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. - -
- - - - - Type: - - - SoftLayer_Virtual_Guest[] - - -

- -
- - -
-
-

Relational

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Count

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Container_Product_Order_Dns_Domain_Reseller/index.html b/reference/datatypes/SoftLayer_Container_Product_Order_Dns_Domain_Reseller/index.html deleted file mode 100644 index cf458500bde..00000000000 --- a/reference/datatypes/SoftLayer_Container_Product_Order_Dns_Domain_Reseller/index.html +++ /dev/null @@ -1,2185 +0,0 @@ - - - - - - - - - - - - SoftLayer_Container_Product_Order_Dns_Domain_Reseller - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Container_Product_Order_Dns_Domain_Reseller

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Container_Product_Order_Dns_Domain_Reseller

- -
- -
- - -

Description

- - This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. The SoftLayer_Container_Product_Order_Dns_Domain_Reseller datatype contains everything required to place a domain reseller credit order with SoftLayer. - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

bigDataOrderFlag

-

- - Flag for identifying an order for Big Data Deployment. - -
- - - Type: - - - boolean - - -

- -
- - - - - -
-
-

billingInformation

-

- - Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. - -
- - - Type: - - - SoftLayer_Container_Product_Order_Billing_Information - - -

- -
- - - - - -
-
-

billingOrderItemId

-

- - This is the ID of the SoftLayer_Billing_Order_Item of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

cancelUrl

-

- - The URL to which PayPal redirects browser after checkout has been canceled before completion of a payment. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

containerIdentifier

-

- - User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it’s tied to a specific order container. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

containerSplHash

-

- - This hash is internally-generated and is used to for tracking order containers. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

creditAmount

-

- - Amount to be credited to the domain reseller account. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

currencyShortName

-

- - The currency type chosen at checkout. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

deviceFingerprintId

-

- - Device Fingerprint Identifier - Optional. - -
- - - Type: - - - string - - -

- -
- - - - - - - -
-
-

displayLayerSessionId

-

- - This has been deprecated. It is the identifier used to track configurations in legacy order forms. - -
- - - Type: - - - string - - -

- -

Deprecated

- -
- - - - - -
-
-

extendedHardwareTesting

-

- - None - -
- - - Type: - - - boolean - - -

- -
- - - - - -
-
-

flexibleCreditProgramPrice

-

- - The SoftLayer_Product_Item_Price for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. - -
- - - Type: - - - SoftLayer_Product_Item_Price - - -

- -
- - - - - -
-
-

gdprConsentFlag

-

- - This flag indicates that the customer consented to the GDPR terms for the quote. - -
- - - Type: - - - boolean - - -

- -
- - - - - -
-
-

hardware

-

- - For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of SoftLayer_Hardware objects. The hostname and domain properties are required for each hardware object. Note that virtual server (SoftLayer_Container_Product_Order_Virtual_Guest) orders may populate this field instead of the virtualGuests property. - -
- - - - - Type: - - - SoftLayer_Hardware[] - - -

- -
- - - - - -
-
-

imageTemplateGlobalIdentifier

-

- - An optional virtual disk image template identifier to be used as an installation base for a computing instance order - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

imageTemplateId

-

- - An optional virtual disk image template identifier to be used as an installation base for a computing instance order - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

isManagedOrder

-

- - Flag to identify a “managed” order. This value is set internally. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

itemCategoryQuestionAnswers

-

- - The collection of SoftLayer_Container_Product_Item_Category_Question_Answer for any product category that has additional questions requiring user input. - -
- - - - - Type: - - - SoftLayer_Container_Product_Item_Category_Question_Answer[] - - -

- -
- - - - - -
-
-

location

-

- - The SoftLayer_Location_Region keyname or specific SoftLayer_Location_Datacenter id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

locationObject

-

- - This SoftLayer_Location object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. - -
- - - Type: - - - SoftLayer_Location - - -

- -
- - - - - -
-
-

message

-

- - A generic message about the order. Does not need to be sent in with any orders. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

orderContainers

-

- -

Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another.

-

If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that’s not specific to a single order container (but the order as a whole) it must be populated on the base container.

- - -
- - - - - Type: - - - SoftLayer_Container_Product_Order[] - - -

- -
- - - - - -
-
-

orderHostnames

-

- - This is deprecated and does not do anything. - -
- - - - - Type: - - - string[] - - -

- -
- - - - - -
-
-

orderVerificationExceptions

-

- - Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. - -
- - - - - Type: - - - SoftLayer_Container_Exception[] - - -

- -
- - - - - -
-
-

packageId

-

- - The SoftLayer_Product_Package id for an order container. This is required to place an order. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

paymentType

-

- - The Payment Type is Optional. If nothing is sent in, then the normal method of payment will be used. For paypal customers, this means a paypalToken will be returned in the receipt. This token is to be used on the paypal website to complete the order. For Credit Card customers, the card on file in our system will be used to make an initial authorization. To force the order to use a payment type, use one of the following: CARD_ON_FILE or PAYPAL - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

postTaxRecurring

-

- - The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

postTaxRecurringHourly

-

- - The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

postTaxRecurringMonthly

-

- - The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

postTaxSetup

-

- - The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

preTaxRecurring

-

- - The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

preTaxRecurringHourly

-

- - The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

preTaxRecurringMonthly

-

- - The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

preTaxSetup

-

- - The pre-tax setup fee total of the order. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

presaleEvent

-

- - If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See SoftLayer_Sales_Presale_Event for more info. - -
- - - Type: - - - SoftLayer_Sales_Presale_Event - - -

- -
- - - - - -
-
-

presetId

-

- - A preset configuration id for the package. Is required if not submitting any prices. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

prices

-

- - This is a collection of SoftLayer_Product_Item_Price objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the SoftLayer_Product_Package associated with the order allows for preset prices, this property is required to place an order. - -
- - - - - Type: - - - SoftLayer_Product_Item_Price[] - - -

- -
- - - - - -
-
-

primaryDiskPartitionId

-

- - The id of a SoftLayer_Hardware_Component_Partition_Template. This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the SoftLayer_Hardware_Component_Partition_OperatingSystem service, getPartitionTemplates will return those available for the particular operating system. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

priorities

-

- - Priorities to set on replication set servers. - -
- - - - - Type: - - - string[] - - -

- -
- - - - - -
-
-

privateCloudOrderFlag

-

- - Flag for identifying a container as Virtual Server (Private Node). - -
- - - Type: - - - boolean - - -

- -
- - - - - -
-
-

privateCloudOrderType

-

- - Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

promotionCode

-

- - Optional promotion code for an order. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

properties

-

- - Generic properties. - -
- - - - - Type: - - - SoftLayer_Container_Product_Order_Property[] - - -

- -
- - - - - -
-
-

proratedInitialCharge

-

- - The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here’s how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

proratedOrderTotal

-

- - This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

provisionScripts

-

- - The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. - -
- - - - - Type: - - - string[] - - -

- -
- - - - - -
-
-

quantity

-

- - The quantity of the item being ordered - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

quoteName

-

- - A custom name to be assigned to the quote. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

regionalGroup

-

- -

Specifying a regional group name allows you to not worry about placing your server or service at a specific datacenter, but to any datacenter within that regional group. See SoftLayer_Location_Group_Regional to get a list of available regional group names.

-

location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed.

-

If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object.

- - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

resourceGroupId

-

- - An optional resource group identifier specifying the resource group to attach the order to - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

resourceGroupName

-

- - This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

resourceGroupTemplateId

-

- - An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

returnUrl

-

- - The URL to which PayPal redirects browser after a payment is completed. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

sendQuoteEmailFlag

-

- - This flag indicates that the quote should be sent to the email address associated with the account or order. - -
- - - Type: - - - boolean - - -

- -
- - - - - -
-
-

serverCoreCount

-

- - The number of cores for the server being ordered. This value is set internally. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

serviceToken

-

- - The token of a requesting service. Do not set. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

sourceVirtualGuestId

-

- - An optional computing instance identifier to be used as an installation base for a computing instance order - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

sshKeys

-

- - The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. - -
- - - - - Type: - - - SoftLayer_Container_Product_Order_SshKeys[] - - -

- -
- - - - - -
-
-

stepId

-

- - An optional parameter for step-based order processing. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

storageGroups

-

- -

For orders that want to add storage groups such as RAID across multiple disks, simply add SoftLayer_Container_Product_Order_Storage_Group objects to this array. Storage groups will only be used if the ‘RAID’ disk controller price is selected. Any other disk controller types will ignore the storage groups set here.

-

The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage.

- - -
- - - - - Type: - - - SoftLayer_Container_Product_Order_Storage_Group[] - - -

- -
- - - - - -
-
-

taxCacheHash

-

- - The order container may not contain the final tax rates when it is returned from SoftLayer_Product_Order::verifyOrder. This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

taxCompletedFlag

-

- - Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from SoftLayer_Product_Order::verifyOrder. - -
- - - Type: - - - boolean - - -

- -
- - - - - -
-
-

techIncubatorItemPrice

-

- - The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. - -
- - - Type: - - - SoftLayer_Product_Item_Price - - -

- -
- - - - - -
-
-

totalRecurringTax

-

- - The total tax portion of the recurring fees. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

totalSetupTax

-

- - The tax amount of the setup fees. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

usagePrices

-

- - This is a collection of SoftLayer_Product_Item_Price objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. - -
- - - - - Type: - - - SoftLayer_Product_Item_Price[] - - -

- -
- - - - - -
-
-

useHourlyPricing

-

- - An optional flag to use hourly pricing instead of standard monthly pricing. - -
- - - Type: - - - boolean - - -

- -
- - - - - -
-
-

virtualGuests

-

- - For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of SoftLayer_Virtual_Guest objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. - -
- - - - - Type: - - - SoftLayer_Virtual_Guest[] - - -

- -
- - -
-
-

Relational

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Count

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Container_Product_Order_Network_LoadBalancer_Global/index.html b/reference/datatypes/SoftLayer_Container_Product_Order_Network_LoadBalancer_Global/index.html deleted file mode 100644 index 6f4ce981423..00000000000 --- a/reference/datatypes/SoftLayer_Container_Product_Order_Network_LoadBalancer_Global/index.html +++ /dev/null @@ -1,2217 +0,0 @@ - - - - - - - - - - - - SoftLayer_Container_Product_Order_Network_LoadBalancer_Global - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Container_Product_Order_Network_LoadBalancer_Global

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Container_Product_Order_Network_LoadBalancer_Global

- -
- -
- - -

Description

- -
Deprecated
- -

The global load balancer service has been deprecated and is no longer available.

-

This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place a global load balancer order with SoftLayer.

- - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

bigDataOrderFlag

-

- - Flag for identifying an order for Big Data Deployment. - -
- - - Type: - - - boolean - - -

- -
- - - - - -
-
-

billingInformation

-

- - Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. - -
- - - Type: - - - SoftLayer_Container_Product_Order_Billing_Information - - -

- -
- - - - - -
-
-

billingOrderItemId

-

- - This is the ID of the SoftLayer_Billing_Order_Item of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

cancelUrl

-

- - The URL to which PayPal redirects browser after checkout has been canceled before completion of a payment. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

containerIdentifier

-

- - User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it’s tied to a specific order container. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

containerSplHash

-

- - This hash is internally-generated and is used to for tracking order containers. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

currencyShortName

-

- - The currency type chosen at checkout. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

deviceFingerprintId

-

- - Device Fingerprint Identifier - Optional. - -
- - - Type: - - - string - - -

- -
- - - - - - - -
-
-

displayLayerSessionId

-

- - This has been deprecated. It is the identifier used to track configurations in legacy order forms. - -
- - - Type: - - - string - - -

- -

Deprecated

- -
- - - - - -
-
-

domain

-

- - The domain name that will be load balanced. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

extendedHardwareTesting

-

- - None - -
- - - Type: - - - boolean - - -

- -
- - - - - -
-
-

flexibleCreditProgramPrice

-

- - The SoftLayer_Product_Item_Price for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. - -
- - - Type: - - - SoftLayer_Product_Item_Price - - -

- -
- - - - - -
-
-

gdprConsentFlag

-

- - This flag indicates that the customer consented to the GDPR terms for the quote. - -
- - - Type: - - - boolean - - -

- -
- - - - - -
-
-

hardware

-

- - For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of SoftLayer_Hardware objects. The hostname and domain properties are required for each hardware object. Note that virtual server (SoftLayer_Container_Product_Order_Virtual_Guest) orders may populate this field instead of the virtualGuests property. - -
- - - - - Type: - - - SoftLayer_Hardware[] - - -

- -
- - - - - -
-
-

hostname

-

- - The hostname that will be load balanced. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

imageTemplateGlobalIdentifier

-

- - An optional virtual disk image template identifier to be used as an installation base for a computing instance order - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

imageTemplateId

-

- - An optional virtual disk image template identifier to be used as an installation base for a computing instance order - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

isManagedOrder

-

- - Flag to identify a “managed” order. This value is set internally. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

itemCategoryQuestionAnswers

-

- - The collection of SoftLayer_Container_Product_Item_Category_Question_Answer for any product category that has additional questions requiring user input. - -
- - - - - Type: - - - SoftLayer_Container_Product_Item_Category_Question_Answer[] - - -

- -
- - - - - -
-
-

location

-

- - The SoftLayer_Location_Region keyname or specific SoftLayer_Location_Datacenter id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

locationObject

-

- - This SoftLayer_Location object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. - -
- - - Type: - - - SoftLayer_Location - - -

- -
- - - - - -
-
-

message

-

- - A generic message about the order. Does not need to be sent in with any orders. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

orderContainers

-

- -

Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another.

-

If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that’s not specific to a single order container (but the order as a whole) it must be populated on the base container.

- - -
- - - - - Type: - - - SoftLayer_Container_Product_Order[] - - -

- -
- - - - - -
-
-

orderHostnames

-

- - This is deprecated and does not do anything. - -
- - - - - Type: - - - string[] - - -

- -
- - - - - -
-
-

orderVerificationExceptions

-

- - Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. - -
- - - - - Type: - - - SoftLayer_Container_Exception[] - - -

- -
- - - - - -
-
-

packageId

-

- - The SoftLayer_Product_Package id for an order container. This is required to place an order. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

paymentType

-

- - The Payment Type is Optional. If nothing is sent in, then the normal method of payment will be used. For paypal customers, this means a paypalToken will be returned in the receipt. This token is to be used on the paypal website to complete the order. For Credit Card customers, the card on file in our system will be used to make an initial authorization. To force the order to use a payment type, use one of the following: CARD_ON_FILE or PAYPAL - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

postTaxRecurring

-

- - The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

postTaxRecurringHourly

-

- - The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

postTaxRecurringMonthly

-

- - The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

postTaxSetup

-

- - The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

preTaxRecurring

-

- - The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

preTaxRecurringHourly

-

- - The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

preTaxRecurringMonthly

-

- - The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

preTaxSetup

-

- - The pre-tax setup fee total of the order. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

presaleEvent

-

- - If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See SoftLayer_Sales_Presale_Event for more info. - -
- - - Type: - - - SoftLayer_Sales_Presale_Event - - -

- -
- - - - - -
-
-

presetId

-

- - A preset configuration id for the package. Is required if not submitting any prices. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

prices

-

- - This is a collection of SoftLayer_Product_Item_Price objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the SoftLayer_Product_Package associated with the order allows for preset prices, this property is required to place an order. - -
- - - - - Type: - - - SoftLayer_Product_Item_Price[] - - -

- -
- - - - - -
-
-

primaryDiskPartitionId

-

- - The id of a SoftLayer_Hardware_Component_Partition_Template. This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the SoftLayer_Hardware_Component_Partition_OperatingSystem service, getPartitionTemplates will return those available for the particular operating system. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

priorities

-

- - Priorities to set on replication set servers. - -
- - - - - Type: - - - string[] - - -

- -
- - - - - -
-
-

privateCloudOrderFlag

-

- - Flag for identifying a container as Virtual Server (Private Node). - -
- - - Type: - - - boolean - - -

- -
- - - - - -
-
-

privateCloudOrderType

-

- - Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

promotionCode

-

- - Optional promotion code for an order. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

properties

-

- - Generic properties. - -
- - - - - Type: - - - SoftLayer_Container_Product_Order_Property[] - - -

- -
- - - - - -
-
-

proratedInitialCharge

-

- - The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here’s how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

proratedOrderTotal

-

- - This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

provisionScripts

-

- - The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. - -
- - - - - Type: - - - string[] - - -

- -
- - - - - -
-
-

quantity

-

- - The quantity of the item being ordered - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

quoteName

-

- - A custom name to be assigned to the quote. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

regionalGroup

-

- -

Specifying a regional group name allows you to not worry about placing your server or service at a specific datacenter, but to any datacenter within that regional group. See SoftLayer_Location_Group_Regional to get a list of available regional group names.

-

location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed.

-

If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object.

- - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

resourceGroupId

-

- - An optional resource group identifier specifying the resource group to attach the order to - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

resourceGroupName

-

- - This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

resourceGroupTemplateId

-

- - An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

returnUrl

-

- - The URL to which PayPal redirects browser after a payment is completed. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

sendQuoteEmailFlag

-

- - This flag indicates that the quote should be sent to the email address associated with the account or order. - -
- - - Type: - - - boolean - - -

- -
- - - - - -
-
-

serverCoreCount

-

- - The number of cores for the server being ordered. This value is set internally. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

serviceToken

-

- - The token of a requesting service. Do not set. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

sourceVirtualGuestId

-

- - An optional computing instance identifier to be used as an installation base for a computing instance order - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

sshKeys

-

- - The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. - -
- - - - - Type: - - - SoftLayer_Container_Product_Order_SshKeys[] - - -

- -
- - - - - -
-
-

stepId

-

- - An optional parameter for step-based order processing. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

storageGroups

-

- -

For orders that want to add storage groups such as RAID across multiple disks, simply add SoftLayer_Container_Product_Order_Storage_Group objects to this array. Storage groups will only be used if the ‘RAID’ disk controller price is selected. Any other disk controller types will ignore the storage groups set here.

-

The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage.

- - -
- - - - - Type: - - - SoftLayer_Container_Product_Order_Storage_Group[] - - -

- -
- - - - - -
-
-

taxCacheHash

-

- - The order container may not contain the final tax rates when it is returned from SoftLayer_Product_Order::verifyOrder. This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

taxCompletedFlag

-

- - Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from SoftLayer_Product_Order::verifyOrder. - -
- - - Type: - - - boolean - - -

- -
- - - - - -
-
-

techIncubatorItemPrice

-

- - The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. - -
- - - Type: - - - SoftLayer_Product_Item_Price - - -

- -
- - - - - -
-
-

totalRecurringTax

-

- - The total tax portion of the recurring fees. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

totalSetupTax

-

- - The tax amount of the setup fees. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

usagePrices

-

- - This is a collection of SoftLayer_Product_Item_Price objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. - -
- - - - - Type: - - - SoftLayer_Product_Item_Price[] - - -

- -
- - - - - -
-
-

useHourlyPricing

-

- - An optional flag to use hourly pricing instead of standard monthly pricing. - -
- - - Type: - - - boolean - - -

- -
- - - - - -
-
-

virtualGuests

-

- - For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of SoftLayer_Virtual_Guest objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. - -
- - - - - Type: - - - SoftLayer_Virtual_Guest[] - - -

- -
- - -
-
-

Relational

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Count

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_MassDataMigration_Request/index.html b/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_MassDataMigration_Request/index.html deleted file mode 100644 index dd029db9bcb..00000000000 --- a/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_MassDataMigration_Request/index.html +++ /dev/null @@ -1,2860 +0,0 @@ - - - - - - - - - - - - SoftLayer_Container_Product_Order_Network_Storage_MassDataMigration_Request - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Container_Product_Order_Network_Storage_MassDataMigration_Request

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Container_Product_Order_Network_Storage_MassDataMigration_Request

- -
- -
- - -

Description

- - This datatype is to be used for mass data migration requests. - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

address1

-

- - Line 1 of the address - typically the number and street address the MDMS device will be delivered to - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

address2

-

- - Line 2 of the address - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

addressAttention

-

- - First and last name of the customer on the shipping address - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

addressNickname

-

- - The datacenter name where the MDMS device will be shipped to - -
- - - Type: - - - string - - -

- -
- - - - - - - -
-
-

bigDataOrderFlag

-

- - Deprecated. - -
- - - Type: - - - boolean - - -

- -

Deprecated

- -
- - - - - -
-
-

billingInformation

-

- - Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. - -
- - - Type: - - - SoftLayer_Container_Product_Order_Billing_Information - - -

- -
- - - - - -
-
-

billingOrderItemId

-

- - This is the ID of the SoftLayer_Billing_Order_Item of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

cancelUrl

-

- - The URL to which PayPal redirects browser after checkout has been canceled before completion of a payment. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

city

-

- - The shipping address city - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

companyName

-

- - Name of the company device is being shipped to - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

containerIdentifier

-

- - User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it’s tied to a specific order container. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

containerSplHash

-

- - This hash is internally-generated and is used to for tracking order containers. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

cosAccountId

-

- - Cloud Object Storage Account ID for the data offload destination - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

cosBucketName

-

- - Cloud Object Storage Bucket for the data offload destination - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

country

-

- - The shipping address country - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

currencyShortName

-

- - The currency type chosen at checkout. - -
- - - Type: - - - string - - -

- -
- - - - - - - -
-
-

deviceFingerprintId

-

- - Device Fingerprint Identifier - Optional. - -
- - - Type: - - - string - - -

- -

Deprecated

- -
- - - - - - - -
-
-

displayLayerSessionId

-

- - This has been deprecated. It is the identifier used to track configurations in legacy order forms. - -
- - - Type: - - - string - - -

- -

Deprecated

- -
- - - - - -
-
-

eth1DefaultGateway

-

- - Default Gateway used for preconfiguring the Eth1 port on the MDMS device to access the user interface - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

eth1Netmask

-

- - Netmask used for preconfiguring the Eth1 port on the MDMS device to access the user interface - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

eth1StaticIp

-

- - Static IP Address used for preconfiguring the Eth1 port on the MDMS device to access the user interface - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

eth3Netmask

-

- - Netmask used for preconfiguring the Eth3 port on the MDMS device to enable data transfer - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

eth3StaticIp

-

- - Static IP Address used for preconfiguring the Eth3 port on the MDMS device to enable data transfer - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

extendedHardwareTesting

-

- - None - -
- - - Type: - - - boolean - - -

- -
- - - - - -
-
-

flexibleCreditProgramPrice

-

- - The SoftLayer_Product_Item_Price for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. - -
- - - Type: - - - SoftLayer_Product_Item_Price - - -

- -
- - - - - -
-
-

gdprConsentFlag

-

- - This flag indicates that the customer consented to the GDPR terms for the quote. - -
- - - Type: - - - boolean - - -

- -
- - - - - -
-
-

hardware

-

- - For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of SoftLayer_Hardware objects. The hostname and domain properties are required for each hardware object. Note that virtual server (SoftLayer_Container_Product_Order_Virtual_Guest) orders may populate this field instead of the virtualGuests property. - -
- - - - - Type: - - - SoftLayer_Hardware[] - - -

- -
- - - - - -
-
-

imageTemplateGlobalIdentifier

-

- - An optional virtual disk image template identifier to be used as an installation base for a computing instance order - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

imageTemplateId

-

- - An optional virtual disk image template identifier to be used as an installation base for a computing instance order - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

isManagedOrder

-

- - Flag to identify a “managed” order. This value is set internally. - -
- - - Type: - - - int - - -

- -
- - - - - - - -
-
-

itemCategoryQuestionAnswers

-

- - The collection of SoftLayer_Container_Product_Item_Category_Question_Answer for any product category that has additional questions requiring user input. - -
- - - - - Type: - - - SoftLayer_Container_Product_Item_Category_Question_Answer[] - - -

- -

Deprecated

- -
- - - - - -
-
-

keyContactEmails

-

- - The e-mails of the MDMS key contacts - -
- - - - - Type: - - - string[] - - -

- -
- - - - - -
-
-

keyContactNames

-

- - The names of the MDMS key contacts - -
- - - - - Type: - - - string[] - - -

- -
- - - - - -
-
-

keyContactPhoneNumbers

-

- - The phone numbers of the MDMS key contacts - -
- - - - - Type: - - - string[] - - -

- -
- - - - - -
-
-

keyContactRoles

-

- - The roles of the MDMS key contacts - -
- - - - - Type: - - - string[] - - -

- -
- - - - - -
-
-

location

-

- - The SoftLayer_Location_Region keyname or specific SoftLayer_Location_Datacenter id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

locationObject

-

- - This SoftLayer_Location object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. - -
- - - Type: - - - SoftLayer_Location - - -

- -
- - - - - -
-
-

message

-

- - A generic message about the order. Does not need to be sent in with any orders. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

orderContainers

-

- -

Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another.

-

If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that’s not specific to a single order container (but the order as a whole) it must be populated on the base container.

- - -
- - - - - Type: - - - SoftLayer_Container_Product_Order[] - - -

- -
- - - - - -
-
-

orderHostnames

-

- - This is deprecated and does not do anything. - -
- - - - - Type: - - - string[] - - -

- -
- - - - - -
-
-

orderVerificationExceptions

-

- - Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. - -
- - - - - Type: - - - SoftLayer_Container_Exception[] - - -

- -
- - - - - -
-
-

packageId

-

- - The SoftLayer_Product_Package id for an order container. This is required to place an order. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

paymentType

-

- - The Payment Type is Optional. If nothing is sent in, then the normal method of payment will be used. For paypal customers, this means a paypalToken will be returned in the receipt. This token is to be used on the paypal website to complete the order. For Credit Card customers, the card on file in our system will be used to make an initial authorization. To force the order to use a payment type, use one of the following: CARD_ON_FILE or PAYPAL - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

postTaxRecurring

-

- - The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

postTaxRecurringHourly

-

- - The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

postTaxRecurringMonthly

-

- - The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

postTaxSetup

-

- - The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

postalCode

-

- - The shipping address postal code - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

preTaxRecurring

-

- - The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

preTaxRecurringHourly

-

- - The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

preTaxRecurringMonthly

-

- - The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

preTaxSetup

-

- - The pre-tax setup fee total of the order. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

presaleEvent

-

- - If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See SoftLayer_Sales_Presale_Event for more info. - -
- - - Type: - - - SoftLayer_Sales_Presale_Event - - -

- -
- - - - - -
-
-

presetId

-

- - A preset configuration id for the package. Is required if not submitting any prices. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

prices

-

- - This is a collection of SoftLayer_Product_Item_Price objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the SoftLayer_Product_Package associated with the order allows for preset prices, this property is required to place an order. - -
- - - - - Type: - - - SoftLayer_Product_Item_Price[] - - -

- -
- - - - - -
-
-

primaryDiskPartitionId

-

- - The id of a SoftLayer_Hardware_Component_Partition_Template. This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the SoftLayer_Hardware_Component_Partition_OperatingSystem service, getPartitionTemplates will return those available for the particular operating system. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

priorities

-

- - Priorities to set on replication set servers. - -
- - - - - Type: - - - string[] - - -

- -
- - - - - - - -
-
-

privateCloudOrderFlag

-

- - Deprecated. - -
- - - Type: - - - boolean - - -

- -

Deprecated

- -
- - - - - - - -
-
-

privateCloudOrderType

-

- - Deprecated. - -
- - - Type: - - - string - - -

- -

Deprecated

- -
- - - - - -
-
-

promotionCode

-

- - Optional promotion code for an order. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

properties

-

- - Generic properties. - -
- - - - - Type: - - - SoftLayer_Container_Product_Order_Property[] - - -

- -
- - - - - -
-
-

proratedInitialCharge

-

- - The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here’s how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

proratedOrderTotal

-

- - This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

provisionScripts

-

- - The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. - -
- - - - - Type: - - - string[] - - -

- -
- - - - - -
-
-

quantity

-

- - The quantity of the item being ordered - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

quoteName

-

- - A custom name to be assigned to the quote. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

regionalGroup

-

- -

Specifying a regional group name allows you to not worry about placing your server or service at a specific datacenter, but to any datacenter within that regional group. See SoftLayer_Location_Group_Regional to get a list of available regional group names.

-

location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed.

-

If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object.

- - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

requestName

-

- - Name of the Mass Data Migration Service job request - -
- - - Type: - - - string - - -

- -
- - - - - - - -
-
-

resourceGroupId

-

- - Deprecated. - -
- - - Type: - - - int - - -

- -

Deprecated

- -
- - - - - - - -
-
-

resourceGroupName

-

- - Deprecated. - -
- - - Type: - - - string - - -

- -

Deprecated

- -
- - - - - -
-
-

resourceGroupTemplateId

-

- - An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

returnUrl

-

- - The URL to which PayPal redirects browser after a payment is completed. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

sendQuoteEmailFlag

-

- - This flag indicates that the quote should be sent to the email address associated with the account or order. - -
- - - Type: - - - boolean - - -

- -
- - - - - -
-
-

serverCoreCount

-

- - The number of cores for the server being ordered. This value is set internally. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

serviceToken

-

- - The token of a requesting service. Do not set. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

shippingAddress

-

- - Shipping address and information where device will be shipped to - -
- - - Type: - - - SoftLayer_Container_Network_Storage_MassDataMigration_Request_Address - - -

- -
- - - - - -
-
-

sourceVirtualGuestId

-

- - An optional computing instance identifier to be used as an installation base for a computing instance order - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

sshKeys

-

- - The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. - -
- - - - - Type: - - - SoftLayer_Container_Product_Order_SshKeys[] - - -

- -
- - - - - -
-
-

state

-

- - The shipping address state - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

stepId

-

- - An optional parameter for step-based order processing. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

storageGroups

-

- -

For orders that want to add storage groups such as RAID across multiple disks, simply add SoftLayer_Container_Product_Order_Storage_Group objects to this array. Storage groups will only be used if the ‘RAID’ disk controller price is selected. Any other disk controller types will ignore the storage groups set here.

-

The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage.

- - -
- - - - - Type: - - - SoftLayer_Container_Product_Order_Storage_Group[] - - -

- -
- - - - - -
-
-

taxCacheHash

-

- - The order container may not contain the final tax rates when it is returned from SoftLayer_Product_Order::verifyOrder. This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

taxCompletedFlag

-

- - Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from SoftLayer_Product_Order::verifyOrder. - -
- - - Type: - - - boolean - - -

- -
- - - - - -
-
-

techIncubatorItemPrice

-

- - The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. - -
- - - Type: - - - SoftLayer_Product_Item_Price - - -

- -
- - - - - -
-
-

totalRecurringTax

-

- - The total tax portion of the recurring fees. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

totalSetupTax

-

- - The tax amount of the setup fees. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

usagePrices

-

- - This is a collection of SoftLayer_Product_Item_Price objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. - -
- - - - - Type: - - - SoftLayer_Product_Item_Price[] - - -

- -
- - - - - -
-
-

useHourlyPricing

-

- - An optional flag to use hourly pricing instead of standard monthly pricing. - -
- - - Type: - - - boolean - - -

- -
- - - - - -
-
-

virtualGuests

-

- - For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of SoftLayer_Virtual_Guest objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. - -
- - - - - Type: - - - SoftLayer_Virtual_Guest[] - - -

- -
- - -
-
-

Relational

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Count

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Container_Product_Order_Network_Tunnel_Ipsec/index.html b/reference/datatypes/SoftLayer_Container_Product_Order_Network_Tunnel_Ipsec/index.html deleted file mode 100644 index 17a505ed935..00000000000 --- a/reference/datatypes/SoftLayer_Container_Product_Order_Network_Tunnel_Ipsec/index.html +++ /dev/null @@ -1,2236 +0,0 @@ - - - - - - - - - - - - SoftLayer_Container_Product_Order_Network_Tunnel_Ipsec - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Container_Product_Order_Network_Tunnel_Ipsec

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Container_Product_Order_Network_Tunnel_Ipsec

- -
- -
- - -

Description

- - This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place a network ipsec vpn order with SoftLayer. - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - - - -
-
-

bigDataOrderFlag

-

- - Deprecated. - -
- - - Type: - - - boolean - - -

- -

Deprecated

- -
- - - - - -
-
-

billingInformation

-

- - Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. - -
- - - Type: - - - SoftLayer_Container_Product_Order_Billing_Information - - -

- -
- - - - - -
-
-

billingOrderItemId

-

- - This is the ID of the SoftLayer_Billing_Order_Item of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

cancelUrl

-

- - The URL to which PayPal redirects browser after checkout has been canceled before completion of a payment. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

containerIdentifier

-

- - User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it’s tied to a specific order container. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

containerSplHash

-

- - This hash is internally-generated and is used to for tracking order containers. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

currencyShortName

-

- - The currency type chosen at checkout. - -
- - - Type: - - - string - - -

- -
- - - - - - - -
-
-

deviceFingerprintId

-

- - Device Fingerprint Identifier - Optional. - -
- - - Type: - - - string - - -

- -

Deprecated

- -
- - - - - - - -
-
-

displayLayerSessionId

-

- - This has been deprecated. It is the identifier used to track configurations in legacy order forms. - -
- - - Type: - - - string - - -

- -

Deprecated

- -
- - - - - -
-
-

extendedHardwareTesting

-

- - None - -
- - - Type: - - - boolean - - -

- -
- - - - - -
-
-

flexibleCreditProgramPrice

-

- - The SoftLayer_Product_Item_Price for the Flexible Credit Program discount. The oneTimeFee field contains the calculated discount being applied to the order. - -
- - - Type: - - - SoftLayer_Product_Item_Price - - -

- -
- - - - - -
-
-

gdprConsentFlag

-

- - This flag indicates that the customer consented to the GDPR terms for the quote. - -
- - - Type: - - - boolean - - -

- -
- - - - - -
-
-

hardware

-

- - For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of SoftLayer_Hardware objects. The hostname and domain properties are required for each hardware object. Note that virtual server (SoftLayer_Container_Product_Order_Virtual_Guest) orders may populate this field instead of the virtualGuests property. - -
- - - - - Type: - - - SoftLayer_Hardware[] - - -

- -
- - - - - -
-
-

imageTemplateGlobalIdentifier

-

- - An optional virtual disk image template identifier to be used as an installation base for a computing instance order - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

imageTemplateId

-

- - An optional virtual disk image template identifier to be used as an installation base for a computing instance order - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

isManagedOrder

-

- - Flag to identify a “managed” order. This value is set internally. - -
- - - Type: - - - int - - -

- -
- - - - - - - -
-
-

itemCategoryQuestionAnswers

-

- - The collection of SoftLayer_Container_Product_Item_Category_Question_Answer for any product category that has additional questions requiring user input. - -
- - - - - Type: - - - SoftLayer_Container_Product_Item_Category_Question_Answer[] - - -

- -

Deprecated

- -
- - - - - -
-
-

location

-

- - The SoftLayer_Location_Region keyname or specific SoftLayer_Location_Datacenter id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

locationObject

-

- - This SoftLayer_Location object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. - -
- - - Type: - - - SoftLayer_Location - - -

- -
- - - - - -
-
-

message

-

- - A generic message about the order. Does not need to be sent in with any orders. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

orderContainers

-

- -

Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another.

-

If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that’s not specific to a single order container (but the order as a whole) it must be populated on the base container.

- - -
- - - - - Type: - - - SoftLayer_Container_Product_Order[] - - -

- -
- - - - - -
-
-

orderHostnames

-

- - This is deprecated and does not do anything. - -
- - - - - Type: - - - string[] - - -

- -
- - - - - -
-
-

orderVerificationExceptions

-

- - Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. - -
- - - - - Type: - - - SoftLayer_Container_Exception[] - - -

- -
- - - - - -
-
-

packageId

-

- - The SoftLayer_Product_Package id for an order container. This is required to place an order. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

paymentType

-

- - The Payment Type is Optional. If nothing is sent in, then the normal method of payment will be used. For paypal customers, this means a paypalToken will be returned in the receipt. This token is to be used on the paypal website to complete the order. For Credit Card customers, the card on file in our system will be used to make an initial authorization. To force the order to use a payment type, use one of the following: CARD_ON_FILE or PAYPAL - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

postTaxRecurring

-

- - The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

postTaxRecurringHourly

-

- - The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

postTaxRecurringMonthly

-

- - The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

postTaxSetup

-

- - The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

preTaxRecurring

-

- - The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

preTaxRecurringHourly

-

- - The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

preTaxRecurringMonthly

-

- - The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

preTaxSetup

-

- - The pre-tax setup fee total of the order. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

presaleEvent

-

- - If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See SoftLayer_Sales_Presale_Event for more info. - -
- - - Type: - - - SoftLayer_Sales_Presale_Event - - -

- -
- - - - - -
-
-

presetId

-

- - A preset configuration id for the package. Is required if not submitting any prices. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

prices

-

- - This is a collection of SoftLayer_Product_Item_Price objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the SoftLayer_Product_Package associated with the order allows for preset prices, this property is required to place an order. - -
- - - - - Type: - - - SoftLayer_Product_Item_Price[] - - -

- -
- - - - - -
-
-

primaryDiskPartitionId

-

- - The id of a SoftLayer_Hardware_Component_Partition_Template. This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the SoftLayer_Hardware_Component_Partition_OperatingSystem service, getPartitionTemplates will return those available for the particular operating system. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

priorities

-

- - Priorities to set on replication set servers. - -
- - - - - Type: - - - string[] - - -

- -
- - - - - - - -
-
-

privateCloudOrderFlag

-

- - Deprecated. - -
- - - Type: - - - boolean - - -

- -

Deprecated

- -
- - - - - - - -
-
-

privateCloudOrderType

-

- - Deprecated. - -
- - - Type: - - - string - - -

- -

Deprecated

- -
- - - - - -
-
-

promotionCode

-

- - Optional promotion code for an order. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

properties

-

- - Generic properties. - -
- - - - - Type: - - - SoftLayer_Container_Product_Order_Property[] - - -

- -
- - - - - -
-
-

proratedInitialCharge

-

- - The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here’s how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

proratedOrderTotal

-

- - This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

provisionScripts

-

- - The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. - -
- - - - - Type: - - - string[] - - -

- -
- - - - - -
-
-

quantity

-

- - The quantity of the item being ordered - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

quoteName

-

- - A custom name to be assigned to the quote. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

regionalGroup

-

- -

Specifying a regional group name allows you to not worry about placing your server or service at a specific datacenter, but to any datacenter within that regional group. See SoftLayer_Location_Group_Regional to get a list of available regional group names.

-

location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed.

-

If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object.

- - -
- - - Type: - - - string - - -

- -
- - - - - - - -
-
-

resourceGroupId

-

- - Deprecated. - -
- - - Type: - - - int - - -

- -

Deprecated

- -
- - - - - - - -
-
-

resourceGroupName

-

- - Deprecated. - -
- - - Type: - - - string - - -

- -

Deprecated

- -
- - - - - -
-
-

resourceGroupTemplateId

-

- - An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

returnUrl

-

- - The URL to which PayPal redirects browser after a payment is completed. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

sendQuoteEmailFlag

-

- - This flag indicates that the quote should be sent to the email address associated with the account or order. - -
- - - Type: - - - boolean - - -

- -
- - - - - -
-
-

serverCoreCount

-

- - The number of cores for the server being ordered. This value is set internally. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

serviceToken

-

- - The token of a requesting service. Do not set. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

sourceVirtualGuestId

-

- - An optional computing instance identifier to be used as an installation base for a computing instance order - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

sshKeys

-

- - The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. - -
- - - - - Type: - - - SoftLayer_Container_Product_Order_SshKeys[] - - -

- -
- - - - - -
-
-

stepId

-

- - An optional parameter for step-based order processing. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

storageGroups

-

- -

For orders that want to add storage groups such as RAID across multiple disks, simply add SoftLayer_Container_Product_Order_Storage_Group objects to this array. Storage groups will only be used if the ‘RAID’ disk controller price is selected. Any other disk controller types will ignore the storage groups set here.

-

The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage.

- - -
- - - - - Type: - - - SoftLayer_Container_Product_Order_Storage_Group[] - - -

- -
- - - - - -
-
-

taxCacheHash

-

- - The order container may not contain the final tax rates when it is returned from SoftLayer_Product_Order::verifyOrder. This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

taxCompletedFlag

-

- - Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from SoftLayer_Product_Order::verifyOrder. - -
- - - Type: - - - boolean - - -

- -
- - - - - -
-
-

techIncubatorItemPrice

-

- - The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. - -
- - - Type: - - - SoftLayer_Product_Item_Price - - -

- -
- - - - - -
-
-

totalRecurringTax

-

- - The total tax portion of the recurring fees. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

totalSetupTax

-

- - The tax amount of the setup fees. - -
- - - Type: - - - decimal - - -

- -
- - - - - -
-
-

usagePrices

-

- - This is a collection of SoftLayer_Product_Item_Price objects which will be used when the service offering being ordered generates usage. This is a read-only property. Setting this property will not change the order. - -
- - - - - Type: - - - SoftLayer_Product_Item_Price[] - - -

- -
- - - - - -
-
-

useHourlyPricing

-

- - An optional flag to use hourly pricing instead of standard monthly pricing. - -
- - - Type: - - - boolean - - -

- -
- - - - - -
-
-

virtualGuests

-

- - For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of SoftLayer_Virtual_Guest objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. - -
- - - - - Type: - - - SoftLayer_Virtual_Guest[] - - -

- -
- - -
-
-

Relational

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Count

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Container_Virtual_Guest_Block_Device_Template_Group_RiasAccount/index.html b/reference/datatypes/SoftLayer_Container_Virtual_Guest_Block_Device_Template_Group_RiasAccount/index.html deleted file mode 100644 index 6e53f8add33..00000000000 --- a/reference/datatypes/SoftLayer_Container_Virtual_Guest_Block_Device_Template_Group_RiasAccount/index.html +++ /dev/null @@ -1,379 +0,0 @@ - - - - - - - - - - - - SoftLayer_Container_Virtual_Guest_Block_Device_Template_Group_RiasAccount - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Container_Virtual_Guest_Block_Device_Template_Group_RiasAccount

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Container_Virtual_Guest_Block_Device_Template_Group_RiasAccount

- -
- -
- - -

Description

- - - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

accountId

-

- - None - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

masterUserId

-

- - None - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

token

-

- - None - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - - - - - - -

Count

- - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Dns_Domain_Registration/index.html b/reference/datatypes/SoftLayer_Dns_Domain_Registration/index.html deleted file mode 100644 index 54e1b12665d..00000000000 --- a/reference/datatypes/SoftLayer_Dns_Domain_Registration/index.html +++ /dev/null @@ -1,611 +0,0 @@ - - - - - - - - - - - - SoftLayer_Dns_Domain_Registration - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Dns_Domain_Registration

-
-
-
-
-
- Classes - - SoftLayer_Dns_Domain_Registration - -
- Tags - - datatype - - sldn - - dns - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Dns_Domain_Registration

- -
- -
- - -

Description

- -
Deprecated
- - The SoftLayer_Dns_Domain_Registration data type represents a domain registration record. - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - - - -
-
-

createDate

-

- - None - -
- - - Type: - - - dateTime - - -

- -
- - - - - - - -
-
-

domainRegistrationStatusId

-

- - None - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

expireDate

-

- - The date that the domain registration will expire. - -
- - - Type: - - - dateTime - - -

- -
- - - - - -
-
-

id

-

- - A domain record’s internal identifier. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

lockedFlag

-

- - Indicates whether a domain is locked or unlocked. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

modifyDate

-

- - None - -
- - - Type: - - - dateTime - - -

- -
- - - - - -
-
-

name

-

- - A domain’s name, for example “example.com”. - -
- - - Type: - - - string - - -

- -
- - - - - - - -
-
-

registrantVerificationStatusId

-

- - None - -
- - - Type: - - - int - - -

- -
- - - - - - - -
-
-

serviceProviderId

-

- - None - -
- - - Type: - - - int - - -

- -
- - -
-
-

Relational

- - - - -
-
-

account

-

- - The SoftLayer customer account that the domain is registered to. - -
- - - Type: - - - SoftLayer_Account - - -

- -
- - - - - - - -
-
-

domainRegistrationStatus

-

- - The domain registration status. - -
- - - Type: - - - SoftLayer_Dns_Domain_Registration_Status - - -

- -
- - - - - - - - - - - - - - - - - -
-
-

registrantVerificationStatus

-

- - The registrant verification status. - -
- - - Type: - - - SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status - - -

- -
- - - - - - - -
-
-

serviceProvider

-

- - None - -
- - - Type: - - - SoftLayer_Service_Provider - - -

- -
- - - - - - -

Count

- - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status/index.html b/reference/datatypes/SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status/index.html deleted file mode 100644 index bdcf3c84122..00000000000 --- a/reference/datatypes/SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status/index.html +++ /dev/null @@ -1,366 +0,0 @@ - - - - - - - - - - - - SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status

- -
- -
- - -

Description

- -
Deprecated
- -

[DEPRECATED] SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status models the state of the registrant. Here are the following status codes:

-

*‘‘‘Admin Reviewing’’’: The registrant data has been submitted and being reviewed by compliance team. -*‘‘‘Pending’’’: The verification process has been inititated, and verification email will be sent. -*‘‘‘Suspended’’’: The registrant has failed verification and the domain has been suspended. -*‘‘‘Verified’’’: The registrant has been validated. -*‘‘‘Verifying’’’: The verification process has been initiated and is waiting for registrant response. -*‘‘‘Unverified’’’: The verification process has not been inititated.

- - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

description

-

- - The description of the registrant verification status. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

id

-

- - The unique identifier of the registrant verification status - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

keyName

-

- - The unique keyname of the registrant verification status. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

name

-

- - The name of the registrant verification status. - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - - - - - - - - -

Count

- - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Dns_Domain_Registration_Status/index.html b/reference/datatypes/SoftLayer_Dns_Domain_Registration_Status/index.html deleted file mode 100644 index 0b61934e0b0..00000000000 --- a/reference/datatypes/SoftLayer_Dns_Domain_Registration_Status/index.html +++ /dev/null @@ -1,365 +0,0 @@ - - - - - - - - - - - - SoftLayer_Dns_Domain_Registration_Status - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Dns_Domain_Registration_Status

-
-
-
-
-
- Classes - - SoftLayer_Dns_Domain_Registration_Status - -
- Tags - - datatype - - sldn - - dns - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Dns_Domain_Registration_Status

- -
- -
- - -

Description

- -
Deprecated
- -

[DEPRECATED] SoftLayer_Dns_Domain_Registration_Status models the state of domain name. Here are the following status codes:

-

*‘‘‘Active’’’: This domain name is active. -*‘‘‘Pending Owner Approval’’’: Pending owner approval for completion of transfer. -*‘‘‘Pending Admin Review’’’: Pending admin review for transfer. -*‘‘‘Pending Registry’’’: Pending registry for transfer. -*‘‘‘Expired’’’: Domain name has expired.

- - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

description

-

- - The description of the domain registration status names. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

id

-

- - The unique identifier of the domain registration status - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

keyName

-

- - The unique keyname of the domain registration status. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

name

-

- - The name of the domain registration status. - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - - - - - - - - -

Count

- - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Metric_Tracking_Object_Abstract/index.html b/reference/datatypes/SoftLayer_Metric_Tracking_Object_Abstract/index.html deleted file mode 100644 index 6a8088ad3a5..00000000000 --- a/reference/datatypes/SoftLayer_Metric_Tracking_Object_Abstract/index.html +++ /dev/null @@ -1,465 +0,0 @@ - - - - - - - - - - - - SoftLayer_Metric_Tracking_Object_Abstract - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Metric_Tracking_Object_Abstract

-
-
-
-
-
- Classes - - SoftLayer_Metric_Tracking_Object_Abstract - -
- Tags - - datatype - - sldn - - metric - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Metric_Tracking_Object_Abstract

- -
- -
- - -

Description

- - SoftLayer_Metric_Tracking_Object_Abstract models a generic tracking object type. Typically a tracking object with a specific purpose has it’s own data type defined within the SoftLayer API. - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

data

-

- - The data recorded by a tracking object. - -
- - - - - Type: - - - SoftLayer_Metric_Tracking_Object_Data[] - - -

- -
- - - - - -
-
-

id

-

- - A tracking object’s internal identifier. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

label

-

- - Tracking object label - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

resourceTableId

-

- - The identifier of the existing resource this object is attempting to track. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

startDate

-

- - The date this tracker began tracking this particular resource. - -
- - - Type: - - - dateTime - - -

- -
- - - - -
-
-

Relational

- - - - - - - - - - - - - - -
-
-

type

-

- - The type of data that a tracking object polls. - -
- - - Type: - - - SoftLayer_Metric_Tracking_Object_Type - - -

- -
- - - - -

Count

- - - - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Metric_Tracking_Object_Virtual_Storage_Repository/index.html b/reference/datatypes/SoftLayer_Metric_Tracking_Object_Virtual_Storage_Repository/index.html deleted file mode 100644 index 5beb92ebfa9..00000000000 --- a/reference/datatypes/SoftLayer_Metric_Tracking_Object_Virtual_Storage_Repository/index.html +++ /dev/null @@ -1,493 +0,0 @@ - - - - - - - - - - - - SoftLayer_Metric_Tracking_Object_Virtual_Storage_Repository - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Metric_Tracking_Object_Virtual_Storage_Repository

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Metric_Tracking_Object_Virtual_Storage_Repository

- -
- -
- - -

Description

- - - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

data

-

- - The data recorded by a tracking object. - -
- - - - - Type: - - - SoftLayer_Metric_Tracking_Object_Data[] - - -

- -
- - - - - -
-
-

id

-

- - A tracking object’s internal identifier. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

label

-

- - Tracking object label - -
- - - Type: - - - string - - -

- -
- - - - - - - -
-
-

resourceTableId

-

- - The identifier of the existing resource this object is attempting to track. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

startDate

-

- - The date this tracker began tracking this particular resource. - -
- - - Type: - - - dateTime - - -

- -
- - - - -
-
-

Relational

- - - - - - - - - - -
-
-

resource

-

- - The virtual storage repository that this tracking object tracks. - -
- - - Type: - - - SoftLayer_Virtual_Storage_Repository - - -

- -
- - - - - - - - - -
-
-

type

-

- - The type of data that a tracking object polls. - -
- - - Type: - - - SoftLayer_Metric_Tracking_Object_Type - - -

- -
- - - - -

Count

- - - - - - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Network_Backbone/index.html b/reference/datatypes/SoftLayer_Network_Backbone/index.html deleted file mode 100644 index a71db5b173e..00000000000 --- a/reference/datatypes/SoftLayer_Network_Backbone/index.html +++ /dev/null @@ -1,511 +0,0 @@ - - - - - - - - - - - - SoftLayer_Network_Backbone - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_Backbone

-
-
-
-
-
- Classes - - SoftLayer_Network_Backbone - -
- Tags - - datatype - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Network_Backbone

- -
- -
- - -

Description

- -
Deprecated
- - A SoftLayer_Network_Backbone represents a single backbone connection from SoftLayer to the public Internet, from the Internet to the SoftLayer private network, or a link that connects the private networks between SoftLayer’s datacenters. The SoftLayer_Network_Backbone data type is a collection of data associated with one of those connections. - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

capacity

-

- - The numeric portion of the bandwidth capacity of a SoftLayer backbone. For instance, if a backbone is rated at “1 GigE” capacity then the capacity property of the backbone is 1. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

capacityUnits

-

- - The unit portion of the bandwidth capacity of a SoftLayer backbone. For instance, if a backbone is rated at “10 G” capacity then the capacityUnits property of the backbone is “G”. - -
- - - Type: - - - string - - -

- -
- - - - - - - -
-
-

id

-

- - A backbone’s internal identifier. - -
- - - Type: - - - int - - -

- -
- - - - - - - -
-
-

name

-

- - A backbone’s name. This is usually the name of the backbone’s network provider followed by a number in case SoftLayer uses more than one backbone from a provider. Backbone provider numbers start with the number one and increment from there. - -
- - - Type: - - - string - - -

- -
- - - - - - - -
-
-

networkComponentId

-

- - The internal identifier of the network component that backbone is connected to. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

type

-

- - Whether a SoftLayer backbone connects to the public Internet, to the private network, or connecting the private networks of SoftLayer’s datacenters. Type is either the string “public”, “private”, or “private-interconnect”. - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - - - - - - - -
-
-

health

-

- - [Deprecated] A backbone’s status. - -
- - - Type: - - - string - - -

- -

Deprecated

- -
- - - - - - - - - -
-
-

location

-

- - [Deprecated] Which of the SoftLayer datacenters a backbone is connected to. - -
- - - Type: - - - SoftLayer_Location - - -

- -

Deprecated

- -
- - - - - - - - - -
-
-

networkComponent

-

- - [Deprecated] A backbone’s primary network component. - -
- - - Type: - - - SoftLayer_Network_Component - - -

- -

Deprecated

- -
- - - - - - - - -

Count

- - - - - - - - - - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Network_Backbone_Location_Dependent/index.html b/reference/datatypes/SoftLayer_Network_Backbone_Location_Dependent/index.html deleted file mode 100644 index 9f4aa004581..00000000000 --- a/reference/datatypes/SoftLayer_Network_Backbone_Location_Dependent/index.html +++ /dev/null @@ -1,395 +0,0 @@ - - - - - - - - - - - - SoftLayer_Network_Backbone_Location_Dependent - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_Backbone_Location_Dependent

-
-
-
-
-
- Classes - - SoftLayer_Network_Backbone_Location_Dependent - -
- Tags - - datatype - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Network_Backbone_Location_Dependent

- -
- -
- - -

Description

- -
Deprecated
- - - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - - - -
-
-

dependentLocationId

-

- - None - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

id

-

- - None - -
- - - Type: - - - int - - -

- -
- - - - - - - -
-
-

sourceLocationId

-

- - None - -
- - - Type: - - - int - - -

- -
- - -
-
-

Relational

- - - - - - -
-
-

dependentLocation

-

- - None - -
- - - Type: - - - SoftLayer_Location - - -

- -

Deprecated

- -
- - - - - - - - - - - -
-
-

sourceLocation

-

- - None - -
- - - Type: - - - SoftLayer_Location - - -

- -

Deprecated

- -
- - - - - - -

Count

- - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Network_Bandwidth_Version1_Usage/index.html b/reference/datatypes/SoftLayer_Network_Bandwidth_Version1_Usage/index.html deleted file mode 100644 index 7b9d0cdf389..00000000000 --- a/reference/datatypes/SoftLayer_Network_Bandwidth_Version1_Usage/index.html +++ /dev/null @@ -1,320 +0,0 @@ - - - - - - - - - - - - SoftLayer_Network_Bandwidth_Version1_Usage - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_Bandwidth_Version1_Usage

-
-
-
-
-
- Classes - - SoftLayer_Network_Bandwidth_Version1_Usage - -
- Tags - - datatype - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Network_Bandwidth_Version1_Usage

- -
- -
- - -

Description

- - The SoftLayer_Network_Bandwidth_Version1_Usage data type contains general information relating to a single bandwidth usage record. - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - -
-
-

Relational

- - - - -
-
-

bandwidthAllotmentDetail

-

- - Bandwidth allotment detail for this hardware. - -
- - - Type: - - - SoftLayer_Network_Bandwidth_Version1_Allotment_Detail - - -

- -
- - - - -

Count

- - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Network_CdnMarketplace_Account/index.html b/reference/datatypes/SoftLayer_Network_CdnMarketplace_Account/index.html deleted file mode 100644 index d21578259a9..00000000000 --- a/reference/datatypes/SoftLayer_Network_CdnMarketplace_Account/index.html +++ /dev/null @@ -1,362 +0,0 @@ - - - - - - - - - - - - SoftLayer_Network_CdnMarketplace_Account - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_CdnMarketplace_Account

-
-
-
-
-
- Classes - - SoftLayer_Network_CdnMarketplace_Account - -
- Tags - - datatype - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Network_CdnMarketplace_Account

- -
- -
- - -

Description

- -
Deprecated
- - - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - - -
-
-

Relational

- - - - - - -
-
-

account

-

- - SoftLayer account to which the CDN account belongs. - -
- - - Type: - - - SoftLayer_Account - - -

- -

Deprecated

- -
- - - - - - - -
-
-

billingItem

-

- - An associated parent billing item which is active. - -
- - - Type: - - - SoftLayer_Billing_Item - - -

- -

Deprecated

- -
- - - - -

Count

- - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/index.html b/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/index.html deleted file mode 100644 index fe86dc54c23..00000000000 --- a/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/index.html +++ /dev/null @@ -1,412 +0,0 @@ - - - - - - - - - - - - SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking

- -
- -
- - -

Description

- -
Deprecated
- - - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

accessType

-

- - None - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

regionType

-

- - None - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

regions

-

- - None - -
- - - - - Type: - - - string[] - - -

- -
- - - - - -
-
-

status

-

- - None - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - - - - - - - - -

Count

- - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking_Type/index.html b/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking_Type/index.html deleted file mode 100644 index ab545baed84..00000000000 --- a/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking_Type/index.html +++ /dev/null @@ -1,415 +0,0 @@ - - - - - - - - - - - - SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking_Type - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking_Type

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking_Type

- -
- -
- - -

Description

- - - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

accessType

-

- - None - -
- - - - - Type: - - - string[] - - -

- -
- - - - - -
-
-

continent

-

- - None - -
- - - - - Type: - - - string[] - - -

- -
- - - - - -
-
-

countryOrRegion

-

- - None - -
- - - - - Type: - - - string[] - - -

- -
- - - - - -
-
-

regionType

-

- - None - -
- - - - - Type: - - - string[] - - -

- -
- - -
-
-

Relational

- - - - - - - - - - - -

Count

- - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/index.html b/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/index.html deleted file mode 100644 index 2aa81bb43fd..00000000000 --- a/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/index.html +++ /dev/null @@ -1,354 +0,0 @@ - - - - - - - - - - - - SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection

- -
- -
- - -

Description

- -
Deprecated
- - - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

protectionType

-

- - None - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

refererValues

-

- - None - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - - - - -

Count

- - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/index.html b/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/index.html deleted file mode 100644 index 2321edcebf8..00000000000 --- a/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/index.html +++ /dev/null @@ -1,298 +0,0 @@ - - - - - - - - - - - - SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader

- -
- -
- - -

Description

- -
Deprecated
- - - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- -
-
-

Relational

- - - -

Count

- -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/index.html b/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/index.html deleted file mode 100644 index bcbabee1608..00000000000 --- a/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/index.html +++ /dev/null @@ -1,298 +0,0 @@ - - - - - - - - - - - - SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth

- -
- -
- - -

Description

- -
Deprecated
- - - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- -
-
-

Relational

- - - -

Count

- -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/index.html b/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/index.html deleted file mode 100644 index f4ca9a89721..00000000000 --- a/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/index.html +++ /dev/null @@ -1,298 +0,0 @@ - - - - - - - - - - - - SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge

- -
- -
- - -

Description

- -
Deprecated
- - - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- -
-
-

Relational

- - - -

Count

- -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/index.html b/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/index.html deleted file mode 100644 index 56674054314..00000000000 --- a/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/index.html +++ /dev/null @@ -1,298 +0,0 @@ - - - - - - - - - - - - SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup

- -
- -
- - -

Description

- -
Deprecated
- - - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- -
-
-

Relational

- - - -

Count

- -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory/index.html b/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory/index.html deleted file mode 100644 index b6e5ba5a44a..00000000000 --- a/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory/index.html +++ /dev/null @@ -1,298 +0,0 @@ - - - - - - - - - - - - SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory

- -
- -
- - -

Description

- -
Deprecated
- - - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- -
-
-

Relational

- - - -

Count

- -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/index.html b/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/index.html deleted file mode 100644 index 52739a79e53..00000000000 --- a/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/index.html +++ /dev/null @@ -1,382 +0,0 @@ - - - - - - - - - - - - SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive

- -
- -
- - -

Description

- -
Deprecated
- - - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

createDate

-

- - date record is created - -
- - - Type: - - - dateTime - - -

- -
- - - - - -
-
-

path

-

- - Path where purge will be executed after TTL - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

timeToLive

-

- - Time interval after which purge will occur repeatedly - -
- - - Type: - - - int - - -

- -
- - -
-
-

Relational

- - - - - - - - - -

Count

- - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/index.html b/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/index.html deleted file mode 100644 index c526f7764df..00000000000 --- a/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/index.html +++ /dev/null @@ -1,298 +0,0 @@ - - - - - - - - - - - - SoftLayer_Network_CdnMarketplace_Configuration_Mapping - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_CdnMarketplace_Configuration_Mapping

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Network_CdnMarketplace_Configuration_Mapping

- -
- -
- - -

Description

- -
Deprecated
- - - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- -
-
-

Relational

- - - -

Count

- -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/index.html b/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/index.html deleted file mode 100644 index 6d89fddb9a1..00000000000 --- a/reference/datatypes/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/index.html +++ /dev/null @@ -1,298 +0,0 @@ - - - - - - - - - - - - SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path

- -
- -
- - -

Description

- -
Deprecated
- - - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- -
-
-

Relational

- - - -

Count

- -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Network_CdnMarketplace_Metrics/index.html b/reference/datatypes/SoftLayer_Network_CdnMarketplace_Metrics/index.html deleted file mode 100644 index 20e34008a17..00000000000 --- a/reference/datatypes/SoftLayer_Network_CdnMarketplace_Metrics/index.html +++ /dev/null @@ -1,298 +0,0 @@ - - - - - - - - - - - - SoftLayer_Network_CdnMarketplace_Metrics - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_CdnMarketplace_Metrics

-
-
-
-
-
- Classes - - SoftLayer_Network_CdnMarketplace_Metrics - -
- Tags - - datatype - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Network_CdnMarketplace_Metrics

- -
- -
- - -

Description

- -
Deprecated
- - - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- -
-
-

Relational

- - - -

Count

- -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Network_CdnMarketplace_Utils_Response/index.html b/reference/datatypes/SoftLayer_Network_CdnMarketplace_Utils_Response/index.html deleted file mode 100644 index a51c7cb96cf..00000000000 --- a/reference/datatypes/SoftLayer_Network_CdnMarketplace_Utils_Response/index.html +++ /dev/null @@ -1,351 +0,0 @@ - - - - - - - - - - - - SoftLayer_Network_CdnMarketplace_Utils_Response - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_CdnMarketplace_Utils_Response

-
-
-
-
-
- Classes - - SoftLayer_Network_CdnMarketplace_Utils_Response - -
- Tags - - datatype - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Network_CdnMarketplace_Utils_Response

- -
- -
- - -

Description

- - - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

code

-

- - None - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

message

-

- - None - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - - - - -

Count

- - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Network_CdnMarketplace_Vendor/index.html b/reference/datatypes/SoftLayer_Network_CdnMarketplace_Vendor/index.html deleted file mode 100644 index 59649440894..00000000000 --- a/reference/datatypes/SoftLayer_Network_CdnMarketplace_Vendor/index.html +++ /dev/null @@ -1,298 +0,0 @@ - - - - - - - - - - - - SoftLayer_Network_CdnMarketplace_Vendor - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_CdnMarketplace_Vendor

-
-
-
-
-
- Classes - - SoftLayer_Network_CdnMarketplace_Vendor - -
- Tags - - datatype - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Network_CdnMarketplace_Vendor

- -
- -
- - -

Description

- -
Deprecated
- - - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- -
-
-

Relational

- - - -

Count

- -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Network_LoadBalancer_Global_Account/index.html b/reference/datatypes/SoftLayer_Network_LoadBalancer_Global_Account/index.html deleted file mode 100644 index 826cd124165..00000000000 --- a/reference/datatypes/SoftLayer_Network_LoadBalancer_Global_Account/index.html +++ /dev/null @@ -1,641 +0,0 @@ - - - - - - - - - - - - SoftLayer_Network_LoadBalancer_Global_Account - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_LoadBalancer_Global_Account

-
-
-
-
-
- Classes - - SoftLayer_Network_LoadBalancer_Global_Account - -
- Tags - - datatype - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Network_LoadBalancer_Global_Account

- -
- -
- - -

Description

- -
Deprecated
- - The global load balancer service has been deprecated and is no longer available. - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - - - -
-
-

allowedNumberOfHosts

-

- - The maximum number of hosts that a global load balancer account is allowed to have. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

averageConnectionsPerSecond

-

- - The average amount of connections per second used within the current billing cycle. This number is updated daily. - -
- - - Type: - - - float - - -

- -
- - - - - - - -
-
-

connectionsPerSecond

-

- - The amount of connections per second a global load balancer account may use within a billing cycle without being billed for an overage. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

fallbackIp

-

- - The IP address that will be return to a DNS request when none of the hosts for a global load balancer account could be returned. - -
- - - Type: - - - string - - -

- -
- - - - - - - -
-
-

hostname

-

- - The hostname of a global load balancer account that is being load balanced. - -
- - - Type: - - - string - - -

- -
- - - - - - - -
-
-

id

-

- - The unique identifier of a global load balancer account. - -
- - - Type: - - - int - - -

- -
- - - - - - - -
-
-

loadBalanceTypeId

-

- - The identifier of the load balance method for a global load balancer account. - -
- - - Type: - - - int - - -

- -
- - - - - - - -
-
-

notes

-

- - Additional customer defined information for a global load balancer account. - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - -
-
-

account

-

- - Your SoftLayer customer account. - -
- - - Type: - - - SoftLayer_Account - - -

- -
- - - - - - - - - -
-
-

billingItem

-

- - The current billing item for a Global Load Balancer account. - -
- - - Type: - - - SoftLayer_Billing_Item - - -

- -
- - - - - - - - - - - - - -
-
-

hosts

-

- - The hosts in the load balancing pool for a global load balancer account. - -
- - - - - Type: - - - SoftLayer_Network_LoadBalancer_Global_Host[] - - -

- -
- - - - - - - -
-
-

loadBalanceType

-

- - The load balance method of a global load balancer account - -
- - - Type: - - - SoftLayer_Network_LoadBalancer_Global_Type - - -

- -
- - - - - - - -
-
-

managedResourceFlag

-

- - A flag indicating that the global load balancer is a managed resource. - -
- - - Type: - - - boolean - - -

- -
- - - - - - -

Count

- - - - - - - - - - - - - - - - -
-
-

hostCount

-

- - A count of the hosts in the load balancing pool for a global load balancer account. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Network_LoadBalancer_Global_Host/index.html b/reference/datatypes/SoftLayer_Network_LoadBalancer_Global_Host/index.html deleted file mode 100644 index 0b7d17ecd37..00000000000 --- a/reference/datatypes/SoftLayer_Network_LoadBalancer_Global_Host/index.html +++ /dev/null @@ -1,555 +0,0 @@ - - - - - - - - - - - - SoftLayer_Network_LoadBalancer_Global_Host - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_LoadBalancer_Global_Host

-
-
-
-
-
- Classes - - SoftLayer_Network_LoadBalancer_Global_Host - -
- Tags - - datatype - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Network_LoadBalancer_Global_Host

- -
- -
- - -

Description

- -
Deprecated
- - The global load balancer service has been deprecated and is no longer available. - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

destinationIp

-

- - The IP address of the host that will be returned by the global load balancers in response to a dns request. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

destinationPort

-

- - The port of the host that will be used for health checks. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

enabled

-

- - Whether the host is enabled or not. The value can be ‘0’ for disabled, or ‘1’ for enabled. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

healthCheck

-

- - The health check type of a host. Valid values include ’none’, ‘http’, and ’tcp’. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

hits

-

- - The number of times the host was selected by the load balance method. - -
- - - Type: - - - float - - -

- -
- - - - - -
-
-

id

-

- - The unique identifier of a global load balancer host. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

loadBalanceOrder

-

- - The order of this host within the load balance pool. This is only significant if the load balance method is set to failover. - -
- - - Type: - - - int - - -

- -
- - - - - - - -
-
-

location

-

- - The location of a host in a datacenter.serverRoom format. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

status

-

- - The health status of a host. The status can be either ‘UP’, ‘DOWN’, or null which could mean that the health check type is set to ’none’ or an update to the ip, port, or health check type was recently done and the host is waiting for the new status. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

weight

-

- - The load balance weight of a host. The total weight of all hosts in the load balancing pool must not exceed 100. - -
- - - Type: - - - int - - -

- -
- - -
-
-

Relational

- - - - - - - - - - - - - - - - - - -
-
-

loadBalancerAccount

-

- - The global load balancer account a host belongs to. - -
- - - Type: - - - SoftLayer_Network_LoadBalancer_Global_Account - - -

- -
- - - - - - - - - - -

Count

- - - - - - - - - - - - - - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Network_LoadBalancer_Global_Type/index.html b/reference/datatypes/SoftLayer_Network_LoadBalancer_Global_Type/index.html deleted file mode 100644 index 0364c911871..00000000000 --- a/reference/datatypes/SoftLayer_Network_LoadBalancer_Global_Type/index.html +++ /dev/null @@ -1,304 +0,0 @@ - - - - - - - - - - - - SoftLayer_Network_LoadBalancer_Global_Type - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_LoadBalancer_Global_Type

-
-
-
-
-
- Classes - - SoftLayer_Network_LoadBalancer_Global_Type - -
- Tags - - datatype - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Network_LoadBalancer_Global_Type

- -
- -
- - -

Description

- -
Deprecated
- -

The global load balancer service has been deprecated and is no longer available.

-

The SoftLayer_Network_LoadBalancer_Global_Type data type represents a single load balance method that can be assigned to a global load balancer account. The load balance method determines how hosts in a load balancing pool are chosen by the global load balancers.

- - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

id

-

- - The unique identifier of a load balance method. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

name

-

- - The name of a load balance method. - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - - - - -

Count

- - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Network_Media_Transcode_Account/index.html b/reference/datatypes/SoftLayer_Network_Media_Transcode_Account/index.html deleted file mode 100644 index 02badbc712c..00000000000 --- a/reference/datatypes/SoftLayer_Network_Media_Transcode_Account/index.html +++ /dev/null @@ -1,443 +0,0 @@ - - - - - - - - - - - - SoftLayer_Network_Media_Transcode_Account - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_Media_Transcode_Account

-
-
-
-
-
- Classes - - SoftLayer_Network_Media_Transcode_Account - -
- Tags - - datatype - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Network_Media_Transcode_Account

- -
- -
- - -

Description

- - The SoftLayer_Network_Media_Transcode_Account contains information regarding a transcode account. - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - - - -
-
-

accountId

-

- - The internal identifier of a SoftLayer account - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

createDate

-

- - The created date - -
- - - Type: - - - dateTime - - -

- -
- - - - - -
-
-

id

-

- - The internal identifier of a transcode account - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

modifyDate

-

- - The last modified date - -
- - - Type: - - - dateTime - - -

- -
- - - - - - -
-
-

Relational

- - - - -
-
-

account

-

- - The SoftLayer account information - -
- - - Type: - - - SoftLayer_Account - - -

- -
- - - - - - - - - - - - - - - -
-
-

transcodeJobs

-

- - Transcode jobs - -
- - - - - Type: - - - SoftLayer_Network_Media_Transcode_Job[] - - -

- -
- - - - -

Count

- - - - - - - - - - - - - - -
-
-

transcodeJobCount

-

- - A count of transcode jobs - -
- - - Type: - - - unsignedLong - - -

- -
- - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Network_Media_Transcode_Job/index.html b/reference/datatypes/SoftLayer_Network_Media_Transcode_Job/index.html deleted file mode 100644 index 4aa24490778..00000000000 --- a/reference/datatypes/SoftLayer_Network_Media_Transcode_Job/index.html +++ /dev/null @@ -1,835 +0,0 @@ - - - - - - - - - - - - SoftLayer_Network_Media_Transcode_Job - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_Media_Transcode_Job

-
-
-
-
-
- Classes - - SoftLayer_Network_Media_Transcode_Job - -
- Tags - - datatype - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Network_Media_Transcode_Job

- -
- -
- - -

Description

- - The SoftLayer_Network_Media_Transcode_Job contains information regarding a transcode job such as input file, output format, user id and so on. - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

autoDeleteDuration

-

- - The auto-deletion duration in seconds. This value determines how long the input file will be kept on the storage. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

byteIn

-

- - The size of an input file in byte - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

createDate

-

- - The created date - -
- - - Type: - - - dateTime - - -

- -
- - - - - - - - - -
-
-

id

-

- - The internal identifier of a transcode job - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

inputFile

-

- - The input file name - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

modifyDate

-

- - The last modified date - -
- - - Type: - - - dateTime - - -

- -
- - - - - -
-
-

name

-

- - The name of a transcode job - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

outputFile

-

- - The output file name - -
- - - Type: - - - string - - -

- -
- - - - - - - -
-
-

transcodeAccountId

-

- - The internal identifier of SoftLayer account - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

transcodeJobGuid

-

- - The unique id of a transcode job - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

transcodePresetGuid

-

- - The unique id of a pre-defined output format - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

transcodePresetName

-

- - The name of a transcode output preset - -
- - - Type: - - - string - - -

- -
- - - - - - - -
-
-

transcodeStatusId

-

- - The internal identifier of a transcode status - -
- - - Type: - - - int - - -

- -
- - - - - - - - - -
-
-

userId

-

- - The internal identifier of the user who created a transcode job - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

watermark

-

- - Watermark to apply to job - -
- - - Type: - - - SoftLayer_Container_Network_Media_Transcode_Job_Watermark - - -

- -
- - -
-
-

Relational

- - - - - - - - - - -
-
-

history

-

- - None - -
- - - - - Type: - - - SoftLayer_Network_Media_Transcode_Job_History[] - - -

- -
- - - - - - - - - - - - - - - - - -
-
-

transcodeAccount

-

- - The transcode service account - -
- - - Type: - - - SoftLayer_Network_Media_Transcode_Account - - -

- -
- - - - - - - - - - - - - -
-
-

transcodeStatus

-

- - The status information of a transcode job - -
- - - Type: - - - SoftLayer_Network_Media_Transcode_Job_Status - - -

- -
- - - - - - - -
-
-

transcodeStatusName

-

- - The status of a transcode job - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

user

-

- - The SoftLayer user that created the transcode job - -
- - - Type: - - - SoftLayer_User_Customer - - -

- -
- - - - - - - - -

Count

- - - - - - - - - - - - -
-
-

historyCount

-

- - A count of - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Network_Media_Transcode_Job_History/index.html b/reference/datatypes/SoftLayer_Network_Media_Transcode_Job_History/index.html deleted file mode 100644 index 3c6e46d2c3c..00000000000 --- a/reference/datatypes/SoftLayer_Network_Media_Transcode_Job_History/index.html +++ /dev/null @@ -1,356 +0,0 @@ - - - - - - - - - - - - SoftLayer_Network_Media_Transcode_Job_History - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_Media_Transcode_Job_History

-
-
-
-
-
- Classes - - SoftLayer_Network_Media_Transcode_Job_History - -
- Tags - - datatype - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Network_Media_Transcode_Job_History

- -
- -
- - -

Description

- - - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

createDate

-

- - The creation date - -
- - - Type: - - - dateTime - - -

- -
- - - - - -
-
-

publicNotes

-

- - The note created by system - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

transcodeJobId

-

- - The internal identifier of a transcode job - -
- - - Type: - - - int - - -

- -
- - - - -
-
-

Relational

- - - - - - - - - - -
-
-

transcodeStatusName

-

- - The status of a transcode job - -
- - - Type: - - - string - - -

- -
- - - - -

Count

- - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Network_Media_Transcode_Job_Status/index.html b/reference/datatypes/SoftLayer_Network_Media_Transcode_Job_Status/index.html deleted file mode 100644 index 160e93d1f35..00000000000 --- a/reference/datatypes/SoftLayer_Network_Media_Transcode_Job_Status/index.html +++ /dev/null @@ -1,329 +0,0 @@ - - - - - - - - - - - - SoftLayer_Network_Media_Transcode_Job_Status - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_Media_Transcode_Job_Status

-
-
-
-
-
- Classes - - SoftLayer_Network_Media_Transcode_Job_Status - -
- Tags - - datatype - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Network_Media_Transcode_Job_Status

- -
- -
- - -

Description

- - The SoftLayer_Network_Media_Transcode_Job_Status contains information on a transcode job status. - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

description

-

- - The description of a transcode job status - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

id

-

- - The internal identifier of a transcode job status - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

name

-

- - The status name - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - - - - - - -

Count

- - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Network_Service_Health/index.html b/reference/datatypes/SoftLayer_Network_Service_Health/index.html deleted file mode 100644 index db308fbaff3..00000000000 --- a/reference/datatypes/SoftLayer_Network_Service_Health/index.html +++ /dev/null @@ -1,470 +0,0 @@ - - - - - - - - - - - - SoftLayer_Network_Service_Health - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_Service_Health

-
-
-
-
-
- Classes - - SoftLayer_Network_Service_Health - -
- Tags - - datatype - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Network_Service_Health

- -
- -
- - -

Description

- -
Deprecated
- - Many general services that SoftLayer provides are tracked on the customer portal with a quick status message. These status message provide users with a quick reference to the health of a service, whether it’s up or down. These services include SoftLayer’s Internet backbone connections, VPN entry points, and router networks. The SoftLayer_Network_Service_Health data type provides the relationship between these services and their health status. - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

createDate

-

- - The date that a service’s status was created. - -
- - - Type: - - - dateTime - - -

- -
- - - - - - - -
-
-

locationId

-

- - A service’s location identifier. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

modifyDate

-

- - The date that a service’s status was last changed. - -
- - - Type: - - - dateTime - - -

- -
- - - - - - - -
-
-

statusId

-

- - A service’s status identifier. - -
- - - Type: - - - int - - -

- -
- - -
-
-

Relational

- - - - - - - - -
-
-

location

-

- - A service’s location. - -
- - - Type: - - - SoftLayer_Location - - -

- -

Deprecated

- -
- - - - - - - - - - - -
-
-

status

-

- - The status portion of a service/status relationship. - -
- - - Type: - - - SoftLayer_Network_Service_Health_Status - - -

- -

Deprecated

- -
- - - - - - -

Count

- - - - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Network_Service_Health_Status/index.html b/reference/datatypes/SoftLayer_Network_Service_Health_Status/index.html deleted file mode 100644 index 63a628f2c70..00000000000 --- a/reference/datatypes/SoftLayer_Network_Service_Health_Status/index.html +++ /dev/null @@ -1,322 +0,0 @@ - - - - - - - - - - - - SoftLayer_Network_Service_Health_Status - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_Service_Health_Status

-
-
-
-
-
- Classes - - SoftLayer_Network_Service_Health_Status - -
- Tags - - datatype - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Network_Service_Health_Status

- -
- -
- - -

Description

- -
Deprecated
- - Many general services that SoftLayer provides are marked by a status message. These health messages give portal users a quick way of determining the state of a SoftLayer service. Services range from backbones to VPN endpoints and routers. Generally a health status is either “Up” or “Down”. - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

name

-

- - The status of a SoftLayer service. This is typically “Up” or “Down”. - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - - -

Count

- - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/index.html b/reference/datatypes/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/index.html deleted file mode 100644 index 25ea4e0fa2a..00000000000 --- a/reference/datatypes/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/index.html +++ /dev/null @@ -1,436 +0,0 @@ - - - - - - - - - - - - SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref

- -
- -
- - -

Description

- - - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - - - -
-
-

countryId

-

- - None - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

id

-

- - None - -
- - - Type: - - - int - - -

- -
- - - - - - - -
-
-

locationGroupId

-

- - None - -
- - - Type: - - - int - - -

- -
- - -
-
-

Relational

- - - - -
-
-

country

-

- - SoftLayer_Locale_Country Id. - -
- - - Type: - - - SoftLayer_Locale_Country - - -

- -
- - - - - - - - - -
-
-

locationGroup

-

- - Location Group ID of CleverSafe cross region. - -
- - - Type: - - - SoftLayer_Location_Group - - -

- -
- - - - - - -

Count

- - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Network_Storage_MassDataMigration_Request/index.html b/reference/datatypes/SoftLayer_Network_Storage_MassDataMigration_Request/index.html deleted file mode 100644 index bfdacaa41ea..00000000000 --- a/reference/datatypes/SoftLayer_Network_Storage_MassDataMigration_Request/index.html +++ /dev/null @@ -1,1088 +0,0 @@ - - - - - - - - - - - - SoftLayer_Network_Storage_MassDataMigration_Request - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_Storage_MassDataMigration_Request

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Network_Storage_MassDataMigration_Request

- -
- -
- - -

Description

- - The SoftLayer_Network_Storage_MassDataMigration_Request data type contains information on a single Mass Data Migration request. Creation of these requests is limited to SoftLayer customers through the SoftLayer Customer Portal. - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - - - -
-
-

accountId

-

- - The account id of the request. - -
- - - Type: - - - int - - -

- -
- - - - - - - - - - - -
-
-

addressId

-

- - The address id of address assigned to this request. - -
- - - Type: - - - int - - -

- -
- - - - - - - - - - - -
-
-

createUserId

-

- - The create user id of the request. - -
- - - Type: - - - int - - -

- -
- - - - - - - - - -
-
-

endDate

-

- - The end date of the request. - -
- - - Type: - - - dateTime - - -

- -
- - - - - -
-
-

id

-

- - The unique id of the request. - -
- - - Type: - - - int - - -

- -
- - - - - - - - - - - - - -
-
-

modifyUserId

-

- - The modify user id of the request. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

name

-

- - The unique id of the request. - -
- - - Type: - - - string - - -

- -
- - - - - - - - - -
-
-

startDate

-

- - The start date of the request. - -
- - - Type: - - - dateTime - - -

- -
- - - - - - - -
-
-

statusId

-

- - The status id of the request. - -
- - - Type: - - - int - - -

- -
- - - - - - - - -
-
-

Relational

- - - - -
-
-

account

-

- - The account to which the request belongs. - -
- - - Type: - - - SoftLayer_Account - - -

- -
- - - - - - - - - -
-
-

activeTickets

-

- - The active tickets that are attached to the MDMS request. - -
- - - - - Type: - - - SoftLayer_Ticket[] - - -

- -
- - - - - -
-
-

address

-

- - The customer address where the device is shipped to. - -
- - - Type: - - - SoftLayer_Account_Address - - -

- -
- - - - - - - -
-
-

billingItem

-

- - An associated parent billing item which is active. Includes billing items which are scheduled to be cancelled in the future. - -
- - - Type: - - - SoftLayer_Billing_Item - - -

- -
- - - - - -
-
-

createEmployee

-

- - The employee user who created the request. - -
- - - Type: - - - SoftLayer_User_Employee - - -

- -
- - - - - -
-
-

createUser

-

- - The customer user who created the request. - -
- - - Type: - - - SoftLayer_User_Customer - - -

- -
- - - - - - - -
-
-

deviceConfiguration

-

- - The device configurations. - -
- - - Type: - - - SoftLayer_Network_Storage_MassDataMigration_Request_DeviceConfiguration - - -

- -
- - - - - -
-
-

deviceModel

-

- - The model of device assigned to this request. - -
- - - Type: - - - string - - -

- -
- - - - - - - - - - - -
-
-

keyContacts

-

- - The key contacts for this requests. - -
- - - - - Type: - - - SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact[] - - -

- -
- - - - - -
-
-

modifyEmployee

-

- - The employee who last modified the request. - -
- - - Type: - - - SoftLayer_User_Employee - - -

- -
- - - - - -
-
-

modifyUser

-

- - The customer user who last modified the request. - -
- - - Type: - - - SoftLayer_User_Customer - - -

- -
- - - - - - - - - - - -
-
-

shipments

-

- - The shipments of the request. - -
- - - - - Type: - - - SoftLayer_Account_Shipment[] - - -

- -
- - - - - - - -
-
-

status

-

- - The status of the request. - -
- - - Type: - - - SoftLayer_Network_Storage_MassDataMigration_Request_Status - - -

- -
- - - - - - - -
-
-

ticket

-

- - Ticket that is attached to this mass data migration request. - -
- - - Type: - - - SoftLayer_Ticket - - -

- -
- - - - - - - -
-
-

tickets

-

- - All tickets that are attached to the mass data migration request. - -
- - - - - Type: - - - SoftLayer_Ticket[] - - -

- -
- - - - -

Count

- - - - - - - - -
-
-

activeTicketCount

-

- - A count of the active tickets that are attached to the MDMS request. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-

keyContactCount

-

- - A count of the key contacts for this requests. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - - - - - -
-
-

shipmentCount

-

- - A count of the shipments of the request. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - - - - - -
-
-

ticketCount

-

- - A count of all tickets that are attached to the mass data migration request. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Network_Storage_MassDataMigration_Request_DeviceConfiguration/index.html b/reference/datatypes/SoftLayer_Network_Storage_MassDataMigration_Request_DeviceConfiguration/index.html deleted file mode 100644 index 70ecb6b1735..00000000000 --- a/reference/datatypes/SoftLayer_Network_Storage_MassDataMigration_Request_DeviceConfiguration/index.html +++ /dev/null @@ -1,771 +0,0 @@ - - - - - - - - - - - - SoftLayer_Network_Storage_MassDataMigration_Request_DeviceConfiguration - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_Storage_MassDataMigration_Request_DeviceConfiguration

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Network_Storage_MassDataMigration_Request_DeviceConfiguration

- -
- -
- - -

Description

- - The SoftLayer_Network_Storage_MassDataMigration_Request_DeviceConfiguration data type contains settings such networking, COS account, which needs to be configured on device for a Mass Data Migration Request. - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

cosAccountId

-

- - The account id. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

cosBucket

-

- - The Cloud Object Storage bucket. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

eth1Gateway

-

- - The eth1 gateway for connecting to private network in datacenter. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

eth1IpAddress

-

- - The eth1 IP address for connecting to private network in datacenter. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

eth1Netmask

-

- - The eth1 netmask for connecting to private network in datacenter. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

eth3Gateway

-

- - The eth3 gateway for connecting to private network at customer’s location. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

eth3IpAddress

-

- - The eth3 IP address for connecting to private network at customer location. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

eth3Netmask

-

- - The eth3 netmask for connecting to private network in at customer’s location. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

id

-

- - The unique id of the request status. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

password

-

- - The password for configuring network share. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

poolLockPassword

-

- - The pool lock password for configuring network share. - -
- - - Type: - - - string - - -

- -
- - - - - - - -
-
-

requestId

-

- - The request id. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

s3Url

-

- - The Cloud Object Storage bucket URL. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

shareName

-

- - The name of network share. - -
- - - Type: - - - string - - -

- -
- - - - - - - -
-
-

username

-

- - The username for configuring network share. - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-

request

-

- - The request this device configurations belongs to. - -
- - - Type: - - - SoftLayer_Network_Storage_MassDataMigration_Request - - -

- -
- - - - - - - - - - - -
-
-

storageAccount

-

- - The storage account to use for this request. - -
- - - Type: - - - SoftLayer_Network_Storage_Hub_Cleversafe_Account - - -

- -
- - - - - - -

Count

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact/index.html b/reference/datatypes/SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact/index.html deleted file mode 100644 index 8deced518e7..00000000000 --- a/reference/datatypes/SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact/index.html +++ /dev/null @@ -1,576 +0,0 @@ - - - - - - - - - - - - SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact

- -
- -
- - -

Description

- - The SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact data type contains name, email, and phone for key contact at customer location who will handle Mass Data Migration. - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - - - -
-
-

accountId

-

- - An account number that is linked to a KeyContact. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

createDate

-

- - The date a KeyContact was created. - -
- - - Type: - - - dateTime - - -

- -
- - - - - -
-
-

email

-

- - KeyContact’s Email Id. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

id

-

- - The unique id of the key contact. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

modifyDate

-

- - The date a KeyContact was last modified. - -
- - - Type: - - - dateTime - - -

- -
- - - - - -
-
-

name

-

- - KeyContact’s Name. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

phone

-

- - A phone number assigned to a KeyContact. - -
- - - Type: - - - string - - -

- -
- - - - - - - -
-
-

requestId

-

- - A request id that is linked to a KeyContact. - -
- - - Type: - - - int - - -

- -
- - -
-
-

Relational

- - - - -
-
-

account

-

- - The request this key contact belongs to. - -
- - - Type: - - - SoftLayer_Account - - -

- -
- - - - - - - - - - - - - - - - - - - -
-
-

request

-

- - The request this key contact belongs to. - -
- - - Type: - - - SoftLayer_Network_Storage_MassDataMigration_Request - - -

- -
- - - - - - -

Count

- - - - - - - - - - - - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Network_Storage_MassDataMigration_Request_Status/index.html b/reference/datatypes/SoftLayer_Network_Storage_MassDataMigration_Request_Status/index.html deleted file mode 100644 index 0b41e541b39..00000000000 --- a/reference/datatypes/SoftLayer_Network_Storage_MassDataMigration_Request_Status/index.html +++ /dev/null @@ -1,408 +0,0 @@ - - - - - - - - - - - - SoftLayer_Network_Storage_MassDataMigration_Request_Status - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_Storage_MassDataMigration_Request_Status

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Network_Storage_MassDataMigration_Request_Status

- -
- -
- - -

Description

- - The SoftLayer_Network_Storage_MassDataMigration_Request_Status data type contains general information relating to the statuses to which a Mass Data Migration Request may be set. - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

description

-

- - The description of the request status. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

id

-

- - The unique id of the request status. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

keyName

-

- - The unique keyname of the request status. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

name

-

- - The name of the request status. - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - - - - - - - - -

Count

- - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Network_Subnet_Registration/index.html b/reference/datatypes/SoftLayer_Network_Subnet_Registration/index.html deleted file mode 100644 index 810cf08177e..00000000000 --- a/reference/datatypes/SoftLayer_Network_Subnet_Registration/index.html +++ /dev/null @@ -1,928 +0,0 @@ - - - - - - - - - - - - SoftLayer_Network_Subnet_Registration - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_Subnet_Registration

-
-
-
-
-
- Classes - - SoftLayer_Network_Subnet_Registration - -
- Tags - - datatype - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Network_Subnet_Registration

- -
- -
- - -

Description

- -
Deprecated
- -

The subnet registration service has been deprecated.

-

The subnet registration data type contains general information relating to a single subnet registration instance. These registration instances can be updated to reflect changes, and will record the changes in the SoftLayer_Network_Subnet_Registration_Event.

- - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - - - -
-
-

accountId

-

- - The registration object’s associated SoftLayer_Account id - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

cidr

-

- - The CIDR prefix for the registered subnet - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

createDate

-

- - None - -
- - - Type: - - - dateTime - - -

- -
- - - - - - - - - - - - - -
-
-

id

-

- - Unique ID of the registration object - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

modifyDate

-

- - None - -
- - - Type: - - - dateTime - - -

- -
- - - - - - - -
-
-

networkHandle

-

- - The RIR-specific handle or name of the registered subnet. This field is read-only. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

networkIdentifier

-

- - The base IP address of the registered subnet - -
- - - Type: - - - string - - -

- -
- - - - - - - - - - - -
-
-

regionalInternetRegistryHandleId

-

- - The registration object’s associated SoftLayer_Account_Rwhois_Handle id - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

regionalInternetRegistryId

-

- - The registration object’s associated SoftLayer_Network_Regional_Internet_Registry id - -
- - - Type: - - - int - - -

- -
- - - - - - - -
-
-

statusId

-

- - The registration object’s associated SoftLayer_Network_Subnet_Registration_Status id - -
- - - Type: - - - int - - -

- -
- - - - -
-
-

Relational

- - - - - - -
-
-

account

-

- - [Deprecated] The account that this registration belongs to. - -
- - - Type: - - - SoftLayer_Account - - -

- -

Deprecated

- -
- - - - - - - - - - - - - - - -
-
-

detailReferences

-

- - [Deprecated] The cross-reference records that tie the SoftLayer_Account_Regional_Registry_Detail objects to the registration object. - -
- - - - - Type: - - - SoftLayer_Network_Subnet_Registration_Details[] - - -

- -

Deprecated

- -
- - - - - - - - - -
-
-

events

-

- - [Deprecated] The related registration events. - -
- - - - - Type: - - - SoftLayer_Network_Subnet_Registration_Event[] - - -

- -

Deprecated

- -
- - - - - - - - - - - -
-
-

networkDetail

-

- - [Deprecated] The “network” detail object. - -
- - - Type: - - - SoftLayer_Account_Regional_Registry_Detail - - -

- -

Deprecated

- -
- - - - - - - - - - - -
-
-

personDetail

-

- - [Deprecated] The “person” detail object. - -
- - - Type: - - - SoftLayer_Account_Regional_Registry_Detail - - -

- -

Deprecated

- -
- - - - - - - -
-
-

regionalInternetRegistry

-

- - [Deprecated] The related Regional Internet Registry. - -
- - - Type: - - - SoftLayer_Network_Regional_Internet_Registry - - -

- -

Deprecated

- -
- - - - - - - -
-
-

regionalInternetRegistryHandle

-

- - [Deprecated] The RIR handle that this registration object belongs to. This field may not be populated until the registration is complete. - -
- - - Type: - - - SoftLayer_Account_Rwhois_Handle - - -

- -

Deprecated

- -
- - - - - - - - - - - -
-
-

status

-

- - [Deprecated] The status of this registration. - -
- - - Type: - - - SoftLayer_Network_Subnet_Registration_Status - - -

- -

Deprecated

- -
- - - - - - - - - -
-
-

subnet

-

- - [Deprecated] The subnet that this registration pertains to. - -
- - - Type: - - - SoftLayer_Network_Subnet - - -

- -

Deprecated

- -
- - - - -

Count

- - - - - - - - - - - - -
-
-

detailReferenceCount

-

- - A count of [Deprecated] The cross-reference records that tie the SoftLayer_Account_Regional_Registry_Detail objects to the registration object. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - -
-
-

eventCount

-

- - A count of [Deprecated] The related registration events. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Network_Subnet_Registration_Apnic/index.html b/reference/datatypes/SoftLayer_Network_Subnet_Registration_Apnic/index.html deleted file mode 100644 index 7d57a0daa52..00000000000 --- a/reference/datatypes/SoftLayer_Network_Subnet_Registration_Apnic/index.html +++ /dev/null @@ -1,927 +0,0 @@ - - - - - - - - - - - - SoftLayer_Network_Subnet_Registration_Apnic - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_Subnet_Registration_Apnic

-
-
-
-
-
- Classes - - SoftLayer_Network_Subnet_Registration_Apnic - -
- Tags - - datatype - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Network_Subnet_Registration_Apnic

- -
- -
- - -

Description

- -
Deprecated
- -

The APNIC subnet registration type has been deprecated.

-

APNIC-specific registration object. For more detail see SoftLayer_Network_Subnet_Registration.

- - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - - - -
-
-

accountId

-

- - The registration object’s associated SoftLayer_Account id - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

cidr

-

- - The CIDR prefix for the registered subnet - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

createDate

-

- - None - -
- - - Type: - - - dateTime - - -

- -
- - - - - - - - - - - - - -
-
-

id

-

- - Unique ID of the registration object - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

modifyDate

-

- - None - -
- - - Type: - - - dateTime - - -

- -
- - - - - - - -
-
-

networkHandle

-

- - The RIR-specific handle or name of the registered subnet. This field is read-only. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

networkIdentifier

-

- - The base IP address of the registered subnet - -
- - - Type: - - - string - - -

- -
- - - - - - - - - - - -
-
-

regionalInternetRegistryHandleId

-

- - The registration object’s associated SoftLayer_Account_Rwhois_Handle id - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

regionalInternetRegistryId

-

- - The registration object’s associated SoftLayer_Network_Regional_Internet_Registry id - -
- - - Type: - - - int - - -

- -
- - - - - - - -
-
-

statusId

-

- - The registration object’s associated SoftLayer_Network_Subnet_Registration_Status id - -
- - - Type: - - - int - - -

- -
- - - - -
-
-

Relational

- - - - - - -
-
-

account

-

- - [Deprecated] The account that this registration belongs to. - -
- - - Type: - - - SoftLayer_Account - - -

- -

Deprecated

- -
- - - - - - - - - - - - - - - -
-
-

detailReferences

-

- - [Deprecated] The cross-reference records that tie the SoftLayer_Account_Regional_Registry_Detail objects to the registration object. - -
- - - - - Type: - - - SoftLayer_Network_Subnet_Registration_Details[] - - -

- -

Deprecated

- -
- - - - - - - - - -
-
-

events

-

- - [Deprecated] The related registration events. - -
- - - - - Type: - - - SoftLayer_Network_Subnet_Registration_Event[] - - -

- -

Deprecated

- -
- - - - - - - - - - - -
-
-

networkDetail

-

- - [Deprecated] The “network” detail object. - -
- - - Type: - - - SoftLayer_Account_Regional_Registry_Detail - - -

- -

Deprecated

- -
- - - - - - - - - - - -
-
-

personDetail

-

- - [Deprecated] The “person” detail object. - -
- - - Type: - - - SoftLayer_Account_Regional_Registry_Detail - - -

- -

Deprecated

- -
- - - - - - - -
-
-

regionalInternetRegistry

-

- - [Deprecated] The related Regional Internet Registry. - -
- - - Type: - - - SoftLayer_Network_Regional_Internet_Registry - - -

- -

Deprecated

- -
- - - - - - - -
-
-

regionalInternetRegistryHandle

-

- - [Deprecated] The RIR handle that this registration object belongs to. This field may not be populated until the registration is complete. - -
- - - Type: - - - SoftLayer_Account_Rwhois_Handle - - -

- -

Deprecated

- -
- - - - - - - - - - - -
-
-

status

-

- - [Deprecated] The status of this registration. - -
- - - Type: - - - SoftLayer_Network_Subnet_Registration_Status - - -

- -

Deprecated

- -
- - - - - - - - - -
-
-

subnet

-

- - [Deprecated] The subnet that this registration pertains to. - -
- - - Type: - - - SoftLayer_Network_Subnet - - -

- -

Deprecated

- -
- - - - -

Count

- - - - - - - - - - - - -
-
-

detailReferenceCount

-

- - A count of [Deprecated] The cross-reference records that tie the SoftLayer_Account_Regional_Registry_Detail objects to the registration object. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - -
-
-

eventCount

-

- - A count of [Deprecated] The related registration events. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Network_Subnet_Registration_Arin/index.html b/reference/datatypes/SoftLayer_Network_Subnet_Registration_Arin/index.html deleted file mode 100644 index c53d0eccd9f..00000000000 --- a/reference/datatypes/SoftLayer_Network_Subnet_Registration_Arin/index.html +++ /dev/null @@ -1,927 +0,0 @@ - - - - - - - - - - - - SoftLayer_Network_Subnet_Registration_Arin - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_Subnet_Registration_Arin

-
-
-
-
-
- Classes - - SoftLayer_Network_Subnet_Registration_Arin - -
- Tags - - datatype - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Network_Subnet_Registration_Arin

- -
- -
- - -

Description

- -
Deprecated
- -

The ARIN subnet registration type has been deprecated.

-

ARIN-specific registration object. For more detail see SoftLayer_Network_Subnet_Registration.

- - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - - - -
-
-

accountId

-

- - The registration object’s associated SoftLayer_Account id - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

cidr

-

- - The CIDR prefix for the registered subnet - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

createDate

-

- - None - -
- - - Type: - - - dateTime - - -

- -
- - - - - - - - - - - - - -
-
-

id

-

- - Unique ID of the registration object - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

modifyDate

-

- - None - -
- - - Type: - - - dateTime - - -

- -
- - - - - - - -
-
-

networkHandle

-

- - The RIR-specific handle or name of the registered subnet. This field is read-only. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

networkIdentifier

-

- - The base IP address of the registered subnet - -
- - - Type: - - - string - - -

- -
- - - - - - - - - - - -
-
-

regionalInternetRegistryHandleId

-

- - The registration object’s associated SoftLayer_Account_Rwhois_Handle id - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

regionalInternetRegistryId

-

- - The registration object’s associated SoftLayer_Network_Regional_Internet_Registry id - -
- - - Type: - - - int - - -

- -
- - - - - - - -
-
-

statusId

-

- - The registration object’s associated SoftLayer_Network_Subnet_Registration_Status id - -
- - - Type: - - - int - - -

- -
- - - - -
-
-

Relational

- - - - - - -
-
-

account

-

- - [Deprecated] The account that this registration belongs to. - -
- - - Type: - - - SoftLayer_Account - - -

- -

Deprecated

- -
- - - - - - - - - - - - - - - -
-
-

detailReferences

-

- - [Deprecated] The cross-reference records that tie the SoftLayer_Account_Regional_Registry_Detail objects to the registration object. - -
- - - - - Type: - - - SoftLayer_Network_Subnet_Registration_Details[] - - -

- -

Deprecated

- -
- - - - - - - - - -
-
-

events

-

- - [Deprecated] The related registration events. - -
- - - - - Type: - - - SoftLayer_Network_Subnet_Registration_Event[] - - -

- -

Deprecated

- -
- - - - - - - - - - - -
-
-

networkDetail

-

- - [Deprecated] The “network” detail object. - -
- - - Type: - - - SoftLayer_Account_Regional_Registry_Detail - - -

- -

Deprecated

- -
- - - - - - - - - - - -
-
-

personDetail

-

- - [Deprecated] The “person” detail object. - -
- - - Type: - - - SoftLayer_Account_Regional_Registry_Detail - - -

- -

Deprecated

- -
- - - - - - - -
-
-

regionalInternetRegistry

-

- - [Deprecated] The related Regional Internet Registry. - -
- - - Type: - - - SoftLayer_Network_Regional_Internet_Registry - - -

- -

Deprecated

- -
- - - - - - - -
-
-

regionalInternetRegistryHandle

-

- - [Deprecated] The RIR handle that this registration object belongs to. This field may not be populated until the registration is complete. - -
- - - Type: - - - SoftLayer_Account_Rwhois_Handle - - -

- -

Deprecated

- -
- - - - - - - - - - - -
-
-

status

-

- - [Deprecated] The status of this registration. - -
- - - Type: - - - SoftLayer_Network_Subnet_Registration_Status - - -

- -

Deprecated

- -
- - - - - - - - - -
-
-

subnet

-

- - [Deprecated] The subnet that this registration pertains to. - -
- - - Type: - - - SoftLayer_Network_Subnet - - -

- -

Deprecated

- -
- - - - -

Count

- - - - - - - - - - - - -
-
-

detailReferenceCount

-

- - A count of [Deprecated] The cross-reference records that tie the SoftLayer_Account_Regional_Registry_Detail objects to the registration object. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - -
-
-

eventCount

-

- - A count of [Deprecated] The related registration events. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Network_Subnet_Registration_Details/index.html b/reference/datatypes/SoftLayer_Network_Subnet_Registration_Details/index.html deleted file mode 100644 index be47849d58c..00000000000 --- a/reference/datatypes/SoftLayer_Network_Subnet_Registration_Details/index.html +++ /dev/null @@ -1,504 +0,0 @@ - - - - - - - - - - - - SoftLayer_Network_Subnet_Registration_Details - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_Subnet_Registration_Details

-
-
-
-
-
- Classes - - SoftLayer_Network_Subnet_Registration_Details - -
- Tags - - datatype - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Network_Subnet_Registration_Details

- -
- -
- - -

Description

- -
Deprecated
- -

The subnet registration details type has been deprecated.

-

The SoftLayer_Network_Subnet_Registration_Details objects are used to relate SoftLayer_Account_Regional_Registry_Detail objects to a SoftLayer_Network_Subnet_Registration object. This allows for easy reuse of registration details. It is important to note that only one detail object per type may be associated to a registration object.

- - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

createDate

-

- - None - -
- - - Type: - - - dateTime - - -

- -
- - - - - - - -
-
-

detailId

-

- - Numeric ID of the related SoftLayer_Account_Regional_Registry_Detail object - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

id

-

- - Unique numeric ID of the object - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

modifyDate

-

- - None - -
- - - Type: - - - dateTime - - -

- -
- - - - - - - -
-
-

registrationId

-

- - Numeric ID of the related SoftLayer_Network_Subnet_Registration object - -
- - - Type: - - - int - - -

- -
- - -
-
-

Relational

- - - - - - - - -
-
-

detail

-

- - [Deprecated] The related SoftLayer_Account_Regional_Registry_Detail. - -
- - - Type: - - - SoftLayer_Account_Regional_Registry_Detail - - -

- -

Deprecated

- -
- - - - - - - - - - - - - -
-
-

registration

-

- - [Deprecated] The related SoftLayer_Network_Subnet_Registration. - -
- - - Type: - - - SoftLayer_Network_Subnet_Registration - - -

- -

Deprecated

- -
- - - - - - -

Count

- - - - - - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Network_Subnet_Registration_Event/index.html b/reference/datatypes/SoftLayer_Network_Subnet_Registration_Event/index.html deleted file mode 100644 index ce6371938a6..00000000000 --- a/reference/datatypes/SoftLayer_Network_Subnet_Registration_Event/index.html +++ /dev/null @@ -1,531 +0,0 @@ - - - - - - - - - - - - SoftLayer_Network_Subnet_Registration_Event - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_Subnet_Registration_Event

-
-
-
-
-
- Classes - - SoftLayer_Network_Subnet_Registration_Event - -
- Tags - - datatype - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Network_Subnet_Registration_Event

- -
- -
- - -

Description

- -
Deprecated
- -

The subnet registration event type has been deprecated.

-

Each time a SoftLayer_Network_Subnet_Registration object is created or modified, the system will generate an event for it. Additional actions that would create an event include RIR responses and error cases. *

- - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

createDate

-

- - None - -
- - - Type: - - - dateTime - - -

- -
- - - - - -
-
-

id

-

- - Unique numeric ID of the event object - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

message

-

- - A string message indicating what took place during this event - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

modifyDate

-

- - None - -
- - - Type: - - - dateTime - - -

- -
- - - - - - - -
-
-

registrationId

-

- - The numeric ID of the related SoftLayer_Network_Subnet_Registration object - -
- - - Type: - - - int - - -

- -
- - - - - - - -
-
-

typeId

-

- - The numeric ID of the associated SoftLayer_Network_Subnet_Registration_Event_Type object - -
- - - Type: - - - int - - -

- -
- - -
-
-

Relational

- - - - - - - - - - - - - - -
-
-

registration

-

- - [Deprecated] The registration this event pertains to. - -
- - - Type: - - - SoftLayer_Network_Subnet_Registration - - -

- -

Deprecated

- -
- - - - - - - - - -
-
-

type

-

- - [Deprecated] The type of this event. - -
- - - Type: - - - SoftLayer_Network_Subnet_Registration_Event_Type - - -

- -

Deprecated

- -
- - - - - - -

Count

- - - - - - - - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Network_Subnet_Registration_Event_Type/index.html b/reference/datatypes/SoftLayer_Network_Subnet_Registration_Event_Type/index.html deleted file mode 100644 index 0199e541735..00000000000 --- a/reference/datatypes/SoftLayer_Network_Subnet_Registration_Event_Type/index.html +++ /dev/null @@ -1,448 +0,0 @@ - - - - - - - - - - - - SoftLayer_Network_Subnet_Registration_Event_Type - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_Subnet_Registration_Event_Type

-
-
-
-
-
- Classes - - SoftLayer_Network_Subnet_Registration_Event_Type - -
- Tags - - datatype - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Network_Subnet_Registration_Event_Type

- -
- -
- - -

Description

- -
Deprecated
- -

The subnet registration event type type has been deprecated.

-

Subnet Registration Event Type objects describe the nature of a SoftLayer_Network_Subnet_Registration_Event

-

The standard values for these objects are as follows:

  • REGISTRATION_CREATED - Indicates that the registration has been created
  • REGISTRATION_UPDATED - Indicates that the registration has been updated
  • REGISTRATION_CANCELLED - Indicates that the registration has been cancelled
  • RIR_RESPONSE - Indicates that an action taken against the RIR has produced a response. More details will be provided in the event message.
  • ERROR - Indicates that an error has been encountered. More details will be provided in the event message.
  • NOTE - An employee or other system has entered a note regarding the registration. The note content will be provided in the event message.

- - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - - - -
-
-

createDate

-

- - None - -
- - - Type: - - - dateTime - - -

- -

Deprecated

- -
- - - - - -
-
-

id

-

- - Unique numeric ID of the event type object - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

keyName

-

- - Code-friendly string name of the event type - -
- - - Type: - - - string - - -

- -
- - - - - - - -
-
-

modifyDate

-

- - None - -
- - - Type: - - - dateTime - - -

- -

Deprecated

- -
- - - - - -
-
-

name

-

- - Human-readable name of the event type - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - - - - - - - - - - -

Count

- - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Network_Subnet_Registration_Ripe/index.html b/reference/datatypes/SoftLayer_Network_Subnet_Registration_Ripe/index.html deleted file mode 100644 index 33a2fbd49bc..00000000000 --- a/reference/datatypes/SoftLayer_Network_Subnet_Registration_Ripe/index.html +++ /dev/null @@ -1,927 +0,0 @@ - - - - - - - - - - - - SoftLayer_Network_Subnet_Registration_Ripe - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_Subnet_Registration_Ripe

-
-
-
-
-
- Classes - - SoftLayer_Network_Subnet_Registration_Ripe - -
- Tags - - datatype - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Network_Subnet_Registration_Ripe

- -
- -
- - -

Description

- -
Deprecated
- -

The RIPE subnet registration type has been deprecated.

-

RIPE-specific registration object. For more detail see SoftLayer_Network_Subnet_Registration.

- - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - - - -
-
-

accountId

-

- - The registration object’s associated SoftLayer_Account id - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

cidr

-

- - The CIDR prefix for the registered subnet - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

createDate

-

- - None - -
- - - Type: - - - dateTime - - -

- -
- - - - - - - - - - - - - -
-
-

id

-

- - Unique ID of the registration object - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

modifyDate

-

- - None - -
- - - Type: - - - dateTime - - -

- -
- - - - - - - -
-
-

networkHandle

-

- - The RIR-specific handle or name of the registered subnet. This field is read-only. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

networkIdentifier

-

- - The base IP address of the registered subnet - -
- - - Type: - - - string - - -

- -
- - - - - - - - - - - -
-
-

regionalInternetRegistryHandleId

-

- - The registration object’s associated SoftLayer_Account_Rwhois_Handle id - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

regionalInternetRegistryId

-

- - The registration object’s associated SoftLayer_Network_Regional_Internet_Registry id - -
- - - Type: - - - int - - -

- -
- - - - - - - -
-
-

statusId

-

- - The registration object’s associated SoftLayer_Network_Subnet_Registration_Status id - -
- - - Type: - - - int - - -

- -
- - - - -
-
-

Relational

- - - - - - -
-
-

account

-

- - [Deprecated] The account that this registration belongs to. - -
- - - Type: - - - SoftLayer_Account - - -

- -

Deprecated

- -
- - - - - - - - - - - - - - - -
-
-

detailReferences

-

- - [Deprecated] The cross-reference records that tie the SoftLayer_Account_Regional_Registry_Detail objects to the registration object. - -
- - - - - Type: - - - SoftLayer_Network_Subnet_Registration_Details[] - - -

- -

Deprecated

- -
- - - - - - - - - -
-
-

events

-

- - [Deprecated] The related registration events. - -
- - - - - Type: - - - SoftLayer_Network_Subnet_Registration_Event[] - - -

- -

Deprecated

- -
- - - - - - - - - - - -
-
-

networkDetail

-

- - [Deprecated] The “network” detail object. - -
- - - Type: - - - SoftLayer_Account_Regional_Registry_Detail - - -

- -

Deprecated

- -
- - - - - - - - - - - -
-
-

personDetail

-

- - [Deprecated] The “person” detail object. - -
- - - Type: - - - SoftLayer_Account_Regional_Registry_Detail - - -

- -

Deprecated

- -
- - - - - - - -
-
-

regionalInternetRegistry

-

- - [Deprecated] The related Regional Internet Registry. - -
- - - Type: - - - SoftLayer_Network_Regional_Internet_Registry - - -

- -

Deprecated

- -
- - - - - - - -
-
-

regionalInternetRegistryHandle

-

- - [Deprecated] The RIR handle that this registration object belongs to. This field may not be populated until the registration is complete. - -
- - - Type: - - - SoftLayer_Account_Rwhois_Handle - - -

- -

Deprecated

- -
- - - - - - - - - - - -
-
-

status

-

- - [Deprecated] The status of this registration. - -
- - - Type: - - - SoftLayer_Network_Subnet_Registration_Status - - -

- -

Deprecated

- -
- - - - - - - - - -
-
-

subnet

-

- - [Deprecated] The subnet that this registration pertains to. - -
- - - Type: - - - SoftLayer_Network_Subnet - - -

- -

Deprecated

- -
- - - - -

Count

- - - - - - - - - - - - -
-
-

detailReferenceCount

-

- - A count of [Deprecated] The cross-reference records that tie the SoftLayer_Account_Regional_Registry_Detail objects to the registration object. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - -
-
-

eventCount

-

- - A count of [Deprecated] The related registration events. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Network_Subnet_Registration_Status/index.html b/reference/datatypes/SoftLayer_Network_Subnet_Registration_Status/index.html deleted file mode 100644 index d5bbb79cbe6..00000000000 --- a/reference/datatypes/SoftLayer_Network_Subnet_Registration_Status/index.html +++ /dev/null @@ -1,449 +0,0 @@ - - - - - - - - - - - - SoftLayer_Network_Subnet_Registration_Status - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_Subnet_Registration_Status

-
-
-
-
-
- Classes - - SoftLayer_Network_Subnet_Registration_Status - -
- Tags - - datatype - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Network_Subnet_Registration_Status

- -
- -
- - -

Description

- -
Deprecated
- -

The subnet registration status type has been deprecated.

-

Subnet Registration Status objects describe the current status of a subnet registration.

-

The standard values for these objects are as follows:

  • OPEN - Indicates that the registration object is new and has yet to be submitted to the RIR
  • PENDING - Indicates that the registration object has been submitted to the RIR and is awaiting response
  • COMPLETE - Indicates that the RIR action has completed
  • DELETED - Indicates that the registration object has been gracefully removed is no longer valid
  • CANCELLED - Indicates that the registration object has been abruptly removed is no longer valid

- - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - - - -
-
-

createDate

-

- - None - -
- - - Type: - - - dateTime - - -

- -

Deprecated

- -
- - - - - -
-
-

id

-

- - Unique numeric ID of the status object - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

keyName

-

- - Code-friendly string name of the status - -
- - - Type: - - - string - - -

- -
- - - - - - - -
-
-

modifyDate

-

- - None - -
- - - Type: - - - dateTime - - -

- -

Deprecated

- -
- - - - - -
-
-

name

-

- - Human-readable name of the status - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - - - - - - - - - - -

Count

- - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Network_Subnet_Rwhois_Data/index.html b/reference/datatypes/SoftLayer_Network_Subnet_Rwhois_Data/index.html deleted file mode 100644 index ae531638234..00000000000 --- a/reference/datatypes/SoftLayer_Network_Subnet_Rwhois_Data/index.html +++ /dev/null @@ -1,748 +0,0 @@ - - - - - - - - - - - - SoftLayer_Network_Subnet_Rwhois_Data - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_Subnet_Rwhois_Data

-
-
-
-
-
- Classes - - SoftLayer_Network_Subnet_Rwhois_Data - -
- Tags - - datatype - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Network_Subnet_Rwhois_Data

- -
- -
- - -

Description

- -
Deprecated
- -

Every SoftLayer customer account has contact information associated with it for reverse WHOIS purposes. An account’s RWHOIS data, modeled by the SoftLayer_Network_Subnet_Rwhois_Data data type, is used by SoftLayer’s reverse WHOIS server as well as for SWIP transactions. SoftLayer’s reverse WHOIS servers respond to WHOIS queries for IP addresses belonging to a customer’s servers, returning this RWHOIS data.

-

A SoftLayer customer’s RWHOIS data may not necessarily match their account or portal users’ contact information.

- - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

abuseEmail

-

- - An email address associated with an account’s RWHOIS data that is responsible for responding to network abuse queries about malicious traffic coming from your servers’ IP addresses. - -
- - - Type: - - - string - - -

- -
- - - - - - - -
-
-

accountId

-

- - An account’s RWHOIS data’s associated account identifier. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

address1

-

- - The first line of the mailing address associated with an account’s RWHOIS data. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

address2

-

- - The second line of the mailing address associated with an account’s RWHOIS data. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

city

-

- - The city of the mailing address associated with an account’s RWHOIS data. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

companyName

-

- - The company name associated with an account’s RWHOIS data. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

country

-

- - A two-letter abbreviation of the country of the mailing address associated with an account’s RWHOIS data. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

createDate

-

- - The date an account’s RWHOIS data was created. - -
- - - Type: - - - dateTime - - -

- -
- - - - - -
-
-

firstName

-

- - The first name associated with an account’s RWHOIS data. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

id

-

- - An account’s RWHOIS data’s internal identifier. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

lastName

-

- - The last name associated with an account’s RWHOIS data. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

modifyDate

-

- - The date an account’s RWHOIS data was last modified. - -
- - - Type: - - - dateTime - - -

- -
- - - - - -
-
-

postalCode

-

- - The postal code of the mailing address associated with an account’s RWHOIS data. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

privateResidenceFlag

-

- - Whether an account’s RWHOIS data refers to a private residence or not. - -
- - - Type: - - - boolean - - -

- -
- - - - - -
-
-

state

-

- - A two-letter abbreviation of the state of the mailing address associated with an account’s RWHOIS data. If an account does not reside in a province then this is typically blank. - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - - - -
-
-

account

-

- - The SoftLayer customer account associated with this reverse WHOIS data. - -
- - - Type: - - - SoftLayer_Account - - -

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Count

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Network_Subnet_Swip_Transaction/index.html b/reference/datatypes/SoftLayer_Network_Subnet_Swip_Transaction/index.html deleted file mode 100644 index 56ab118bce5..00000000000 --- a/reference/datatypes/SoftLayer_Network_Subnet_Swip_Transaction/index.html +++ /dev/null @@ -1,450 +0,0 @@ - - - - - - - - - - - - SoftLayer_Network_Subnet_Swip_Transaction - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_Subnet_Swip_Transaction

-
-
-
-
-
- Classes - - SoftLayer_Network_Subnet_Swip_Transaction - -
- Tags - - datatype - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Network_Subnet_Swip_Transaction

- -
- -
- - -

Description

- -
Deprecated
- -

DEPRECATED -The SoftLayer_Network_Subnet_Swip_Transaction data type contains basic information tracked at SoftLayer to allow automation of Swip creation, update, and removal requests. A specific transaction is attached to an accountId and a subnetId. This also contains a “Status Name” which tells the customer what the transaction is doing:

-
    -
  • REQUEST QUEUED: Request is queued up to be sent to ARIN
  • -
  • REQUEST SENT: The email request has been sent to ARIN
  • -
  • REQUEST CONFIRMED: ARIN has confirmed that the request is good, and should be available in 24 hours
  • -
  • OK: The subnet has been checked with WHOIS and it the SWIP transaction has completed correctly
  • -
  • REMOVE QUEUED: A subnet is queued to be removed from ARIN’s systems
  • -
  • REMOVE SENT: The removal email request has been sent to ARIN
  • -
  • REMOVE CONFIRMED: ARIN has confirmed that the removal request is good, and the subnet should be clear in WHOIS in 24 hours
  • -
  • DELETED: This specific SWIP Transaction has been removed from ARIN and is no longer in effect
  • -
  • SOFTLAYER MANUALLY PROCESSING: Sometimes a request doesn’t go through correctly and has to be manually processed by SoftLayer. This may take some time.
  • -
- -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - - - -
-
-

id

-

- - A SWIP transaction’s unique identifier. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

statusName

-

- - A Name describing which state a SWIP transaction is in. - -
- - - Type: - - - string - - -

- -
- - - - - - - -
-
-

subnetId

-

- - ID Number of the Subnet for this SWIP transaction. - -
- - - Type: - - - int - - -

- -
- - -
-
-

Relational

- - - - -
-
-

account

-

- - The Account whose RWHOIS data was used to SWIP this subnet - -
- - - Type: - - - SoftLayer_Account - - -

- -
- - - - - - - - - -
-
-

subnet

-

- - The subnet that this SWIP transaction was created for. - -
- - - Type: - - - SoftLayer_Network_Subnet - - -

- -
- - - - - - -

Count

- - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Ticket_Attachment_Network_Storage_Mass_Data_Migration/index.html b/reference/datatypes/SoftLayer_Ticket_Attachment_Network_Storage_Mass_Data_Migration/index.html deleted file mode 100644 index d270dcd96d3..00000000000 --- a/reference/datatypes/SoftLayer_Ticket_Attachment_Network_Storage_Mass_Data_Migration/index.html +++ /dev/null @@ -1,519 +0,0 @@ - - - - - - - - - - - - SoftLayer_Ticket_Attachment_Network_Storage_Mass_Data_Migration - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Ticket_Attachment_Network_Storage_Mass_Data_Migration

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Ticket_Attachment_Network_Storage_Mass_Data_Migration

- -
- -
- - -

Description

- - - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

attachmentId

-

- - The internal identifier of an item that is attached to a ticket. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

createDate

-

- - The date that an item was attached to a ticket. - -
- - - Type: - - - dateTime - - -

- -
- - - - - -
-
-

id

-

- - A ticket attachment’s internal identifier. - -
- - - Type: - - - int - - -

- -
- - - - - - - -
-
-

requestId

-

- - None - -
- - - Type: - - - int - - -

- -
- - - - - - - - - -
-
-

ticketId

-

- - The internal identifier of the ticket that an item is attached to. - -
- - - Type: - - - int - - -

- -
- - -
-
-

Relational

- - - - - - - - - - -
-
-

request

-

- - The Mass Data Migration request that is attached to a ticket. - -
- - - Type: - - - SoftLayer_Network_Storage_MassDataMigration_Request - - -

- -
- - - - - - - -
-
-

resource

-

- - The Mass Data Migration request that is attached to a ticket. - -
- - - Type: - - - SoftLayer_Network_Storage_MassDataMigration_Request - - -

- -
- - - - - -
-
-

ticket

-

- - The ticket that an item is attached to. - -
- - - Type: - - - SoftLayer_Ticket - - -

- -
- - - - - - -

Count

- - - - - - - - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Utility_Network/index.html b/reference/datatypes/SoftLayer_Utility_Network/index.html deleted file mode 100644 index e87b3fc4bfe..00000000000 --- a/reference/datatypes/SoftLayer_Utility_Network/index.html +++ /dev/null @@ -1,296 +0,0 @@ - - - - - - - - - - - - SoftLayer_Utility_Network - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Utility_Network

-
-
-
-
-
- Classes - - SoftLayer_Utility_Network - -
- Tags - - datatype - - sldn - - utility - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Utility_Network

- -
- -
- - -

Description

- - - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- -
-
-

Relational

- - - -

Count

- -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Vendor_Type/index.html b/reference/datatypes/SoftLayer_Vendor_Type/index.html deleted file mode 100644 index 57b0a0fbbde..00000000000 --- a/reference/datatypes/SoftLayer_Vendor_Type/index.html +++ /dev/null @@ -1,379 +0,0 @@ - - - - - - - - - - - - SoftLayer_Vendor_Type - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Vendor_Type

-
-
-
-
-
- Classes - - SoftLayer_Vendor_Type - -
- Tags - - datatype - - sldn - - vendor - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Vendor_Type

- -
- -
- - -

Description

- - - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

description

-

- - None - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

id

-

- - None - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

keyName

-

- - None - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - - - - - - -

Count

- - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Virtual_Guest_Vpc_IpAllocation/index.html b/reference/datatypes/SoftLayer_Virtual_Guest_Vpc_IpAllocation/index.html deleted file mode 100644 index bea7187b4f6..00000000000 --- a/reference/datatypes/SoftLayer_Virtual_Guest_Vpc_IpAllocation/index.html +++ /dev/null @@ -1,295 +0,0 @@ - - - - - - - - - - - - SoftLayer_Virtual_Guest_Vpc_IpAllocation - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Virtual_Guest_Vpc_IpAllocation

-
-
-
-
-
- Classes - - SoftLayer_Virtual_Guest_Vpc_IpAllocation - -
- Tags - - datatype - - sldn - - virtual - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Virtual_Guest_Vpc_IpAllocation

- -
- -
- - -

Description

- - - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- -
-
-

Relational

- - - -

Count

- -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Virtual_Guest_Vpc_Subnet/index.html b/reference/datatypes/SoftLayer_Virtual_Guest_Vpc_Subnet/index.html deleted file mode 100644 index 9bd48205694..00000000000 --- a/reference/datatypes/SoftLayer_Virtual_Guest_Vpc_Subnet/index.html +++ /dev/null @@ -1,295 +0,0 @@ - - - - - - - - - - - - SoftLayer_Virtual_Guest_Vpc_Subnet - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Virtual_Guest_Vpc_Subnet

-
-
-
-
-
- Classes - - SoftLayer_Virtual_Guest_Vpc_Subnet - -
- Tags - - datatype - - sldn - - virtual - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Virtual_Guest_Vpc_Subnet

- -
- -
- - -

Description

- - - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- -
-
-

Relational

- - - -

Count

- -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Workload_Citrix_Client/index.html b/reference/datatypes/SoftLayer_Workload_Citrix_Client/index.html deleted file mode 100644 index 8b63b867ab9..00000000000 --- a/reference/datatypes/SoftLayer_Workload_Citrix_Client/index.html +++ /dev/null @@ -1,245 +0,0 @@ - - - - - - - - - - - - SoftLayer_Workload_Citrix_Client - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Workload_Citrix_Client

-
-
-
-
-
- Classes - - SoftLayer_Workload_Citrix_Client - -
- Tags - - datatype - - sldn - - workload - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Workload_Citrix_Client

- -
- -
- - -

Description

- - - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- -
-
-

Relational

- - - -

Count

- -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Workload_Citrix_Client_Response/index.html b/reference/datatypes/SoftLayer_Workload_Citrix_Client_Response/index.html deleted file mode 100644 index e332207181d..00000000000 --- a/reference/datatypes/SoftLayer_Workload_Citrix_Client_Response/index.html +++ /dev/null @@ -1,328 +0,0 @@ - - - - - - - - - - - - SoftLayer_Workload_Citrix_Client_Response - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Workload_Citrix_Client_Response

-
-
-
-
-
- Classes - - SoftLayer_Workload_Citrix_Client_Response - -
- Tags - - datatype - - sldn - - workload - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Workload_Citrix_Client_Response

- -
- -
- - -

Description

- - - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

messageId

-

- - messageId of Citrix account validation response. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

status

-

- - status of Citrix account validation. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

statusMessage

-

- - status message of Citrix account validation. - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - - - - - - -

Count

- - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Workload_Citrix_Client_Response_ResourceLocations/index.html b/reference/datatypes/SoftLayer_Workload_Citrix_Client_Response_ResourceLocations/index.html deleted file mode 100644 index 5156a4feb18..00000000000 --- a/reference/datatypes/SoftLayer_Workload_Citrix_Client_Response_ResourceLocations/index.html +++ /dev/null @@ -1,358 +0,0 @@ - - - - - - - - - - - - SoftLayer_Workload_Citrix_Client_Response_ResourceLocations - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Workload_Citrix_Client_Response_ResourceLocations

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Workload_Citrix_Client_Response_ResourceLocations

- -
- -
- - -

Description

- - - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

messageId

-

- - messageId of Citrix account validation response. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

resourceLocations

-

- - None - -
- - - - - Type: - - - string[] - - -

- -
- - - - - -
-
-

status

-

- - status of Citrix account validation. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

statusMessage

-

- - status message of Citrix account validation. - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - - - - - - - - -

Count

- - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Workload_Citrix_Deployment/index.html b/reference/datatypes/SoftLayer_Workload_Citrix_Deployment/index.html deleted file mode 100644 index d9c2ddd4b4c..00000000000 --- a/reference/datatypes/SoftLayer_Workload_Citrix_Deployment/index.html +++ /dev/null @@ -1,779 +0,0 @@ - - - - - - - - - - - - SoftLayer_Workload_Citrix_Deployment - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Workload_Citrix_Deployment

-
-
-
-
-
- Classes - - SoftLayer_Workload_Citrix_Deployment - -
- Tags - - datatype - - sldn - - workload - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Workload_Citrix_Deployment

- -
- -
- - -

Description

- - - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - - - -
-
-

accountId

-

- - The account ID to which the deployment belongs. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

activeDirectoryTopology

-

- - Topology used for the Citrix Virtual Apps And Desktop deployment. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

createDate

-

- - The date when this record was created. - -
- - - Type: - - - dateTime - - -

- -
- - - - - -
-
-

dataCenter

-

- - DataCenter of the deployment. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

id

-

- - It is the unique identifier for the deployment. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

modifyDate

-

- - The date when this record was last modified. - -
- - - Type: - - - dateTime - - -

- -
- - - - - -
-
-

name

-

- - Name of the deployment. - -
- - - Type: - - - string - - -

- -
- - - - - - - - - - - -
-
-

statusId

-

- - The SoftLayer_Workload_Citrix_Deployment_Status of the deployment. - -
- - - Type: - - - int - - -

- -
- - - - - - - -
-
-

typeId

-

- - The SoftLayer_Workload_Citrix_Deployment_Type of the deployment. - -
- - - Type: - - - int - - -

- -
- - - - - - - -
-
-

userRecordId

-

- - The identifier for the customer who placed the CVAD order. - -
- - - Type: - - - int - - -

- -
- - - - - - - -
-
-

vlanId

-

- - VLAN ID of the deployment. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

vmwareOrderId

-

- - It is an internal identifier for the VMware solution. It gets set if the CVAD order is for VMware. - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - -
-
-

account

-

- - The SoftLayer_Account to which the deployment belongs. - -
- - - Type: - - - SoftLayer_Account - - -

- -
- - - - - - - - - - - - - - - - - - - - - -
-
-

resources

-

- - It contains a collection of items under the CVAD deployment. - -
- - - - - Type: - - - SoftLayer_Workload_Citrix_Deployment_Resource[] - - -

- -
- - - - - -
-
-

status

-

- - Current Status of the CVAD deployment. - -
- - - Type: - - - SoftLayer_Workload_Citrix_Deployment_Status - - -

- -
- - - - - - - -
-
-

type

-

- - It shows if the deployment is for Citrix Hypervisor or VMware. - -
- - - Type: - - - SoftLayer_Workload_Citrix_Deployment_Type - - -

- -
- - - - - - - -
-
-

user

-

- - It is the SoftLayer_User_Customer who placed the order for CVAD. - -
- - - Type: - - - SoftLayer_User_Customer - - -

- -
- - - - - - - -
-
-

vlan

-

- - It is the VLAN resource for the CVAD deployment. - -
- - - Type: - - - SoftLayer_Network_Vlan - - -

- -
- - - - - - - - -

Count

- - - - - - - - - - - - - - - - - - - - -
-
-

resourceCount

-

- - A count of it contains a collection of items under the CVAD deployment. - -
- - - Type: - - - unsignedLong - - -

- -
- - - - - - - - - - - - - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Workload_Citrix_Deployment_Resource/index.html b/reference/datatypes/SoftLayer_Workload_Citrix_Deployment_Resource/index.html deleted file mode 100644 index af65a62bccb..00000000000 --- a/reference/datatypes/SoftLayer_Workload_Citrix_Deployment_Resource/index.html +++ /dev/null @@ -1,581 +0,0 @@ - - - - - - - - - - - - SoftLayer_Workload_Citrix_Deployment_Resource - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Workload_Citrix_Deployment_Resource

-
-
-
-
-
- Classes - - SoftLayer_Workload_Citrix_Deployment_Resource - -
- Tags - - datatype - - sldn - - workload - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Workload_Citrix_Deployment_Resource

- -
- -
- - -

Description

- - The SoftLayer_Workload_Citrix_Deployment_Resource type contains the information of the resource such as the Deployment ID, resource’s Billing Item ID, Order ID and Role of the resource in the CVAD deployment. - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - - - -
-
-

billingItemId

-

- - Billing item ID of the resource - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

createDate

-

- - The point in time at which the resource was ordered. - -
- - - Type: - - - dateTime - - -

- -
- - - - - - - -
-
-

deploymentId

-

- - CVAD Deployment ID of the resource - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

id

-

- - Unique Identifier of the CVAD Deployment Resource - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

modifyDate

-

- - The last time when the resource was modified. - -
- - - Type: - - - dateTime - - -

- -
- - - - - - - -
-
-

orderId

-

- - Billing Order ID of the resource - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

orderedByCvad

-

- - This flag indicates that whether the CVAD APIs have control over this resource. This resource can be cancelled using CVAD cancellation APIs only if this flag is true. - -
- - - Type: - - - boolean - - -

- -
- - - - - - - -
-
-

roleId

-

- - Role of the resource within the CVAD deployment. For example, a VSI can have different roles such as Proxy Server or DHCP Server. - -
- - - Type: - - - int - - -

- -
- - -
-
-

Relational

- - - - -
-
-

billingItem

-

- - None - -
- - - Type: - - - SoftLayer_Billing_Item - - -

- -
- - - - - - - - - -
-
-

deployment

-

- - None - -
- - - Type: - - - SoftLayer_Workload_Citrix_Deployment - - -

- -
- - - - - - - - - - - -
-
-

order

-

- - None - -
- - - Type: - - - SoftLayer_Billing_Order - - -

- -
- - - - - - - - - -
-
-

role

-

- - None - -
- - - Type: - - - SoftLayer_Workload_Citrix_Deployment_Resource_Role - - -

- -
- - - - - - -

Count

- - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Workload_Citrix_Deployment_Resource_Response/index.html b/reference/datatypes/SoftLayer_Workload_Citrix_Deployment_Resource_Response/index.html deleted file mode 100644 index a832a97870e..00000000000 --- a/reference/datatypes/SoftLayer_Workload_Citrix_Deployment_Resource_Response/index.html +++ /dev/null @@ -1,468 +0,0 @@ - - - - - - - - - - - - SoftLayer_Workload_Citrix_Deployment_Resource_Response - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Workload_Citrix_Deployment_Resource_Response

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Workload_Citrix_Deployment_Resource_Response

- -
- -
- - -

Description

- - The SoftLayer_Workload_Citrix_Deployment_Resource_Response constructs a response object for SoftLayer_Workload_Citrix_Deployment_Resource_Response for the CVAD resource. - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

hardware

-

- - Represents the hardware resource of the CVAD deployment. - -
- - - Type: - - - SoftLayer_Hardware - - -

- -
- - - - - -
-
-

isDeploymentOwned

-

- - It is a flag for internal usage that represents if the underlying resource is ordered by another system of the same infrastructure provider. - -
- - - Type: - - - boolean - - -

- -
- - - - - -
-
-

role

-

- - It represents the role of a VSI resource in the CVAD deployment, e.g., a proxy server, DHCP server, cloud connector. - -
- - - Type: - - - SoftLayer_Workload_Citrix_Deployment_Resource_Role - - -

- -
- - - - - -
-
-

storage

-

- - Storage resource for the CVAD deployment. - -
- - - Type: - - - SoftLayer_Network_Storage - - -

- -
- - - - - -
-
-

subnet

-

- - Represents the subnet resource of the CVAD deployment. - -
- - - Type: - - - SoftLayer_Network_Subnet - - -

- -
- - - - - -
-
-

type

-

- - It contains the category of the item which is set for the current response. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

virtualGuest

-

- - VSI resource for the CVAD deployment. - -
- - - Type: - - - SoftLayer_Virtual_Guest - - -

- -
- - - - - -
-
-

vlan

-

- - Represents the VLAN resource of the CVAD deployment. - -
- - - Type: - - - SoftLayer_Network_Vlan - - -

- -
- - -
-
-

Relational

- - - - - - - - - - - - - - - - - - - -

Count

- - - - - - - - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Workload_Citrix_Deployment_Resource_Role/index.html b/reference/datatypes/SoftLayer_Workload_Citrix_Deployment_Resource_Role/index.html deleted file mode 100644 index 8abb71e334a..00000000000 --- a/reference/datatypes/SoftLayer_Workload_Citrix_Deployment_Resource_Role/index.html +++ /dev/null @@ -1,356 +0,0 @@ - - - - - - - - - - - - SoftLayer_Workload_Citrix_Deployment_Resource_Role - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Workload_Citrix_Deployment_Resource_Role

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Workload_Citrix_Deployment_Resource_Role

- -
- -
- - -

Description

- - SoftLayer_Workload_Citrix_Deployment_Resource_Role contains the role and its description of any resource of Citrix Virtual Apps & Desktops deployment. - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

description

-

- - Description of the resource role - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

id

-

- - ID of the role - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

keyName

-

- - Unique keyName of the role - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

name

-

- - Name of the role - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - - - - - - - - -

Count

- - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Workload_Citrix_Deployment_Response/index.html b/reference/datatypes/SoftLayer_Workload_Citrix_Deployment_Response/index.html deleted file mode 100644 index 981e8d53150..00000000000 --- a/reference/datatypes/SoftLayer_Workload_Citrix_Deployment_Response/index.html +++ /dev/null @@ -1,610 +0,0 @@ - - - - - - - - - - - - SoftLayer_Workload_Citrix_Deployment_Response - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Workload_Citrix_Deployment_Response

-
-
-
-
-
- Classes - - SoftLayer_Workload_Citrix_Deployment_Response - -
- Tags - - datatype - - sldn - - workload - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Workload_Citrix_Deployment_Response

- -
- -
- - -

Description

- - The SoftLayer_Workload_Citrix_Deployment_Response constructs a response object for the SoftLayer_Workload_Citrix_Deployment that includes all resources, i.e., SoftLayer_Workload_Citrix_Deployment_Resource. - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

accountId

-

- - The account ID to which the deployment belongs. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

activeDirectoryTopology

-

- - Topology used for the CVAD deployment - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

createDate

-

- - The date when this deployment was created. - -
- - - Type: - - - dateTime - - -

- -
- - - - - -
-
-

dataCenter

-

- - Location name of the deployment. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

id

-

- - ID of the CVAD deployment. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

modifyDate

-

- - The date when this deployment was modified. - -
- - - Type: - - - dateTime - - -

- -
- - - - - -
-
-

name

-

- - Name of the deployment. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

resources

-

- - It is a collection of objects representing deployment resources such as VLAN, subnet, bare metal, proxy, DHCP, cloud connectors. - -
- - - - - Type: - - - SoftLayer_Workload_Citrix_Deployment_Resource_Response[] - - -

- -
- - - - - -
-
-

status

-

- - Status of the deployment. - -
- - - Type: - - - SoftLayer_Workload_Citrix_Deployment_Status - - -

- -
- - - - - -
-
-

type

-

- - Represents if the deployment is for Citrix Hypervisor or VMware - -
- - - Type: - - - SoftLayer_Workload_Citrix_Deployment_Type - - -

- -
- - - - - -
-
-

userRecordId

-

- - The identifier for the customer who placed the CVAD order. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

vlanId

-

- - VLAN ID of the deployment. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

vmwareOrderId

-

- - It is an internal identifier for the VMware solution. It gets set if the CVAD order is for VMware. - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Count

- - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Workload_Citrix_Deployment_Status/index.html b/reference/datatypes/SoftLayer_Workload_Citrix_Deployment_Status/index.html deleted file mode 100644 index 9dac3934a59..00000000000 --- a/reference/datatypes/SoftLayer_Workload_Citrix_Deployment_Status/index.html +++ /dev/null @@ -1,356 +0,0 @@ - - - - - - - - - - - - SoftLayer_Workload_Citrix_Deployment_Status - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Workload_Citrix_Deployment_Status

-
-
-
-
-
- Classes - - SoftLayer_Workload_Citrix_Deployment_Status - -
- Tags - - datatype - - sldn - - workload - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Workload_Citrix_Deployment_Status

- -
- -
- - -

Description

- - The SoftLayer_Workload_Citrix_Deployment_Status shows the status of Citrix Virtual Apps and Desktop deployment. The deployment can be in one of the following statuses at a given point in time: - PROVISIONING: The resources are being provisioned for the deployment. - ACTIVE: All the resources for the deployment are ready. - CANCELLING: Resources of the deployment are being cancelled. - CANCELLED: All the resources of the deployment are cancelled. - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

description

-

- - The description of the deployment status. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

id

-

- - The ID of the deployment status. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

keyName

-

- - The keyName of the deployment status. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

name

-

- - The title of the deployment status. - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - - - - - - - - -

Count

- - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Workload_Citrix_Deployment_Type/index.html b/reference/datatypes/SoftLayer_Workload_Citrix_Deployment_Type/index.html deleted file mode 100644 index 15ea856a27b..00000000000 --- a/reference/datatypes/SoftLayer_Workload_Citrix_Deployment_Type/index.html +++ /dev/null @@ -1,357 +0,0 @@ - - - - - - - - - - - - SoftLayer_Workload_Citrix_Deployment_Type - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Workload_Citrix_Deployment_Type

-
-
-
-
-
- Classes - - SoftLayer_Workload_Citrix_Deployment_Type - -
- Tags - - datatype - - sldn - - workload - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Workload_Citrix_Deployment_Type

- -
- -
- - -

Description

- - - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

description

-

- - Description of the deployment type. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

id

-

- - The identifer of the deployment type. - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

keyName

-

- - KeyName of the deployment type. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

name

-

- - Name of the deployment type. - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - - - - - - - - -

Count

- - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Workload_Citrix_Request/index.html b/reference/datatypes/SoftLayer_Workload_Citrix_Request/index.html deleted file mode 100644 index cc60b08ba68..00000000000 --- a/reference/datatypes/SoftLayer_Workload_Citrix_Request/index.html +++ /dev/null @@ -1,328 +0,0 @@ - - - - - - - - - - - - SoftLayer_Workload_Citrix_Request - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Workload_Citrix_Request

-
-
-
-
-
- Classes - - SoftLayer_Workload_Citrix_Request - -
- Tags - - datatype - - sldn - - workload - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Workload_Citrix_Request

- -
- -
- - -

Description

- - - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

clientId

-

- - None - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

clientSecret

-

- - None - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

customerId

-

- - None - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - - - - - - -

Count

- - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Workload_Citrix_Request_CreateResourceLocation/index.html b/reference/datatypes/SoftLayer_Workload_Citrix_Request_CreateResourceLocation/index.html deleted file mode 100644 index 934bf7c51b5..00000000000 --- a/reference/datatypes/SoftLayer_Workload_Citrix_Request_CreateResourceLocation/index.html +++ /dev/null @@ -1,356 +0,0 @@ - - - - - - - - - - - - SoftLayer_Workload_Citrix_Request_CreateResourceLocation - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Workload_Citrix_Request_CreateResourceLocation

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Workload_Citrix_Request_CreateResourceLocation

- -
- -
- - -

Description

- - - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

clientId

-

- - None - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

clientSecret

-

- - None - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

customerId

-

- - None - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

resourceLocationName

-

- - None - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - - - - - - - - -

Count

- - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Workload_Citrix_Workspace_Order/index.html b/reference/datatypes/SoftLayer_Workload_Citrix_Workspace_Order/index.html deleted file mode 100644 index c8693487a65..00000000000 --- a/reference/datatypes/SoftLayer_Workload_Citrix_Workspace_Order/index.html +++ /dev/null @@ -1,245 +0,0 @@ - - - - - - - - - - - - SoftLayer_Workload_Citrix_Workspace_Order - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Workload_Citrix_Workspace_Order

-
-
-
-
-
- Classes - - SoftLayer_Workload_Citrix_Workspace_Order - -
- Tags - - datatype - - sldn - - workload - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Workload_Citrix_Workspace_Order

- -
- -
- - -

Description

- - - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- -
-
-

Relational

- - - -

Count

- -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Workload_Citrix_Workspace_Order_Container/index.html b/reference/datatypes/SoftLayer_Workload_Citrix_Workspace_Order_Container/index.html deleted file mode 100644 index 4bbe921ba6a..00000000000 --- a/reference/datatypes/SoftLayer_Workload_Citrix_Workspace_Order_Container/index.html +++ /dev/null @@ -1,582 +0,0 @@ - - - - - - - - - - - - SoftLayer_Workload_Citrix_Workspace_Order_Container - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Workload_Citrix_Workspace_Order_Container

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Workload_Citrix_Workspace_Order_Container

- -
- -
- - -

Description

- - This is the datatype that needs to be populated and sent to SoftLayer_Workload_Citrix_Workspace_Order::placeWorkspaceOrder. - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

activeDirectoryDomainName

-

- - The active directory domain name - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

activeDirectoryNetbiosName

-

- - The active directory netbios name (optional) - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

activeDirectorySafeModePassword

-

- - The active directory safe mode password - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

activeDirectoryTopology

-

- - The active directory topology - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

citrixAPIClientId

-

- - The Citrix API Client Id - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

citrixAPIClientSecret

-

- - The Citrix API Client Secret - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

citrixCustomerId

-

- - The Citrix customer id - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

citrixResourceLocationName

-

- - The Citrix resource location name - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

domain

-

- - The default domain to be used for all server orders where the domain is not specified. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

location

-

- - The specific SoftLayer_Location_Datacenter id where the order should be provisioned. - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

orderContainers

-

- - There should be one child orderContainer for each component ordered. The containerIdentifier should be set on each and have these exact values: proxy server, bare metal server with hypervisor, dhcp server, citrix connector servers, active directory server, vlan, subnet, storage - -
- - - - - Type: - - - SoftLayer_Container_Product_Order[] - - -

- -
- - - - - -
-
-

vmwareContainer

-

- - Set this value to order IBM Cloud for VMware Solutions servers as part of your Citrix Virtual Apps and Desktops order - -
- - - Type: - - - SoftLayer_Workload_Citrix_Workspace_Order_VMwareContainer - - -

- -
- - -
-
-

Relational

- - - - - - - - - - - - - - - - - - - - - - - - - - - -

Count

- - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Workload_Citrix_Workspace_Order_LicenseKey/index.html b/reference/datatypes/SoftLayer_Workload_Citrix_Workspace_Order_LicenseKey/index.html deleted file mode 100644 index 60aa01797b7..00000000000 --- a/reference/datatypes/SoftLayer_Workload_Citrix_Workspace_Order_LicenseKey/index.html +++ /dev/null @@ -1,328 +0,0 @@ - - - - - - - - - - - - SoftLayer_Workload_Citrix_Workspace_Order_LicenseKey - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Workload_Citrix_Workspace_Order_LicenseKey

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Workload_Citrix_Workspace_Order_LicenseKey

- -
- -
- - -

Description

- - This is the datatype that can be populated by the customer to provide license key information for VMware orders. - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

key

-

- - The license key - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

name

-

- - The name of the product (e.g. vcenter, nsx, vsphere, vsan) - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

type

-

- - The license type - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - - - - - - -

Count

- - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Workload_Citrix_Workspace_Order_SharedStorage/index.html b/reference/datatypes/SoftLayer_Workload_Citrix_Workspace_Order_SharedStorage/index.html deleted file mode 100644 index e9c88cd3769..00000000000 --- a/reference/datatypes/SoftLayer_Workload_Citrix_Workspace_Order_SharedStorage/index.html +++ /dev/null @@ -1,356 +0,0 @@ - - - - - - - - - - - - SoftLayer_Workload_Citrix_Workspace_Order_SharedStorage - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Workload_Citrix_Workspace_Order_SharedStorage

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Workload_Citrix_Workspace_Order_SharedStorage

- -
- -
- - -

Description

- - This is the datatype that can be populated by the customer to provide NFS shared storage information for VMware orders. - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

iops

-

- - Which storage tier: e.g. READHEAVY_TIER - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

quantity

-

- - The number of shared storages to order - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

size

-

- - The size of the storage (e.g. STORAGE_SPACE_FOR_2_IOPS_PER_GB) - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

volume

-

- - The volume - -
- - - Type: - - - int - - -

- -
- - -
-
-

Relational

- - - - - - - - - - - -

Count

- - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Workload_Citrix_Workspace_Order_VMwareContainer/index.html b/reference/datatypes/SoftLayer_Workload_Citrix_Workspace_Order_VMwareContainer/index.html deleted file mode 100644 index c4bf9858c3f..00000000000 --- a/reference/datatypes/SoftLayer_Workload_Citrix_Workspace_Order_VMwareContainer/index.html +++ /dev/null @@ -1,616 +0,0 @@ - - - - - - - - - - - - SoftLayer_Workload_Citrix_Workspace_Order_VMwareContainer - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Workload_Citrix_Workspace_Order_VMwareContainer

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Workload_Citrix_Workspace_Order_VMwareContainer

- -
- -
- - -

Description

- - This is the datatype that needs to be populated and sent to SoftLayer_Workload_Citrix_Workspace_Order::placeWorkspaceOrder to order and provision one or more VMware server instances to be used with Citrix Virtual Apps and Desktops. - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

disks

-

- - The bare metal disks - -
- - - - - Type: - - - string[] - - -

- -
- - - - - -
-
-

domain

-

- - The domain for the ordered hosts (e.g. example.org) - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

licenseKeys

-

- - Customer provided license keys (optional) - -
- - - - - Type: - - - SoftLayer_Workload_Citrix_Workspace_Order_LicenseKey[] - - -

- -
- - - - - -
-
-

location

-

- - The datacenter location - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

name

-

- - The name associated with the order - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

nickname

-

- - The nickname for the vSRX service - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

quantity

-

- - The number of instances to order - -
- - - Type: - - - int - - -

- -
- - - - - -
-
-

ram

-

- - The bare metal ram type - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

server

-

- - The bare metal server type - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

sharedStorage

-

- - The bare metal shared nfs storage (optional) - -
- - - - - Type: - - - SoftLayer_Workload_Citrix_Workspace_Order_SharedStorage[] - - -

- -
- - - - - -
-
-

subdomain

-

- - The subdomain for the ordered hosts (e.g. corp). - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

vSphereVersion

-

- - The vSphere version. Valid values are: “6.7” and “7.0” - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

vsanCacheDisks

-

- - The bare metal vsan cache disks (optional) - -
- - - - - Type: - - - string[] - - -

- -
- - -
-
-

Relational

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Count

- - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Workload_Citrix_Workspace_Response/index.html b/reference/datatypes/SoftLayer_Workload_Citrix_Workspace_Response/index.html deleted file mode 100644 index 50bb8534e19..00000000000 --- a/reference/datatypes/SoftLayer_Workload_Citrix_Workspace_Response/index.html +++ /dev/null @@ -1,329 +0,0 @@ - - - - - - - - - - - - SoftLayer_Workload_Citrix_Workspace_Response - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Workload_Citrix_Workspace_Response

-
-
-
-
-
- Classes - - SoftLayer_Workload_Citrix_Workspace_Response - -
- Tags - - datatype - - sldn - - workload - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Workload_Citrix_Workspace_Response

- -
- -
- - -

Description

- - - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

messageId

-

- - messageId associated with any error - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

status

-

- - status of service methods - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

statusMessage

-

- - status message - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - - - - - - -

Count

- - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Workload_Citrix_Workspace_Response_Item/index.html b/reference/datatypes/SoftLayer_Workload_Citrix_Workspace_Response_Item/index.html deleted file mode 100644 index 8273b912eb6..00000000000 --- a/reference/datatypes/SoftLayer_Workload_Citrix_Workspace_Response_Item/index.html +++ /dev/null @@ -1,412 +0,0 @@ - - - - - - - - - - - - SoftLayer_Workload_Citrix_Workspace_Response_Item - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Workload_Citrix_Workspace_Response_Item

-
-
-
-
-
- Classes - - SoftLayer_Workload_Citrix_Workspace_Response_Item - -
- Tags - - datatype - - sldn - - workload - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Workload_Citrix_Workspace_Response_Item

- -
- -
- - -

Description

- - - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

id

-

- - the id of the resource (HARDWARE, GUEST, VLAN, SUBNET, VMWARE) - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

messageId

-

- - messageId associated with any error - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

name

-

- - the name associated with the resource (e.g. name, hostname) - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

status

-

- - status of service methods - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

statusMessage

-

- - status message - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

typeName

-

- - the type of resource (HARDWARE, GUEST, NETWORK_VLAN, SUBNET) - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - - - - - - - - - - - - -

Count

- - - - - - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/datatypes/SoftLayer_Workload_Citrix_Workspace_Response_Result/index.html b/reference/datatypes/SoftLayer_Workload_Citrix_Workspace_Response_Result/index.html deleted file mode 100644 index 378aecebbd1..00000000000 --- a/reference/datatypes/SoftLayer_Workload_Citrix_Workspace_Response_Result/index.html +++ /dev/null @@ -1,358 +0,0 @@ - - - - - - - - - - - - SoftLayer_Workload_Citrix_Workspace_Response_Result - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Workload_Citrix_Workspace_Response_Result

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Workload_Citrix_Workspace_Response_Result

- -
- -
- - -

Description

- - - -
- -
-
-
- -
-
-
-
- - - -
-

Local

- - - - -
-
-

items

-

- - identification and operation result for each item - -
- - - - - Type: - - - SoftLayer_Workload_Citrix_Workspace_Response[] - - -

- -
- - - - - -
-
-

messageId

-

- - messageId associated with any error - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

status

-

- - status of service methods - -
- - - Type: - - - string - - -

- -
- - - - - -
-
-

statusMessage

-

- - status message - -
- - - Type: - - - string - - -

- -
- - -
-
-

Relational

- - - - - - - - - - - -

Count

- - - - - - - - - -
-
-
- -
-
- - -
- - - - - diff --git a/reference/services/SoftLayer_Account/getAverageArchiveUsageMetricDataByDate/index.html b/reference/services/SoftLayer_Account/getAverageArchiveUsageMetricDataByDate/index.html deleted file mode 100644 index 4536a8976a3..00000000000 --- a/reference/services/SoftLayer_Account/getAverageArchiveUsageMetricDataByDate/index.html +++ /dev/null @@ -1,353 +0,0 @@ - - - - - - - - - - - - - - - - getAverageArchiveUsageMetricDataByDate - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getAverageArchiveUsageMetricDataByDate

-
-
-
-
-
- Classes - - SoftLayer_Account - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account::getAverageArchiveUsageMetricDataByDate -

- - -

- Returns the average disk usage for all archive repositories for the timeframe based on the parameters provided. -

-

Description

- - Returns the average disk space usage for all archive repositories. - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
startDateTimedateTimedatetime of the start date of the graph
endDateTimedateTimedatetime of the ending date of the graph
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - float - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [dateTime, dateTime]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account/getAverageArchiveUsageMetricDataByDate'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account/getAveragePublicUsageMetricDataByDate/index.html b/reference/services/SoftLayer_Account/getAveragePublicUsageMetricDataByDate/index.html deleted file mode 100644 index 93ed9278cef..00000000000 --- a/reference/services/SoftLayer_Account/getAveragePublicUsageMetricDataByDate/index.html +++ /dev/null @@ -1,353 +0,0 @@ - - - - - - - - - - - - - - - - getAveragePublicUsageMetricDataByDate - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getAveragePublicUsageMetricDataByDate

-
-
-
-
-
- Classes - - SoftLayer_Account - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account::getAveragePublicUsageMetricDataByDate -

- - -

- Returns the average disk usage for all public repositories for the timeframe based on the parameters provided. -

-

Description

- - Returns the average disk space usage for all public repositories. - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
startDateTimedateTimedatetime of the start date of the graph
endDateTimedateTimedatetime of the ending date of the graph
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - float - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [dateTime, dateTime]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account/getAveragePublicUsageMetricDataByDate'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account/getDomainRegistrations/index.html b/reference/services/SoftLayer_Account/getDomainRegistrations/index.html deleted file mode 100644 index 668c42fc29c..00000000000 --- a/reference/services/SoftLayer_Account/getDomainRegistrations/index.html +++ /dev/null @@ -1,281 +0,0 @@ - - - - - - - - - - - - - - - - getDomainRegistrations - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getDomainRegistrations

-
-
-
-
-
- Classes - - SoftLayer_Account - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account::getDomainRegistrations -

- - -
Deprecated
- -

- -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account/{SoftLayer_AccountID}/getDomainRegistrations'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account/getGlobalLoadBalancerAccounts/index.html b/reference/services/SoftLayer_Account/getGlobalLoadBalancerAccounts/index.html deleted file mode 100644 index a8b8885277e..00000000000 --- a/reference/services/SoftLayer_Account/getGlobalLoadBalancerAccounts/index.html +++ /dev/null @@ -1,281 +0,0 @@ - - - - - - - - - - - - - - - - getGlobalLoadBalancerAccounts - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getGlobalLoadBalancerAccounts

-
-
-
-
-
- Classes - - SoftLayer_Account - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account::getGlobalLoadBalancerAccounts -

- - -
Deprecated
- -

- -

-

Description

- - [Deprecated] The global load balancer accounts for a softlayer customer account. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account/{SoftLayer_AccountID}/getGlobalLoadBalancerAccounts'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account/getLargestAllowedSubnetCidr/index.html b/reference/services/SoftLayer_Account/getLargestAllowedSubnetCidr/index.html deleted file mode 100644 index 3ef138b64aa..00000000000 --- a/reference/services/SoftLayer_Account/getLargestAllowedSubnetCidr/index.html +++ /dev/null @@ -1,356 +0,0 @@ - - - - - - - - - - - - - - - - getLargestAllowedSubnetCidr - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getLargestAllowedSubnetCidr

-
-
-
-
-
- Classes - - SoftLayer_Account - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account::getLargestAllowedSubnetCidr -

- - -

-

Computes the number of available public secondary IP addresses, augmented by the provided number of hosts, before overflow of the allowed host to IP address ratio occurs. The result is aligned to the nearest subnet size that could be accommodated in full.

-

0 is returned if an overflow is detected.

-

The use of $locationId has been deprecated.

- -

-

Description

- - Computes the number of available public secondary IP addresses, aligned to a subnet size. - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
numberOfHostsintNumber of hosts to adjust the current server count by
locationIdintDeprecated
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - int - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [int, int]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account/getLargestAllowedSubnetCidr'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account/getLegacyBandwidthAllotments/index.html b/reference/services/SoftLayer_Account/getLegacyBandwidthAllotments/index.html deleted file mode 100644 index e6d2a588c8e..00000000000 --- a/reference/services/SoftLayer_Account/getLegacyBandwidthAllotments/index.html +++ /dev/null @@ -1,329 +0,0 @@ - - - - - - - - - - - - - - - - getLegacyBandwidthAllotments - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getLegacyBandwidthAllotments

-
-
-
-
-
- Classes - - SoftLayer_Account - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account::getLegacyBandwidthAllotments -

- - -
Deprecated
- -

- -

-

Description

- - [DEPRECATED] The legacy bandwidth allotments for an account. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account/{SoftLayer_AccountID}/getLegacyBandwidthAllotments'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account/getMediaDataTransferRequests/index.html b/reference/services/SoftLayer_Account/getMediaDataTransferRequests/index.html deleted file mode 100644 index 44c8cf58b64..00000000000 --- a/reference/services/SoftLayer_Account/getMediaDataTransferRequests/index.html +++ /dev/null @@ -1,330 +0,0 @@ - - - - - - - - - - - - - - - - getMediaDataTransferRequests - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getMediaDataTransferRequests

-
-
-
-
-
- Classes - - SoftLayer_Account - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account::getMediaDataTransferRequests -

- - -

- -

-

Description

- - An account’s media transfer service requests. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account/{SoftLayer_AccountID}/getMediaDataTransferRequests'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account/getMetricTrackingObject/index.html b/reference/services/SoftLayer_Account/getMetricTrackingObject/index.html deleted file mode 100644 index e9bb2d2353b..00000000000 --- a/reference/services/SoftLayer_Account/getMetricTrackingObject/index.html +++ /dev/null @@ -1,325 +0,0 @@ - - - - - - - - - - - - - - - - getMetricTrackingObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getMetricTrackingObject

-
-
-
-
-
- Classes - - SoftLayer_Account - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account::getMetricTrackingObject -

- - -
Deprecated
- -

- -

-

Description

- - [DEPRECATED] - An accounts metric tracking object. This object records all periodic polled data available to this account. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account/{SoftLayer_AccountID}/getMetricTrackingObject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account/getNextBillingPublicAllotmentHardwareBandwidthDetails/index.html b/reference/services/SoftLayer_Account/getNextBillingPublicAllotmentHardwareBandwidthDetails/index.html deleted file mode 100644 index ba5e4821241..00000000000 --- a/reference/services/SoftLayer_Account/getNextBillingPublicAllotmentHardwareBandwidthDetails/index.html +++ /dev/null @@ -1,329 +0,0 @@ - - - - - - - - - - - - - - - - getNextBillingPublicAllotmentHardwareBandwidthDetails - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getNextBillingPublicAllotmentHardwareBandwidthDetails

-
-
-
-
-
- Classes - - SoftLayer_Account - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account::getNextBillingPublicAllotmentHardwareBandwidthDetails -

- - -
Deprecated
- -

- -

-

Description

- - DEPRECATED - This information can be pulled directly through tapping keys now - DEPRECATED. The allotments for this account and their servers for the next billing cycle. The public inbound and outbound bandwidth is calculated for each server in addition to the daily average network traffic since the last billing date. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account/{SoftLayer_AccountID}/getNextBillingPublicAllotmentHardwareBandwidthDetails'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account/getOpenStackAccountLinks/index.html b/reference/services/SoftLayer_Account/getOpenStackAccountLinks/index.html deleted file mode 100644 index 78663d10cc2..00000000000 --- a/reference/services/SoftLayer_Account/getOpenStackAccountLinks/index.html +++ /dev/null @@ -1,330 +0,0 @@ - - - - - - - - - - - - - - - - getOpenStackAccountLinks - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getOpenStackAccountLinks

-
-
-
-
-
- Classes - - SoftLayer_Account - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account::getOpenStackAccountLinks -

- - -

- -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account/{SoftLayer_AccountID}/getOpenStackAccountLinks'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account/getOpenStackObjectStorage/index.html b/reference/services/SoftLayer_Account/getOpenStackObjectStorage/index.html deleted file mode 100644 index 1909faf997f..00000000000 --- a/reference/services/SoftLayer_Account/getOpenStackObjectStorage/index.html +++ /dev/null @@ -1,332 +0,0 @@ - - - - - - - - - - - - - - - - getOpenStackObjectStorage - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getOpenStackObjectStorage

-
-
-
-
-
- Classes - - SoftLayer_Account - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account::getOpenStackObjectStorage -

- - -
Deprecated
- -

- -

-

Description

- - An account’s associated Openstack related Object Storage accounts. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account/{SoftLayer_AccountID}/getOpenStackObjectStorage'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account/getPrivateAllotmentHardwareBandwidthDetails/index.html b/reference/services/SoftLayer_Account/getPrivateAllotmentHardwareBandwidthDetails/index.html deleted file mode 100644 index 8b1eefdbbde..00000000000 --- a/reference/services/SoftLayer_Account/getPrivateAllotmentHardwareBandwidthDetails/index.html +++ /dev/null @@ -1,329 +0,0 @@ - - - - - - - - - - - - - - - - getPrivateAllotmentHardwareBandwidthDetails - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getPrivateAllotmentHardwareBandwidthDetails

-
-
-
-
-
- Classes - - SoftLayer_Account - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account::getPrivateAllotmentHardwareBandwidthDetails -

- - -
Deprecated
- -

- -

-

Description

- - DEPRECATED - This information can be pulled directly through tapping keys now - DEPRECATED. The allotments for this account and their servers. The private inbound and outbound bandwidth is calculated for each server in addition to the daily average network traffic since the last billing date. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account/{SoftLayer_AccountID}/getPrivateAllotmentHardwareBandwidthDetails'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account/getPublicAllotmentHardwareBandwidthDetails/index.html b/reference/services/SoftLayer_Account/getPublicAllotmentHardwareBandwidthDetails/index.html deleted file mode 100644 index bd1ab19d052..00000000000 --- a/reference/services/SoftLayer_Account/getPublicAllotmentHardwareBandwidthDetails/index.html +++ /dev/null @@ -1,329 +0,0 @@ - - - - - - - - - - - - - - - - getPublicAllotmentHardwareBandwidthDetails - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getPublicAllotmentHardwareBandwidthDetails

-
-
-
-
-
- Classes - - SoftLayer_Account - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account::getPublicAllotmentHardwareBandwidthDetails -

- - -
Deprecated
- -

- -

-

Description

- - DEPRECATED - This information can be pulled directly through tapping keys now - DEPRECATED. The allotments for this account and their servers. The public inbound and outbound bandwidth is calculated for each server in addition to the daily average network traffic since the last billing date. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account/{SoftLayer_AccountID}/getPublicAllotmentHardwareBandwidthDetails'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account/getRwhoisData/index.html b/reference/services/SoftLayer_Account/getRwhoisData/index.html deleted file mode 100644 index e609fd3c274..00000000000 --- a/reference/services/SoftLayer_Account/getRwhoisData/index.html +++ /dev/null @@ -1,332 +0,0 @@ - - - - - - - - - - - - - - - - getRwhoisData - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getRwhoisData

-
-
-
-
-
- Classes - - SoftLayer_Account - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account::getRwhoisData -

- - -
Deprecated
- -

- -

-

Description

- - DEPRECATED - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account/{SoftLayer_AccountID}/getRwhoisData'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account/getSubnetRegistrationDetails/index.html b/reference/services/SoftLayer_Account/getSubnetRegistrationDetails/index.html deleted file mode 100644 index 32a05465c91..00000000000 --- a/reference/services/SoftLayer_Account/getSubnetRegistrationDetails/index.html +++ /dev/null @@ -1,332 +0,0 @@ - - - - - - - - - - - - - - - - getSubnetRegistrationDetails - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getSubnetRegistrationDetails

-
-
-
-
-
- Classes - - SoftLayer_Account - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account::getSubnetRegistrationDetails -

- - -
Deprecated
- -

- -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account/{SoftLayer_AccountID}/getSubnetRegistrationDetails'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account/getSubnetRegistrations/index.html b/reference/services/SoftLayer_Account/getSubnetRegistrations/index.html deleted file mode 100644 index a1d9e4c651e..00000000000 --- a/reference/services/SoftLayer_Account/getSubnetRegistrations/index.html +++ /dev/null @@ -1,332 +0,0 @@ - - - - - - - - - - - - - - - - getSubnetRegistrations - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getSubnetRegistrations

-
-
-
-
-
- Classes - - SoftLayer_Account - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account::getSubnetRegistrations -

- - -
Deprecated
- -

- -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account/{SoftLayer_AccountID}/getSubnetRegistrations'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account/getTranscodeAccounts/index.html b/reference/services/SoftLayer_Account/getTranscodeAccounts/index.html deleted file mode 100644 index f6b573db4f0..00000000000 --- a/reference/services/SoftLayer_Account/getTranscodeAccounts/index.html +++ /dev/null @@ -1,277 +0,0 @@ - - - - - - - - - - - - - - - - getTranscodeAccounts - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getTranscodeAccounts

-
-
-
-
-
- Classes - - SoftLayer_Account - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account::getTranscodeAccounts -

- - -
Deprecated
- -

- -

-

Description

- - An account’s associated Transcode account. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - -
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account/getVdrUpdatesInProgressFlag/index.html b/reference/services/SoftLayer_Account/getVdrUpdatesInProgressFlag/index.html deleted file mode 100644 index 3f64a91b233..00000000000 --- a/reference/services/SoftLayer_Account/getVdrUpdatesInProgressFlag/index.html +++ /dev/null @@ -1,323 +0,0 @@ - - - - - - - - - - - - - - - - getVdrUpdatesInProgressFlag - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getVdrUpdatesInProgressFlag

-
-
-
-
-
- Classes - - SoftLayer_Account - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account::getVdrUpdatesInProgressFlag -

- - -

- -

-

Description

- - DEPRECATED - Return 0 if VDR updates are currently in progress on this account otherwise 1. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

-
  • - - - - boolean - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account/{SoftLayer_AccountID}/getVdrUpdatesInProgressFlag'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Historical_Report/getAccountHostUptimeSummary/index.html b/reference/services/SoftLayer_Account_Historical_Report/getAccountHostUptimeSummary/index.html deleted file mode 100644 index bdc7d2d79c1..00000000000 --- a/reference/services/SoftLayer_Account_Historical_Report/getAccountHostUptimeSummary/index.html +++ /dev/null @@ -1,365 +0,0 @@ - - - - - - - - - - - - - - - - getAccountHostUptimeSummary - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getAccountHostUptimeSummary

-
-
-
-
-
- Classes - - SoftLayer_Account_Historical_Report - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Historical_Report::getAccountHostUptimeSummary -

- - -
Deprecated
- -

- -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
startDateTimestring
endDateTimestring
accountIdintUnused, necessary to keep API contract with parent.
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string, string, int]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Historical_Report/getAccountHostUptimeSummary'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Historical_Report/getAccountUrlUptimeSummary/index.html b/reference/services/SoftLayer_Account_Historical_Report/getAccountUrlUptimeSummary/index.html deleted file mode 100644 index 84fe0d1bc7c..00000000000 --- a/reference/services/SoftLayer_Account_Historical_Report/getAccountUrlUptimeSummary/index.html +++ /dev/null @@ -1,365 +0,0 @@ - - - - - - - - - - - - - - - - getAccountUrlUptimeSummary - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getAccountUrlUptimeSummary

-
-
-
-
-
- Classes - - SoftLayer_Account_Historical_Report - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Historical_Report::getAccountUrlUptimeSummary -

- - -
Deprecated
- -

- -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
startDateTimestring
endDateTimestring
accountIdintUnused, necessary to keep API contract with parent method.
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string, string, int]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Historical_Report/getAccountUrlUptimeSummary'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Historical_Report/getHostUptimeDetail/index.html b/reference/services/SoftLayer_Account_Historical_Report/getHostUptimeDetail/index.html deleted file mode 100644 index 871b3311958..00000000000 --- a/reference/services/SoftLayer_Account_Historical_Report/getHostUptimeDetail/index.html +++ /dev/null @@ -1,365 +0,0 @@ - - - - - - - - - - - - - - - - getHostUptimeDetail - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getHostUptimeDetail

-
-
-
-
-
- Classes - - SoftLayer_Account_Historical_Report - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Historical_Report::getHostUptimeDetail -

- - -
Deprecated
- -

- -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
configurationValueIdint
startDateTimestring
endDateTimestring
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [int, string, string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Historical_Report/getHostUptimeDetail'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Historical_Report/getHostUptimeGraphData/index.html b/reference/services/SoftLayer_Account_Historical_Report/getHostUptimeGraphData/index.html deleted file mode 100644 index c541099aafb..00000000000 --- a/reference/services/SoftLayer_Account_Historical_Report/getHostUptimeGraphData/index.html +++ /dev/null @@ -1,363 +0,0 @@ - - - - - - - - - - - - - - - - getHostUptimeGraphData - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getHostUptimeGraphData

-
-
-
-
-
- Classes - - SoftLayer_Account_Historical_Report - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Historical_Report::getHostUptimeGraphData -

- - -

- -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
configurationValueIdint
startDatestringformat: YYYY-MM-DD (2008-11-01)
endDatestringformat: YYYY-MM-DD (2008-11-01)
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [int, string, string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Historical_Report/getHostUptimeGraphData'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Historical_Report/getUrlUptimeDetail/index.html b/reference/services/SoftLayer_Account_Historical_Report/getUrlUptimeDetail/index.html deleted file mode 100644 index e91117af12f..00000000000 --- a/reference/services/SoftLayer_Account_Historical_Report/getUrlUptimeDetail/index.html +++ /dev/null @@ -1,365 +0,0 @@ - - - - - - - - - - - - - - - - getUrlUptimeDetail - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getUrlUptimeDetail

-
-
-
-
-
- Classes - - SoftLayer_Account_Historical_Report - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Historical_Report::getUrlUptimeDetail -

- - -
Deprecated
- -

- -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
configurationValueIdint
startDateTimestring
endDateTimestring
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [int, string, string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Historical_Report/getUrlUptimeDetail'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Historical_Report/getUrlUptimeGraphData/index.html b/reference/services/SoftLayer_Account_Historical_Report/getUrlUptimeGraphData/index.html deleted file mode 100644 index b7332f36fa3..00000000000 --- a/reference/services/SoftLayer_Account_Historical_Report/getUrlUptimeGraphData/index.html +++ /dev/null @@ -1,363 +0,0 @@ - - - - - - - - - - - - - - - - getUrlUptimeGraphData - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getUrlUptimeGraphData

-
-
-
-
-
- Classes - - SoftLayer_Account_Historical_Report - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Historical_Report::getUrlUptimeGraphData -

- - -

- -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
configurationValueIdint
startDatestringformat: YYYY-MM-DD (2008-11-01)
endDatestringformat: YYYY-MM-DD (2008-11-01)
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [int, string, string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Historical_Report/getUrlUptimeGraphData'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Historical_Report/index.html b/reference/services/SoftLayer_Account_Historical_Report/index.html deleted file mode 100644 index c7603851492..00000000000 --- a/reference/services/SoftLayer_Account_Historical_Report/index.html +++ /dev/null @@ -1,354 +0,0 @@ - - - - - - - - - - - - - SoftLayer_Account_Historical_Report - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Account_Historical_Report

-
-
-
-
-
- Classes - - SoftLayer_Account_Historical_Report - -
- Tags - - service - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Account_Historical_Report

- - -
- -
- - -

Description

- - SoftLayer’s account historical report service allows users to access a broad overview of devices for that account and historical details concerning the overall function and performance of the devices on that account - -
-

Methods

-
-
-
- -
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-

getUrlUptimeDetail

- -

- -
- - - - - - -
-
- -
- -
-
- - - -
- - - - - - - diff --git a/reference/services/SoftLayer_Account_Link_OpenStack/createOSDomain/index.html b/reference/services/SoftLayer_Account_Link_OpenStack/createOSDomain/index.html deleted file mode 100644 index 642a3181e14..00000000000 --- a/reference/services/SoftLayer_Account_Link_OpenStack/createOSDomain/index.html +++ /dev/null @@ -1,346 +0,0 @@ - - - - - - - - - - - - - - - - createOSDomain - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

createOSDomain

-
-
-
-
-
- Classes - - SoftLayer_Account_Link_OpenStack - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Link_OpenStack::createOSDomain -

- - -
Deprecated
- -

- -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
requestSoftLayer_Account_Link_OpenStack_LinkRequest
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [SoftLayer_Account_Link_OpenStack_LinkRequest]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Link_OpenStack/createOSDomain'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Link_OpenStack/createOSProject/index.html b/reference/services/SoftLayer_Account_Link_OpenStack/createOSProject/index.html deleted file mode 100644 index f7df18f6553..00000000000 --- a/reference/services/SoftLayer_Account_Link_OpenStack/createOSProject/index.html +++ /dev/null @@ -1,346 +0,0 @@ - - - - - - - - - - - - - - - - createOSProject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

createOSProject

-
-
-
-
-
- Classes - - SoftLayer_Account_Link_OpenStack - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Link_OpenStack::createOSProject -

- - -
Deprecated
- -

- -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
requestSoftLayer_Account_Link_OpenStack_LinkRequest
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [SoftLayer_Account_Link_OpenStack_LinkRequest]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Link_OpenStack/createOSProject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Link_OpenStack/deleteOSDomain/index.html b/reference/services/SoftLayer_Account_Link_OpenStack/deleteOSDomain/index.html deleted file mode 100644 index ce41c4264c3..00000000000 --- a/reference/services/SoftLayer_Account_Link_OpenStack/deleteOSDomain/index.html +++ /dev/null @@ -1,343 +0,0 @@ - - - - - - - - - - - - - - - - deleteOSDomain - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

deleteOSDomain

-
-
-
-
-
- Classes - - SoftLayer_Account_Link_OpenStack - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Link_OpenStack::deleteOSDomain -

- - -

- -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
domainIdstring
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - boolean - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Link_OpenStack/deleteOSDomain'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Link_OpenStack/deleteOSProject/index.html b/reference/services/SoftLayer_Account_Link_OpenStack/deleteOSProject/index.html deleted file mode 100644 index b4c04058469..00000000000 --- a/reference/services/SoftLayer_Account_Link_OpenStack/deleteOSProject/index.html +++ /dev/null @@ -1,343 +0,0 @@ - - - - - - - - - - - - - - - - deleteOSProject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

deleteOSProject

-
-
-
-
-
- Classes - - SoftLayer_Account_Link_OpenStack - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Link_OpenStack::deleteOSProject -

- - -

- -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
projectIdstring
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - boolean - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Link_OpenStack/deleteOSProject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Link_OpenStack/deleteObject/index.html b/reference/services/SoftLayer_Account_Link_OpenStack/deleteObject/index.html deleted file mode 100644 index e61567c0932..00000000000 --- a/reference/services/SoftLayer_Account_Link_OpenStack/deleteObject/index.html +++ /dev/null @@ -1,324 +0,0 @@ - - - - - - - - - - - - - - - - deleteObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

deleteObject

-
-
-
-
-
- Classes - - SoftLayer_Account_Link_OpenStack - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Link_OpenStack::deleteObject -

- - -

- Remove an account link. -

-

Description

- - deleteObject permanently removes an account link and all of it’s associated keystone data (including users for the associated project). ‘‘‘This cannot be undone.’’’ Be wary of running this method. If you remove an account link in error you will need to re-create it by creating a new SoftLayer_Account_Link_OpenStack object. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - boolean - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Link_OpenStack/{SoftLayer_Account_Link_OpenStackID}/deleteObject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Link_OpenStack/getAccount/index.html b/reference/services/SoftLayer_Account_Link_OpenStack/getAccount/index.html deleted file mode 100644 index 24c17fa15b4..00000000000 --- a/reference/services/SoftLayer_Account_Link_OpenStack/getAccount/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getAccount - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getAccount

-
-
-
-
-
- Classes - - SoftLayer_Account_Link_OpenStack - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Link_OpenStack::getAccount -

- - -

- -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Link_OpenStack/{SoftLayer_Account_Link_OpenStackID}/getAccount'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Link_OpenStack/getOSProject/index.html b/reference/services/SoftLayer_Account_Link_OpenStack/getOSProject/index.html deleted file mode 100644 index 909d0864696..00000000000 --- a/reference/services/SoftLayer_Account_Link_OpenStack/getOSProject/index.html +++ /dev/null @@ -1,343 +0,0 @@ - - - - - - - - - - - - - - - - getOSProject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getOSProject

-
-
-
-
-
- Classes - - SoftLayer_Account_Link_OpenStack - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Link_OpenStack::getOSProject -

- - -

- -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
projectIdstring
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Link_OpenStack/getOSProject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Link_OpenStack/getObject/index.html b/reference/services/SoftLayer_Account_Link_OpenStack/getObject/index.html deleted file mode 100644 index 98c187df3b7..00000000000 --- a/reference/services/SoftLayer_Account_Link_OpenStack/getObject/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getObject

-
-
-
-
-
- Classes - - SoftLayer_Account_Link_OpenStack - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Link_OpenStack::getObject -

- - -

- Retrieve a SoftLayer_Account_Link_OpenStack record. -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Link_OpenStack/{SoftLayer_Account_Link_OpenStackID}/getObject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Link_OpenStack/getServiceProvider/index.html b/reference/services/SoftLayer_Account_Link_OpenStack/getServiceProvider/index.html deleted file mode 100644 index 5f5da79e6d3..00000000000 --- a/reference/services/SoftLayer_Account_Link_OpenStack/getServiceProvider/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getServiceProvider - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getServiceProvider

-
-
-
-
-
- Classes - - SoftLayer_Account_Link_OpenStack - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Link_OpenStack::getServiceProvider -

- - -

- -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Link_OpenStack/{SoftLayer_Account_Link_OpenStackID}/getServiceProvider'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Link_OpenStack/index.html b/reference/services/SoftLayer_Account_Link_OpenStack/index.html deleted file mode 100644 index 5142bac39a0..00000000000 --- a/reference/services/SoftLayer_Account_Link_OpenStack/index.html +++ /dev/null @@ -1,386 +0,0 @@ - - - - - - - - - - - - - SoftLayer_Account_Link_OpenStack - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Account_Link_OpenStack

-
-
-
-
-
- Classes - - SoftLayer_Account_Link_OpenStack - -
- Tags - - service - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Account_Link_OpenStack

- - -
- -
- - -

Description

- - Service for linking account to OpenStack project - -
-

Methods

-
-
-
- -
-
-
-
- - - - - - - -
-

createOSDomain

- -

- -
- - - - - -
-

createOSProject

- -

- -
- - - -
-

deleteOSDomain

- -

- -
- - - -
-

deleteOSProject

- -

- -
- - - -
-

deleteObject

- -

Remove an account link.

- -
- - - -
-

getAccount

- -

- -
- - - -
-

getOSProject

- -

- -
- - - -
-

getObject

- -

Retrieve a SoftLayer_Account_Link_OpenStack record.

- -
- - - -
-

getServiceProvider

- -

- -
- - - -
-

listOSProjects

- -

- -
- - -
-
- -
- -
-
- - - -
- - - - - - - diff --git a/reference/services/SoftLayer_Account_Link_OpenStack/listOSProjects/index.html b/reference/services/SoftLayer_Account_Link_OpenStack/listOSProjects/index.html deleted file mode 100644 index 53a9fa1d392..00000000000 --- a/reference/services/SoftLayer_Account_Link_OpenStack/listOSProjects/index.html +++ /dev/null @@ -1,324 +0,0 @@ - - - - - - - - - - - - - - - - listOSProjects - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

listOSProjects

-
-
-
-
-
- Classes - - SoftLayer_Account_Link_OpenStack - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Link_OpenStack::listOSProjects -

- - -

- -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Link_OpenStack/listOSProjects'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Media/editObject/index.html b/reference/services/SoftLayer_Account_Media/editObject/index.html deleted file mode 100644 index 5f0f0ab3d8e..00000000000 --- a/reference/services/SoftLayer_Account_Media/editObject/index.html +++ /dev/null @@ -1,346 +0,0 @@ - - - - - - - - - - - - - - - - editObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

editObject

-
-
-
-
-
- Classes - - SoftLayer_Account_Media - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Media::editObject -

- - -

- Edit a media. -

-

Description

- - Edit the properties of a media record by passing in a modified instance of a SoftLayer_Account_Media object. - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
templateObjectSoftLayer_Account_MediaA skeleton SoftLayer_Account_Media object with only the properties defined that you wish to change. Unchanged properties are left alone.
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - boolean - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [SoftLayer_Account_Media]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Media/{SoftLayer_Account_MediaID}/editObject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Media/getAccount/index.html b/reference/services/SoftLayer_Account_Media/getAccount/index.html deleted file mode 100644 index a7c75aa7952..00000000000 --- a/reference/services/SoftLayer_Account_Media/getAccount/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getAccount - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getAccount

-
-
-
-
-
- Classes - - SoftLayer_Account_Media - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Media::getAccount -

- - -

- -

-

Description

- - The account to which the media belongs. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Media/{SoftLayer_Account_MediaID}/getAccount'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Media/getAllMediaTypes/index.html b/reference/services/SoftLayer_Account_Media/getAllMediaTypes/index.html deleted file mode 100644 index 54f78f0c99f..00000000000 --- a/reference/services/SoftLayer_Account_Media/getAllMediaTypes/index.html +++ /dev/null @@ -1,324 +0,0 @@ - - - - - - - - - - - - - - - - getAllMediaTypes - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getAllMediaTypes

-
-
-
-
-
- Classes - - SoftLayer_Account_Media - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Media::getAllMediaTypes -

- - -

- Retrieve a list supported media types. -

-

Description

- - Retrieve a list supported media types for SoftLayer’s Data Transfer Service. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Media/getAllMediaTypes'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Media/getCreateUser/index.html b/reference/services/SoftLayer_Account_Media/getCreateUser/index.html deleted file mode 100644 index 5af3f240069..00000000000 --- a/reference/services/SoftLayer_Account_Media/getCreateUser/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getCreateUser - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getCreateUser

-
-
-
-
-
- Classes - - SoftLayer_Account_Media - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Media::getCreateUser -

- - -

- -

-

Description

- - The customer user who created the media object. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Media/{SoftLayer_Account_MediaID}/getCreateUser'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Media/getDatacenter/index.html b/reference/services/SoftLayer_Account_Media/getDatacenter/index.html deleted file mode 100644 index daccc6d6c16..00000000000 --- a/reference/services/SoftLayer_Account_Media/getDatacenter/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getDatacenter - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getDatacenter

-
-
-
-
-
- Classes - - SoftLayer_Account_Media - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Media::getDatacenter -

- - -

- -

-

Description

- - The datacenter where the media resides. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Media/{SoftLayer_Account_MediaID}/getDatacenter'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Media/getModifyEmployee/index.html b/reference/services/SoftLayer_Account_Media/getModifyEmployee/index.html deleted file mode 100644 index fb8e9e12d45..00000000000 --- a/reference/services/SoftLayer_Account_Media/getModifyEmployee/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getModifyEmployee - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getModifyEmployee

-
-
-
-
-
- Classes - - SoftLayer_Account_Media - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Media::getModifyEmployee -

- - -

- -

-

Description

- - The employee who last modified the media. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Media/{SoftLayer_Account_MediaID}/getModifyEmployee'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Media/getModifyUser/index.html b/reference/services/SoftLayer_Account_Media/getModifyUser/index.html deleted file mode 100644 index 3d2c65e9dd2..00000000000 --- a/reference/services/SoftLayer_Account_Media/getModifyUser/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getModifyUser - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getModifyUser

-
-
-
-
-
- Classes - - SoftLayer_Account_Media - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Media::getModifyUser -

- - -

- -

-

Description

- - The customer user who last modified the media. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Media/{SoftLayer_Account_MediaID}/getModifyUser'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Media/getObject/index.html b/reference/services/SoftLayer_Account_Media/getObject/index.html deleted file mode 100644 index cb22e3dc62d..00000000000 --- a/reference/services/SoftLayer_Account_Media/getObject/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getObject

-
-
-
-
-
- Classes - - SoftLayer_Account_Media - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Media::getObject -

- - -

- Retrieve a SoftLayer_Account_Media record. -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Media/{SoftLayer_Account_MediaID}/getObject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Media/getRequest/index.html b/reference/services/SoftLayer_Account_Media/getRequest/index.html deleted file mode 100644 index 8034cdbe0aa..00000000000 --- a/reference/services/SoftLayer_Account_Media/getRequest/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getRequest - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getRequest

-
-
-
-
-
- Classes - - SoftLayer_Account_Media - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Media::getRequest -

- - -

- -

-

Description

- - The request to which the media belongs. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Media/{SoftLayer_Account_MediaID}/getRequest'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Media/getType/index.html b/reference/services/SoftLayer_Account_Media/getType/index.html deleted file mode 100644 index 395e39b9f7c..00000000000 --- a/reference/services/SoftLayer_Account_Media/getType/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getType - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getType

-
-
-
-
-
- Classes - - SoftLayer_Account_Media - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Media::getType -

- - -

- -

-

Description

- - The media’s type. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Media/{SoftLayer_Account_MediaID}/getType'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Media/getVolume/index.html b/reference/services/SoftLayer_Account_Media/getVolume/index.html deleted file mode 100644 index 2f6713e10cf..00000000000 --- a/reference/services/SoftLayer_Account_Media/getVolume/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getVolume - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getVolume

-
-
-
-
-
- Classes - - SoftLayer_Account_Media - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Media::getVolume -

- - -

- -

-

Description

- - A guest’s associated EVault network storage service account. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Media/{SoftLayer_Account_MediaID}/getVolume'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Media/index.html b/reference/services/SoftLayer_Account_Media/index.html deleted file mode 100644 index 195ef12a4d8..00000000000 --- a/reference/services/SoftLayer_Account_Media/index.html +++ /dev/null @@ -1,400 +0,0 @@ - - - - - - - - - - - - - SoftLayer_Account_Media - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Account_Media

-
-
-
-
-
- Classes - - SoftLayer_Account_Media - -
- Tags - - service - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Account_Media

- - -
- -
- - -

Description

- - SoftLayer’s data transfer request media service allows users to access and manage their media devices that they have submitted through SoftLayer’s Data Transfer Service. - -
-

Methods

-
-
-
- -
-
-
-
- - - - - -
-

editObject

- -

Edit a media.

- -
- - - -
-

getAccount

- -

The account to which the media belongs.

- -
- - - -
-

getAllMediaTypes

- -

Retrieve a list supported media types.

- -
- - - -
-

getCreateUser

- -

The customer user who created the media object.

- -
- - - -
-

getDatacenter

- -

The datacenter where the media resides.

- -
- - - -
-

getModifyEmployee

- -

The employee who last modified the media.

- -
- - - -
-

getModifyUser

- -

The customer user who last modified the media.

- -
- - - -
-

getObject

- -

Retrieve a SoftLayer_Account_Media record.

- -
- - - -
-

getRequest

- -

The request to which the media belongs.

- -
- - - -
-

getType

- -

The media’s type.

- -
- - - -
-

getVolume

- -

A guest’s associated EVault network storage service account.

- -
- - - -
-

removeMediaFromList

- -

Remove a media from a SoftLayer account’s list of media.

- -
- - -
-
- -
- -
-
- - - -
- - - - - - - diff --git a/reference/services/SoftLayer_Account_Media/removeMediaFromList/index.html b/reference/services/SoftLayer_Account_Media/removeMediaFromList/index.html deleted file mode 100644 index b9d416de7a6..00000000000 --- a/reference/services/SoftLayer_Account_Media/removeMediaFromList/index.html +++ /dev/null @@ -1,344 +0,0 @@ - - - - - - - - - - - - - - - - removeMediaFromList - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

removeMediaFromList

-
-
-
-
-
- Classes - - SoftLayer_Account_Media - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Media::removeMediaFromList -

- - -

- Remove a media from a SoftLayer account’s list of media. -

-

Description

- - Remove a media from a SoftLayer account’s list of media. The media record is not deleted. - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
mediaTemplateSoftLayer_Account_MediaA template of the media to be hidden from the available media list.
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - int - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [SoftLayer_Account_Media]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Media/removeMediaFromList'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/editObject/index.html b/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/editObject/index.html deleted file mode 100644 index caa4b9b5ca5..00000000000 --- a/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/editObject/index.html +++ /dev/null @@ -1,346 +0,0 @@ - - - - - - - - - - - - - - - - editObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

editObject

-
-
-
-
-
- Classes - - SoftLayer_Account_Media_Data_Transfer_Request - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Media_Data_Transfer_Request::editObject -

- - -

- Edit a data transfer request. -

-

Description

- - Edit the properties of a data transfer request record by passing in a modified instance of a SoftLayer_Account_Media_Data_Transfer_Request object. - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
templateObjectSoftLayer_Account_Media_Data_Transfer_RequestA skeleton SoftLayer_Account_Media_Data_Transfer_Request object with only the properties defined that you wish to change. Unchanged properties are left alone.
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - boolean - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [SoftLayer_Account_Media_Data_Transfer_Request]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Media_Data_Transfer_Request/{SoftLayer_Account_Media_Data_Transfer_RequestID}/editObject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getAccount/index.html b/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getAccount/index.html deleted file mode 100644 index 375fbb667d7..00000000000 --- a/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getAccount/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getAccount - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getAccount

-
-
-
-
-
- Classes - - SoftLayer_Account_Media_Data_Transfer_Request - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Media_Data_Transfer_Request::getAccount -

- - -

- -

-

Description

- - The account to which the request belongs. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Media_Data_Transfer_Request/{SoftLayer_Account_Media_Data_Transfer_RequestID}/getAccount'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getActiveTickets/index.html b/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getActiveTickets/index.html deleted file mode 100644 index 3bb7bb5716a..00000000000 --- a/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getActiveTickets/index.html +++ /dev/null @@ -1,330 +0,0 @@ - - - - - - - - - - - - - - - - getActiveTickets - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getActiveTickets

-
-
-
-
-
- Classes - - SoftLayer_Account_Media_Data_Transfer_Request - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Media_Data_Transfer_Request::getActiveTickets -

- - -

- -

-

Description

- - The active tickets that are attached to the data transfer request. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Media_Data_Transfer_Request/{SoftLayer_Account_Media_Data_Transfer_RequestID}/getActiveTickets'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getAllRequestStatuses/index.html b/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getAllRequestStatuses/index.html deleted file mode 100644 index 6f0ecd47b2d..00000000000 --- a/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getAllRequestStatuses/index.html +++ /dev/null @@ -1,324 +0,0 @@ - - - - - - - - - - - - - - - - getAllRequestStatuses - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getAllRequestStatuses

-
-
-
-
-
- Classes - - SoftLayer_Account_Media_Data_Transfer_Request - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Media_Data_Transfer_Request::getAllRequestStatuses -

- - -

- Retrieves a list of all the possible statuses to which a request may be set. -

-

Description

- - Retrieves a list of all the possible statuses to which a request may be set. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Media_Data_Transfer_Request/getAllRequestStatuses'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getBillingItem/index.html b/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getBillingItem/index.html deleted file mode 100644 index 1e110e1c014..00000000000 --- a/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getBillingItem/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getBillingItem - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getBillingItem

-
-
-
-
-
- Classes - - SoftLayer_Account_Media_Data_Transfer_Request - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Media_Data_Transfer_Request::getBillingItem -

- - -

- -

-

Description

- - The billing item for the original request. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Media_Data_Transfer_Request/{SoftLayer_Account_Media_Data_Transfer_RequestID}/getBillingItem'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getCreateUser/index.html b/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getCreateUser/index.html deleted file mode 100644 index d60095fdfbb..00000000000 --- a/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getCreateUser/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getCreateUser - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getCreateUser

-
-
-
-
-
- Classes - - SoftLayer_Account_Media_Data_Transfer_Request - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Media_Data_Transfer_Request::getCreateUser -

- - -

- -

-

Description

- - The customer user who created the request. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Media_Data_Transfer_Request/{SoftLayer_Account_Media_Data_Transfer_RequestID}/getCreateUser'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getMedia/index.html b/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getMedia/index.html deleted file mode 100644 index 71c6988550b..00000000000 --- a/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getMedia/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getMedia - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getMedia

-
-
-
-
-
- Classes - - SoftLayer_Account_Media_Data_Transfer_Request - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Media_Data_Transfer_Request::getMedia -

- - -

- -

-

Description

- - The media of the request. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Media_Data_Transfer_Request/{SoftLayer_Account_Media_Data_Transfer_RequestID}/getMedia'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getModifyEmployee/index.html b/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getModifyEmployee/index.html deleted file mode 100644 index 24df9f7f72a..00000000000 --- a/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getModifyEmployee/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getModifyEmployee - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getModifyEmployee

-
-
-
-
-
- Classes - - SoftLayer_Account_Media_Data_Transfer_Request - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Media_Data_Transfer_Request::getModifyEmployee -

- - -

- -

-

Description

- - The employee who last modified the request. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Media_Data_Transfer_Request/{SoftLayer_Account_Media_Data_Transfer_RequestID}/getModifyEmployee'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getModifyUser/index.html b/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getModifyUser/index.html deleted file mode 100644 index aebda92f449..00000000000 --- a/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getModifyUser/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getModifyUser - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getModifyUser

-
-
-
-
-
- Classes - - SoftLayer_Account_Media_Data_Transfer_Request - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Media_Data_Transfer_Request::getModifyUser -

- - -

- -

-

Description

- - The customer user who last modified the request. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Media_Data_Transfer_Request/{SoftLayer_Account_Media_Data_Transfer_RequestID}/getModifyUser'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getObject/index.html b/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getObject/index.html deleted file mode 100644 index 288f1062e8c..00000000000 --- a/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getObject/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getObject

-
-
-
-
-
- Classes - - SoftLayer_Account_Media_Data_Transfer_Request - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Media_Data_Transfer_Request::getObject -

- - -

- Retrieve a SoftLayer_Account_Media_Data_Transfer_Request record. -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Media_Data_Transfer_Request/{SoftLayer_Account_Media_Data_Transfer_RequestID}/getObject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getShipments/index.html b/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getShipments/index.html deleted file mode 100644 index 28f7893e2d1..00000000000 --- a/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getShipments/index.html +++ /dev/null @@ -1,330 +0,0 @@ - - - - - - - - - - - - - - - - getShipments - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getShipments

-
-
-
-
-
- Classes - - SoftLayer_Account_Media_Data_Transfer_Request - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Media_Data_Transfer_Request::getShipments -

- - -

- -

-

Description

- - The shipments of the request. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Media_Data_Transfer_Request/{SoftLayer_Account_Media_Data_Transfer_RequestID}/getShipments'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getStatus/index.html b/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getStatus/index.html deleted file mode 100644 index fe8945fd1bd..00000000000 --- a/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getStatus/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getStatus - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getStatus

-
-
-
-
-
- Classes - - SoftLayer_Account_Media_Data_Transfer_Request - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Media_Data_Transfer_Request::getStatus -

- - -

- -

-

Description

- - The status of the request. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Media_Data_Transfer_Request/{SoftLayer_Account_Media_Data_Transfer_RequestID}/getStatus'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getTickets/index.html b/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getTickets/index.html deleted file mode 100644 index 2fd24f08742..00000000000 --- a/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/getTickets/index.html +++ /dev/null @@ -1,330 +0,0 @@ - - - - - - - - - - - - - - - - getTickets - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getTickets

-
-
-
-
-
- Classes - - SoftLayer_Account_Media_Data_Transfer_Request - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Media_Data_Transfer_Request::getTickets -

- - -

- -

-

Description

- - All tickets that are attached to the data transfer request. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Media_Data_Transfer_Request/{SoftLayer_Account_Media_Data_Transfer_RequestID}/getTickets'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/index.html b/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/index.html deleted file mode 100644 index 74ac1f1c517..00000000000 --- a/reference/services/SoftLayer_Account_Media_Data_Transfer_Request/index.html +++ /dev/null @@ -1,409 +0,0 @@ - - - - - - - - - - - - - SoftLayer_Account_Media_Data_Transfer_Request - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Account_Media_Data_Transfer_Request

-
-
-
-
-
- Classes - - SoftLayer_Account_Media_Data_Transfer_Request - -
- Tags - - service - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Account_Media_Data_Transfer_Request

- - -
- -
- - -

Description

- - SoftLayer’s Data Transfer Request Service allows users to send SoftLayer media devices such as DVDs, CDs, USB hard drives or USB flash/thumb drives. These media can be connected to SoftLayer servers and presented as ISCSI targets for use by the user. Currently, the initial usage period is two weeks and there is no charge for this service. Additional time for maintaining the media for continued may be purchased. Please contact sales for additional information regarding this. Once the usage period has elapsed. SoftLayer will disconnect the media and return it to the user. - -
-

Methods

-
-
-
- -
-
-
-
- - - - - -
-

editObject

- -

Edit a data transfer request.

- -
- - - -
-

getAccount

- -

The account to which the request belongs.

- -
- - - -
-

getActiveTickets

- -

The active tickets that are attached to the data transfer request.

- -
- - - -
-

getAllRequestStatuses

- -

Retrieves a list of all the possible statuses to which a request may be set.

- -
- - - -
-

getBillingItem

- -

The billing item for the original request.

- -
- - - -
-

getCreateUser

- -

The customer user who created the request.

- -
- - - -
-

getMedia

- -

The media of the request.

- -
- - - -
-

getModifyEmployee

- -

The employee who last modified the request.

- -
- - - -
-

getModifyUser

- -

The customer user who last modified the request.

- -
- - - -
-

getObject

- -

Retrieve a SoftLayer_Account_Media_Data_Transfer_Request record.

- -
- - - -
-

getShipments

- -

The shipments of the request.

- -
- - - -
-

getStatus

- -

The status of the request.

- -
- - - -
-

getTickets

- -

All tickets that are attached to the data transfer request.

- -
- - -
-
- -
- -
-
- - - -
- - - - - - - diff --git a/reference/services/SoftLayer_Account_Regional_Registry_Detail/createObject/index.html b/reference/services/SoftLayer_Account_Regional_Registry_Detail/createObject/index.html deleted file mode 100644 index 29f5611e2e2..00000000000 --- a/reference/services/SoftLayer_Account_Regional_Registry_Detail/createObject/index.html +++ /dev/null @@ -1,349 +0,0 @@ - - - - - - - - - - - - - - - - createObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

createObject

-
-
-
-
-
- Classes - - SoftLayer_Account_Regional_Registry_Detail - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Regional_Registry_Detail::createObject -

- - -
Deprecated
- -

- [Deprecated] Create a new detail object -

-

Description

- -

The subnet registration detail service has been deprecated.

- This method will create a new SoftLayer_Account_Regional_Registry_Detail object. -

Input - SoftLayer_Account_Regional_Registry_Detail

  • detailTypeId
    • Required
    • Type - integer
  • regionalInternetRegistryHandleId
    The id of the SoftLayer_Account_Rwhois_Handle object. This is only to be used for detailed registrations, where a subnet is registered to an organization. The associated handle will be required to be a valid organization object id at the relevant registry. In this case, the detail object will only be valid for the registry the organization belongs to.
    • Optional
    • Type - integer

- - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
templateObjectSoftLayer_Account_Regional_Registry_DetailThe SoftLayer_Account_Regional_Registry_Detail object that you wish to create.
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [SoftLayer_Account_Regional_Registry_Detail]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Regional_Registry_Detail/createObject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Regional_Registry_Detail/deleteObject/index.html b/reference/services/SoftLayer_Account_Regional_Registry_Detail/deleteObject/index.html deleted file mode 100644 index d8da07a5da1..00000000000 --- a/reference/services/SoftLayer_Account_Regional_Registry_Detail/deleteObject/index.html +++ /dev/null @@ -1,328 +0,0 @@ - - - - - - - - - - - - - - - - deleteObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

deleteObject

-
-
-
-
-
- Classes - - SoftLayer_Account_Regional_Registry_Detail - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Regional_Registry_Detail::deleteObject -

- - -
Deprecated
- -

- [Deprecated] Delete an existing detail object -

-

Description

- -

The subnet registration detail service has been deprecated.

-

This method will delete an existing SoftLayer_Account_Regional_Registry_Detail object.

- - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - boolean - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Regional_Registry_Detail/{SoftLayer_Account_Regional_Registry_DetailID}/deleteObject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Regional_Registry_Detail/editObject/index.html b/reference/services/SoftLayer_Account_Regional_Registry_Detail/editObject/index.html deleted file mode 100644 index bf197c47f3a..00000000000 --- a/reference/services/SoftLayer_Account_Regional_Registry_Detail/editObject/index.html +++ /dev/null @@ -1,350 +0,0 @@ - - - - - - - - - - - - - - - - editObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

editObject

-
-
-
-
-
- Classes - - SoftLayer_Account_Regional_Registry_Detail - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Regional_Registry_Detail::editObject -

- - -
Deprecated
- -

- [Deprecated] Edit an existing detail object -

-

Description

- -

The subnet registration detail service has been deprecated.

-

This method will edit an existing SoftLayer_Account_Regional_Registry_Detail object. For more detail, see SoftLayer_Account_Regional_Registry_Detail::createObject.

- - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
templateObjectSoftLayer_Account_Regional_Registry_DetailA skeleton SoftLayer_Account_Regional_Registry_Detail object with only the properties defined that you wish to change. Unchanged properties are left alone.
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - boolean - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [SoftLayer_Account_Regional_Registry_Detail]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Regional_Registry_Detail/{SoftLayer_Account_Regional_Registry_DetailID}/editObject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Regional_Registry_Detail/getAccount/index.html b/reference/services/SoftLayer_Account_Regional_Registry_Detail/getAccount/index.html deleted file mode 100644 index 016e76cf2d0..00000000000 --- a/reference/services/SoftLayer_Account_Regional_Registry_Detail/getAccount/index.html +++ /dev/null @@ -1,328 +0,0 @@ - - - - - - - - - - - - - - - - getAccount - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getAccount

-
-
-
-
-
- Classes - - SoftLayer_Account_Regional_Registry_Detail - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Regional_Registry_Detail::getAccount -

- - -
Deprecated
- -

- -

-

Description

- - [Deprecated] The account that this detail object belongs to. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Regional_Registry_Detail/{SoftLayer_Account_Regional_Registry_DetailID}/getAccount'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Regional_Registry_Detail/getDetailType/index.html b/reference/services/SoftLayer_Account_Regional_Registry_Detail/getDetailType/index.html deleted file mode 100644 index 210844b7ba5..00000000000 --- a/reference/services/SoftLayer_Account_Regional_Registry_Detail/getDetailType/index.html +++ /dev/null @@ -1,328 +0,0 @@ - - - - - - - - - - - - - - - - getDetailType - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getDetailType

-
-
-
-
-
- Classes - - SoftLayer_Account_Regional_Registry_Detail - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Regional_Registry_Detail::getDetailType -

- - -
Deprecated
- -

- -

-

Description

- - [Deprecated] The associated type of this detail object. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Regional_Registry_Detail/{SoftLayer_Account_Regional_Registry_DetailID}/getDetailType'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Regional_Registry_Detail/getDetails/index.html b/reference/services/SoftLayer_Account_Regional_Registry_Detail/getDetails/index.html deleted file mode 100644 index d2a76fd7aab..00000000000 --- a/reference/services/SoftLayer_Account_Regional_Registry_Detail/getDetails/index.html +++ /dev/null @@ -1,332 +0,0 @@ - - - - - - - - - - - - - - - - getDetails - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getDetails

-
-
-
-
-
- Classes - - SoftLayer_Account_Regional_Registry_Detail - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Regional_Registry_Detail::getDetails -

- - -
Deprecated
- -

- -

-

Description

- - [Deprecated] References to the SoftLayer_Network_Subnet_Registration that consume this detail object. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Regional_Registry_Detail/{SoftLayer_Account_Regional_Registry_DetailID}/getDetails'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Regional_Registry_Detail/getObject/index.html b/reference/services/SoftLayer_Account_Regional_Registry_Detail/getObject/index.html deleted file mode 100644 index 8c828fc1ca0..00000000000 --- a/reference/services/SoftLayer_Account_Regional_Registry_Detail/getObject/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getObject

-
-
-
-
-
- Classes - - SoftLayer_Account_Regional_Registry_Detail - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Regional_Registry_Detail::getObject -

- - -

- Retrieve a SoftLayer_Account_Regional_Registry_Detail record. -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Regional_Registry_Detail/{SoftLayer_Account_Regional_Registry_DetailID}/getObject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Regional_Registry_Detail/getProperties/index.html b/reference/services/SoftLayer_Account_Regional_Registry_Detail/getProperties/index.html deleted file mode 100644 index 7c4f60266b0..00000000000 --- a/reference/services/SoftLayer_Account_Regional_Registry_Detail/getProperties/index.html +++ /dev/null @@ -1,332 +0,0 @@ - - - - - - - - - - - - - - - - getProperties - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getProperties

-
-
-
-
-
- Classes - - SoftLayer_Account_Regional_Registry_Detail - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Regional_Registry_Detail::getProperties -

- - -
Deprecated
- -

- -

-

Description

- - [Deprecated] The individual properties that define this detail object’s values. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Regional_Registry_Detail/{SoftLayer_Account_Regional_Registry_DetailID}/getProperties'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Regional_Registry_Detail/getRegionalInternetRegistryHandle/index.html b/reference/services/SoftLayer_Account_Regional_Registry_Detail/getRegionalInternetRegistryHandle/index.html deleted file mode 100644 index 801597c7f09..00000000000 --- a/reference/services/SoftLayer_Account_Regional_Registry_Detail/getRegionalInternetRegistryHandle/index.html +++ /dev/null @@ -1,328 +0,0 @@ - - - - - - - - - - - - - - - - getRegionalInternetRegistryHandle - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getRegionalInternetRegistryHandle

-
-
-
-
-
- Classes - - SoftLayer_Account_Regional_Registry_Detail - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Regional_Registry_Detail::getRegionalInternetRegistryHandle -

- - -
Deprecated
- -

- -

-

Description

- - [Deprecated] The associated RWhois handle of this detail object. Used only when detailed reassignments are necessary. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Regional_Registry_Detail/{SoftLayer_Account_Regional_Registry_DetailID}/getRegionalInternetRegistryHandle'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Regional_Registry_Detail/index.html b/reference/services/SoftLayer_Account_Regional_Registry_Detail/index.html deleted file mode 100644 index 79ee81f0e25..00000000000 --- a/reference/services/SoftLayer_Account_Regional_Registry_Detail/index.html +++ /dev/null @@ -1,415 +0,0 @@ - - - - - - - - - - - - - SoftLayer_Account_Regional_Registry_Detail - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Account_Regional_Registry_Detail

-
-
-
-
-
- Classes - - SoftLayer_Account_Regional_Registry_Detail - -
- Tags - - service - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Account_Regional_Registry_Detail

- - -
- -
- - -

Description

- -
Deprecated
- -

The subnet registration detail service has been deprecated.

-

Regional Registry Detail objects are used to specify the information you wish to use when registering subnets with the appropriate Regional Internet Registries.

- - -
-

Methods

-
-
-
- -
-
-
-
- - - - - - - -
-

createObject

- -

[Deprecated] Create a new detail object

- -
- - - - - -
-

deleteObject

- -

[Deprecated] Delete an existing detail object

- -
- - - - - -
-

editObject

- -

[Deprecated] Edit an existing detail object

- -
- - - - - -
-

getAccount

- -

[Deprecated] The account that this detail object belongs to.

- -
- - - - - -
-

getDetailType

- -

[Deprecated] The associated type of this detail object.

- -
- - - - - -
-

getDetails

- -

[Deprecated] References to the SoftLayer_Network_Subnet_Registration that consume this detail object.

- -
- - - -
-

getObject

- -

Retrieve a SoftLayer_Account_Regional_Registry_Detail record.

- -
- - - - - -
-

getProperties

- -

[Deprecated] The individual properties that define this detail object’s values.

- -
- - - - - -
-

getRegionalInternetRegistryHandle

- -

[Deprecated] The associated RWhois handle of this detail object. Used only when detailed reassignments are necessary.

- -
- - - - - -
-

updateReferencedRegistrations

- -

[Deprecated] Create a transaction to update the registrations that reference this detail object.

- -
- - - - - -
-

validatePersonForAllRegistrars

- -

[Deprecated] Validate an existing person detail object.

- -
- - -
-
- -
- -
-
- - - -
- - - - - - - diff --git a/reference/services/SoftLayer_Account_Regional_Registry_Detail/updateReferencedRegistrations/index.html b/reference/services/SoftLayer_Account_Regional_Registry_Detail/updateReferencedRegistrations/index.html deleted file mode 100644 index c005bc1cc2c..00000000000 --- a/reference/services/SoftLayer_Account_Regional_Registry_Detail/updateReferencedRegistrations/index.html +++ /dev/null @@ -1,328 +0,0 @@ - - - - - - - - - - - - - - - - updateReferencedRegistrations - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

updateReferencedRegistrations

-
-
-
-
-
- Classes - - SoftLayer_Account_Regional_Registry_Detail - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Regional_Registry_Detail::updateReferencedRegistrations -

- - -
Deprecated
- -

- [Deprecated] Create a transaction to update the registrations that reference this detail object. -

-

Description

- -

The subnet registration detail service has been deprecated.

-

This method will create a bulk transaction to update any registrations that reference this detail object. It should only be called from a child class such as SoftLayer_Account_Regional_Registry_Detail_Person or SoftLayer_Account_Regional_Registry_Detail_Network. The registrations should be in the Open or Registration_Complete status.

- - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Regional_Registry_Detail/{SoftLayer_Account_Regional_Registry_DetailID}/updateReferencedRegistrations'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Regional_Registry_Detail/validatePersonForAllRegistrars/index.html b/reference/services/SoftLayer_Account_Regional_Registry_Detail/validatePersonForAllRegistrars/index.html deleted file mode 100644 index 0948fe842bd..00000000000 --- a/reference/services/SoftLayer_Account_Regional_Registry_Detail/validatePersonForAllRegistrars/index.html +++ /dev/null @@ -1,333 +0,0 @@ - - - - - - - - - - - - - - - - validatePersonForAllRegistrars - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

validatePersonForAllRegistrars

-
-
-
-
-
- Classes - - SoftLayer_Account_Regional_Registry_Detail - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Regional_Registry_Detail::validatePersonForAllRegistrars -

- - -
Deprecated
- -

- [Deprecated] Validate an existing person detail object. -

-

Description

- -

The subnet registration detail service has been deprecated.

-

Validates this person detail against all supported external registrars (APNIC/ARIN/RIPE). The validation uses the most restrictive rules ensuring that any person detail passing this validation would be acceptable to any supported registrar.

-

The person detail properties are validated against - Non-emptiness - Minimum length - Maximum length - Maximum words - Supported characters - Format of data

-

If the person detail validation succeeds, then an empty list is returned indicating no errors were found and that this person detail would work against all three registrars during a subnet registration.

-

If the person detail validation fails, then an array of validation errors (SoftLayer_Container_Message[]) is returned. Each message container contains error messages grouped by property type and a message type indicating the person detail property type object which failed validation. It is possible to create a subnet registration using a person detail which does not pass this validation, but at least one registrar would reject it for being invalid.

- - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Regional_Registry_Detail/{SoftLayer_Account_Regional_Registry_DetailID}/validatePersonForAllRegistrars'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/createObject/index.html b/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/createObject/index.html deleted file mode 100644 index 8777207c20f..00000000000 --- a/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/createObject/index.html +++ /dev/null @@ -1,349 +0,0 @@ - - - - - - - - - - - - - - - - createObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

createObject

-
-
-
-
-
- Classes - - SoftLayer_Account_Regional_Registry_Detail_Property - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Regional_Registry_Detail_Property::createObject -

- - -
Deprecated
- -

- [Deprecated] Create a new property object -

-

Description

- -

The subnet registration detail property service has been deprecated.

- This method will create a new SoftLayer_Account_Regional_Registry_Detail_Property object. -

Input - SoftLayer_Account_Regional_Registry_Detail_Property

  • registrationDetailId
    The numeric ID of the SoftLayer_Account_Regional_Registry_Detail this property belongs to
    • Required
    • Type - integer
  • propertyTypeId
    The numeric ID of the associated SoftLayer_Account_Regional_Registry_Detail_Property_Type object
    • Required
    • Type - integer
  • sequencePosition
    When more than one property of the same type exists on a detail object, this value determines the position in that collection. This can be thought of more as a sort order.
    • Required
    • Type - integer
  • value
    The actual value of the property.
    • Required
    • Type - string

- - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
templateObjectSoftLayer_Account_Regional_Registry_Detail_PropertyThe SoftLayer_Account_Regional_Registry_Detail_Property object that you wish to create.
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [SoftLayer_Account_Regional_Registry_Detail_Property]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Regional_Registry_Detail_Property/createObject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/createObjects/index.html b/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/createObjects/index.html deleted file mode 100644 index f72dd3d0e56..00000000000 --- a/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/createObjects/index.html +++ /dev/null @@ -1,360 +0,0 @@ - - - - - - - - - - - - - - - - createObjects - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

createObjects

-
-
-
-
-
- Classes - - SoftLayer_Account_Regional_Registry_Detail_Property - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Regional_Registry_Detail_Property::createObjects -

- - -
Deprecated
- -

- [Deprecated] Create multiple property objects. -

-

Description

- -

The subnet registration detail property service has been deprecated.

-

Edit multiple SoftLayer_Account_Regional_Registry_Detail_Property objects.

- - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
templateObjectsSoftLayer_Account_Regional_Registry_Detail_Property[]An array of SoftLayer_Account_Regional_Registry_Detail_Property objects that you wish to create.
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - -

Associated Methods

- - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [SoftLayer_Account_Regional_Registry_Detail_Property]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Regional_Registry_Detail_Property/createObjects'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/deleteObject/index.html b/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/deleteObject/index.html deleted file mode 100644 index 4f853f5b2a5..00000000000 --- a/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/deleteObject/index.html +++ /dev/null @@ -1,328 +0,0 @@ - - - - - - - - - - - - - - - - deleteObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

deleteObject

-
-
-
-
-
- Classes - - SoftLayer_Account_Regional_Registry_Detail_Property - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Regional_Registry_Detail_Property::deleteObject -

- - -
Deprecated
- -

- [Deprecated] Delete an existing property object -

-

Description

- -

The subnet registration detail property service has been deprecated.

-

This method will delete an existing SoftLayer_Account_Regional_Registry_Detail_Property object.

- - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - boolean - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Regional_Registry_Detail_Property/{SoftLayer_Account_Regional_Registry_Detail_PropertyID}/deleteObject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/editObject/index.html b/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/editObject/index.html deleted file mode 100644 index 7f90d5e775f..00000000000 --- a/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/editObject/index.html +++ /dev/null @@ -1,350 +0,0 @@ - - - - - - - - - - - - - - - - editObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

editObject

-
-
-
-
-
- Classes - - SoftLayer_Account_Regional_Registry_Detail_Property - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Regional_Registry_Detail_Property::editObject -

- - -
Deprecated
- -

- [Deprecated] Edit an existing property object -

-

Description

- -

The subnet registration detail property service has been deprecated.

-

This method will edit an existing SoftLayer_Account_Regional_Registry_Detail_Property object. For more detail, see SoftLayer_Account_Regional_Registry_Detail_Property::createObject.

- - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
templateObjectSoftLayer_Account_Regional_Registry_Detail_PropertyA skeleton SoftLayer_Account_Regional_Registry_Detail_Property object with only the properties defined that you wish to change. Unchanged properties are left alone.
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - boolean - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [SoftLayer_Account_Regional_Registry_Detail_Property]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Regional_Registry_Detail_Property/{SoftLayer_Account_Regional_Registry_Detail_PropertyID}/editObject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/editObjects/index.html b/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/editObjects/index.html deleted file mode 100644 index a2160b2f658..00000000000 --- a/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/editObjects/index.html +++ /dev/null @@ -1,358 +0,0 @@ - - - - - - - - - - - - - - - - editObjects - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

editObjects

-
-
-
-
-
- Classes - - SoftLayer_Account_Regional_Registry_Detail_Property - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Regional_Registry_Detail_Property::editObjects -

- - -
Deprecated
- -

- [Deprecated] Edit multiple property objects. -

-

Description

- -

The subnet registration detail property service has been deprecated.

-

Edit multiple SoftLayer_Account_Regional_Registry_Detail_Property objects.

- - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
templateObjectsSoftLayer_Account_Regional_Registry_Detail_Property[]An array of skeleton SoftLayer_Account_Regional_Registry_Detail_Property objects with only the properties defined that you wish to change. Unchanged properties are left alone.
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - boolean - -
- - - -

Associated Methods

- - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [SoftLayer_Account_Regional_Registry_Detail_Property]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Regional_Registry_Detail_Property/editObjects'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/getDetail/index.html b/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/getDetail/index.html deleted file mode 100644 index 2284ee0ee9e..00000000000 --- a/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/getDetail/index.html +++ /dev/null @@ -1,328 +0,0 @@ - - - - - - - - - - - - - - - - getDetail - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getDetail

-
-
-
-
-
- Classes - - SoftLayer_Account_Regional_Registry_Detail_Property - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Regional_Registry_Detail_Property::getDetail -

- - -
Deprecated
- -

- -

-

Description

- - [Deprecated] The SoftLayer_Account_Regional_Registry_Detail object this property belongs to - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Regional_Registry_Detail_Property/{SoftLayer_Account_Regional_Registry_Detail_PropertyID}/getDetail'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/getObject/index.html b/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/getObject/index.html deleted file mode 100644 index 3cfb303dd6c..00000000000 --- a/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/getObject/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getObject

-
-
-
-
-
- Classes - - SoftLayer_Account_Regional_Registry_Detail_Property - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Regional_Registry_Detail_Property::getObject -

- - -

- Retrieve a SoftLayer_Account_Regional_Registry_Detail_Property record. -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Regional_Registry_Detail_Property/{SoftLayer_Account_Regional_Registry_Detail_PropertyID}/getObject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/getPropertyType/index.html b/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/getPropertyType/index.html deleted file mode 100644 index 75c52010540..00000000000 --- a/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/getPropertyType/index.html +++ /dev/null @@ -1,328 +0,0 @@ - - - - - - - - - - - - - - - - getPropertyType - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getPropertyType

-
-
-
-
-
- Classes - - SoftLayer_Account_Regional_Registry_Detail_Property - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Regional_Registry_Detail_Property::getPropertyType -

- - -
Deprecated
- -

- -

-

Description

- - [Deprecated] The SoftLayer_Account_Regional_Registry_Detail_Property_Type object this property belongs to - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Regional_Registry_Detail_Property/{SoftLayer_Account_Regional_Registry_Detail_PropertyID}/getPropertyType'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/index.html b/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/index.html deleted file mode 100644 index cb04b283263..00000000000 --- a/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property/index.html +++ /dev/null @@ -1,382 +0,0 @@ - - - - - - - - - - - - - SoftLayer_Account_Regional_Registry_Detail_Property - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Account_Regional_Registry_Detail_Property

-
-
-
-
-
- Classes - - SoftLayer_Account_Regional_Registry_Detail_Property - -
- Tags - - service - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Account_Regional_Registry_Detail_Property

- - -
- -
- - -

Description

- -
Deprecated
- -

The subnet registration detail property service has been deprecated.

-

The subnet registration property is used to define various attributes of SoftLayer_Account_Regional_Registry_Detail. For more information, please see the SoftLayer_Account_Regional_Registry_Detail_Property.

- - -
-

Methods

-
-
-
- -
-
-
-
- - - - - - - -
-

createObject

- -

[Deprecated] Create a new property object

- -
- - - - - -
-

createObjects

- -

[Deprecated] Create multiple property objects.

- -
- - - - - -
-

deleteObject

- -

[Deprecated] Delete an existing property object

- -
- - - - - -
-

editObject

- -

[Deprecated] Edit an existing property object

- -
- - - - - -
-

editObjects

- -

[Deprecated] Edit multiple property objects.

- -
- - - - - -
-

getDetail

- -

[Deprecated] The SoftLayer_Account_Regional_Registry_Detail object this property belongs to

- -
- - - -
-

getObject

- -

Retrieve a SoftLayer_Account_Regional_Registry_Detail_Property record.

- -
- - - - - -
-

getPropertyType

- -

[Deprecated] The SoftLayer_Account_Regional_Registry_Detail_Property_Type object this property belongs to

- -
- - -
-
- -
- -
-
- - - -
- - - - - - - diff --git a/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property_Type/getAllObjects/index.html b/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property_Type/getAllObjects/index.html deleted file mode 100644 index 259dff32d6f..00000000000 --- a/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property_Type/getAllObjects/index.html +++ /dev/null @@ -1,330 +0,0 @@ - - - - - - - - - - - - - - - - getAllObjects - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getAllObjects

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Regional_Registry_Detail_Property_Type::getAllObjects -

- - -
Deprecated
- -

- -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Regional_Registry_Detail_Property_Type/getAllObjects'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property_Type/getObject/index.html b/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property_Type/getObject/index.html deleted file mode 100644 index fb728397718..00000000000 --- a/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property_Type/getObject/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getObject

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Regional_Registry_Detail_Property_Type::getObject -

- - -

- Retrieve a SoftLayer_Account_Regional_Registry_Detail_Property_Type record. -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Regional_Registry_Detail_Property_Type/{SoftLayer_Account_Regional_Registry_Detail_Property_TypeID}/getObject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property_Type/index.html b/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property_Type/index.html deleted file mode 100644 index 99388dc78d7..00000000000 --- a/reference/services/SoftLayer_Account_Regional_Registry_Detail_Property_Type/index.html +++ /dev/null @@ -1,314 +0,0 @@ - - - - - - - - - - - - - SoftLayer_Account_Regional_Registry_Detail_Property_Type - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Account_Regional_Registry_Detail_Property_Type

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Account_Regional_Registry_Detail_Property_Type

- - -
- -
- - -

Description

- -
Deprecated
- - - -
-

Methods

-
-
-
- -
-
-
-
- - - - - - - -
-

getAllObjects

- -

- -
- - - -
-

getObject

- -

Retrieve a SoftLayer_Account_Regional_Registry_Detail_Property_Type record.

- -
- - -
-
- -
- -
-
- - - -
- - - - - - - diff --git a/reference/services/SoftLayer_Account_Regional_Registry_Detail_Type/getAllObjects/index.html b/reference/services/SoftLayer_Account_Regional_Registry_Detail_Type/getAllObjects/index.html deleted file mode 100644 index f9e6f96902b..00000000000 --- a/reference/services/SoftLayer_Account_Regional_Registry_Detail_Type/getAllObjects/index.html +++ /dev/null @@ -1,330 +0,0 @@ - - - - - - - - - - - - - - - - getAllObjects - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getAllObjects

-
-
-
-
-
- Classes - - SoftLayer_Account_Regional_Registry_Detail_Type - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Regional_Registry_Detail_Type::getAllObjects -

- - -
Deprecated
- -

- -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Regional_Registry_Detail_Type/getAllObjects'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Regional_Registry_Detail_Type/getObject/index.html b/reference/services/SoftLayer_Account_Regional_Registry_Detail_Type/getObject/index.html deleted file mode 100644 index a47da74911c..00000000000 --- a/reference/services/SoftLayer_Account_Regional_Registry_Detail_Type/getObject/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getObject

-
-
-
-
-
- Classes - - SoftLayer_Account_Regional_Registry_Detail_Type - -
- Tags - - method - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Account_Regional_Registry_Detail_Type::getObject -

- - -

- Retrieve a SoftLayer_Account_Regional_Registry_Detail_Type record. -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Regional_Registry_Detail_Type/{SoftLayer_Account_Regional_Registry_Detail_TypeID}/getObject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Account_Regional_Registry_Detail_Type/index.html b/reference/services/SoftLayer_Account_Regional_Registry_Detail_Type/index.html deleted file mode 100644 index b2ce48d029c..00000000000 --- a/reference/services/SoftLayer_Account_Regional_Registry_Detail_Type/index.html +++ /dev/null @@ -1,314 +0,0 @@ - - - - - - - - - - - - - SoftLayer_Account_Regional_Registry_Detail_Type - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Account_Regional_Registry_Detail_Type

-
-
-
-
-
- Classes - - SoftLayer_Account_Regional_Registry_Detail_Type - -
- Tags - - service - - sldn - - account - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Account_Regional_Registry_Detail_Type

- - -
- -
- - -

Description

- -
Deprecated
- - - -
-

Methods

-
-
-
- -
-
-
-
- - - - - - - -
-

getAllObjects

- -

- -
- - - -
-

getObject

- -

Retrieve a SoftLayer_Account_Regional_Registry_Detail_Type record.

- -
- - -
-
- -
- -
-
- - - -
- - - - - - - diff --git a/reference/services/SoftLayer_Auxiliary_Network_Status/getNetworkStatus/index.html b/reference/services/SoftLayer_Auxiliary_Network_Status/getNetworkStatus/index.html deleted file mode 100644 index 8b6f136af0a..00000000000 --- a/reference/services/SoftLayer_Auxiliary_Network_Status/getNetworkStatus/index.html +++ /dev/null @@ -1,347 +0,0 @@ - - - - - - - - - - - - - - - - getNetworkStatus - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getNetworkStatus

-
-
-
-
-
- Classes - - SoftLayer_Auxiliary_Network_Status - -
- Tags - - method - - sldn - - auxiliary - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Auxiliary_Network_Status::getNetworkStatus -

- - -
Deprecated
- -

- -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
targetenum
  • ALL
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [enum]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Auxiliary_Network_Status/getNetworkStatus'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Auxiliary_Network_Status/index.html b/reference/services/SoftLayer_Auxiliary_Network_Status/index.html deleted file mode 100644 index 5c3b50b6234..00000000000 --- a/reference/services/SoftLayer_Auxiliary_Network_Status/index.html +++ /dev/null @@ -1,305 +0,0 @@ - - - - - - - - - - - - - SoftLayer_Auxiliary_Network_Status - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Auxiliary_Network_Status

-
-
-
-
-
- Classes - - SoftLayer_Auxiliary_Network_Status - -
- Tags - - service - - sldn - - auxiliary - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Auxiliary_Network_Status

- - -
- -
- - -

Description

- -
Deprecated
- - - -
-

Methods

-
-
-
- -
-
-
-
- - - - - - - -
-

getNetworkStatus

- -

- -
- - -
-
- -
- -
-
- - - -
- - - - - - - diff --git a/reference/services/SoftLayer_Dns_Domain_Registration/addNameserversToDomain/index.html b/reference/services/SoftLayer_Dns_Domain_Registration/addNameserversToDomain/index.html deleted file mode 100644 index ad201e6284c..00000000000 --- a/reference/services/SoftLayer_Dns_Domain_Registration/addNameserversToDomain/index.html +++ /dev/null @@ -1,296 +0,0 @@ - - - - - - - - - - - - - - - - addNameserversToDomain - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

addNameserversToDomain

-
-
-
-
-
- Classes - - SoftLayer_Dns_Domain_Registration - -
- Tags - - method - - sldn - - dns - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Dns_Domain_Registration::addNameserversToDomain -

- - -

- Adds nameservers to a domain. -

-

Description

- - The addNameserversToDomain method adds nameservers to a domain for a domain that already has nameservers assigned to it. This method does not create a nameserver; the nameserver must already exist. - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
nameserversstring[]Array of fully qualified name of the nameservers
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - boolean - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration/{SoftLayer_Dns_Domain_RegistrationID}/addNameserversToDomain'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Dns_Domain_Registration/deleteRegisteredNameserver/index.html b/reference/services/SoftLayer_Dns_Domain_Registration/deleteRegisteredNameserver/index.html deleted file mode 100644 index 8effbe905bd..00000000000 --- a/reference/services/SoftLayer_Dns_Domain_Registration/deleteRegisteredNameserver/index.html +++ /dev/null @@ -1,294 +0,0 @@ - - - - - - - - - - - - - - - - deleteRegisteredNameserver - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

deleteRegisteredNameserver

-
-
-
-
-
- Classes - - SoftLayer_Dns_Domain_Registration - -
- Tags - - method - - sldn - - dns - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Dns_Domain_Registration::deleteRegisteredNameserver -

- - -

- Deletes a registered nameserver. -

-

Description

- - The deleteRegisteredNameserver method deletes a nameserver that was registered, provided it is not currently serving a domain - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
nameserverstringThe fully qualified name of the nameserver
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - boolean - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration/{SoftLayer_Dns_Domain_RegistrationID}/deleteRegisteredNameserver'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Dns_Domain_Registration/getAccount/index.html b/reference/services/SoftLayer_Dns_Domain_Registration/getAccount/index.html deleted file mode 100644 index 6a95991c629..00000000000 --- a/reference/services/SoftLayer_Dns_Domain_Registration/getAccount/index.html +++ /dev/null @@ -1,275 +0,0 @@ - - - - - - - - - - - - - - - - getAccount - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getAccount

-
-
-
-
-
- Classes - - SoftLayer_Dns_Domain_Registration - -
- Tags - - method - - sldn - - dns - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Dns_Domain_Registration::getAccount -

- - -

- -

-

Description

- - The SoftLayer customer account that the domain is registered to. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration/{SoftLayer_Dns_Domain_RegistrationID}/getAccount'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Dns_Domain_Registration/getAuthenticationCode/index.html b/reference/services/SoftLayer_Dns_Domain_Registration/getAuthenticationCode/index.html deleted file mode 100644 index 0839c63818c..00000000000 --- a/reference/services/SoftLayer_Dns_Domain_Registration/getAuthenticationCode/index.html +++ /dev/null @@ -1,273 +0,0 @@ - - - - - - - - - - - - - - - - getAuthenticationCode - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getAuthenticationCode

-
-
-
-
-
- Classes - - SoftLayer_Dns_Domain_Registration - -
- Tags - - method - - sldn - - dns - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Dns_Domain_Registration::getAuthenticationCode -

- - -

- Get the authentication code for a domain. -

-

Description

- - The getAuthenticationCode method retrieves the authentication code for the domain. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - string - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration/{SoftLayer_Dns_Domain_RegistrationID}/getAuthenticationCode'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Dns_Domain_Registration/getDomainInformation/index.html b/reference/services/SoftLayer_Dns_Domain_Registration/getDomainInformation/index.html deleted file mode 100644 index 773f2c0a1ad..00000000000 --- a/reference/services/SoftLayer_Dns_Domain_Registration/getDomainInformation/index.html +++ /dev/null @@ -1,273 +0,0 @@ - - - - - - - - - - - - - - - - getDomainInformation - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getDomainInformation

-
-
-
-
-
- Classes - - SoftLayer_Dns_Domain_Registration - -
- Tags - - method - - sldn - - dns - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Dns_Domain_Registration::getDomainInformation -

- - -

- Retrieve all domain information. -

-

Description

- - The getDomainInformation method retrieves all the information for a domain. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration/{SoftLayer_Dns_Domain_RegistrationID}/getDomainInformation'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Dns_Domain_Registration/getDomainNameservers/index.html b/reference/services/SoftLayer_Dns_Domain_Registration/getDomainNameservers/index.html deleted file mode 100644 index 4e11446efe2..00000000000 --- a/reference/services/SoftLayer_Dns_Domain_Registration/getDomainNameservers/index.html +++ /dev/null @@ -1,275 +0,0 @@ - - - - - - - - - - - - - - - - getDomainNameservers - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getDomainNameservers

-
-
-
-
-
- Classes - - SoftLayer_Dns_Domain_Registration - -
- Tags - - method - - sldn - - dns - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Dns_Domain_Registration::getDomainNameservers -

- - -

- Retrieve domain nameservers. -

-

Description

- - The getDomainNameservers method retrieve nameservers information for domain. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration/{SoftLayer_Dns_Domain_RegistrationID}/getDomainNameservers'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Dns_Domain_Registration/getDomainRegistrationStatus/index.html b/reference/services/SoftLayer_Dns_Domain_Registration/getDomainRegistrationStatus/index.html deleted file mode 100644 index 9165bb48109..00000000000 --- a/reference/services/SoftLayer_Dns_Domain_Registration/getDomainRegistrationStatus/index.html +++ /dev/null @@ -1,275 +0,0 @@ - - - - - - - - - - - - - - - - getDomainRegistrationStatus - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getDomainRegistrationStatus

-
-
-
-
-
- Classes - - SoftLayer_Dns_Domain_Registration - -
- Tags - - method - - sldn - - dns - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Dns_Domain_Registration::getDomainRegistrationStatus -

- - -

- -

-

Description

- - The domain registration status. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration/{SoftLayer_Dns_Domain_RegistrationID}/getDomainRegistrationStatus'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Dns_Domain_Registration/getExtendedAttributes/index.html b/reference/services/SoftLayer_Dns_Domain_Registration/getExtendedAttributes/index.html deleted file mode 100644 index 18fc5858f99..00000000000 --- a/reference/services/SoftLayer_Dns_Domain_Registration/getExtendedAttributes/index.html +++ /dev/null @@ -1,294 +0,0 @@ - - - - - - - - - - - - - - - - getExtendedAttributes - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getExtendedAttributes

-
-
-
-
-
- Classes - - SoftLayer_Dns_Domain_Registration - -
- Tags - - method - - sldn - - dns - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Dns_Domain_Registration::getExtendedAttributes -

- - -

- Retrieves extended attributes. -

-

Description

- - The getExtendedAttributes method determines if a country code top level domain requires extended attributes. - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
domainNamestringThe domain name (i.e. example.us).
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration/getExtendedAttributes'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Dns_Domain_Registration/getObject/index.html b/reference/services/SoftLayer_Dns_Domain_Registration/getObject/index.html deleted file mode 100644 index f7bc90eb04e..00000000000 --- a/reference/services/SoftLayer_Dns_Domain_Registration/getObject/index.html +++ /dev/null @@ -1,292 +0,0 @@ - - - - - - - - - - - - - - - - getObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getObject

-
-
-
-
-
- Classes - - SoftLayer_Dns_Domain_Registration - -
- Tags - - method - - sldn - - dns - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Dns_Domain_Registration::getObject -

- - -

- Retrieve a SoftLayer_Dns_Domain_Registration record. -

-

Description

- - getObject retrieves the SoftLayer_Dns_Domain_Registration object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Dns_Domain_Registration service. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - -

Error Handling

-
    - - -
  • Throw the error “Unable to find object with id of {id}.” if the given initialization parameter has an invalid id field.
  • - - - - - -
  • Throw the error “Access Denied.” if the given initialization parameter id field is not the account id of the user making the API call.
  • - - - - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration/{SoftLayer_Dns_Domain_RegistrationID}/getObject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Dns_Domain_Registration/getRegisteredNameserver/index.html b/reference/services/SoftLayer_Dns_Domain_Registration/getRegisteredNameserver/index.html deleted file mode 100644 index 4795aac7f9e..00000000000 --- a/reference/services/SoftLayer_Dns_Domain_Registration/getRegisteredNameserver/index.html +++ /dev/null @@ -1,273 +0,0 @@ - - - - - - - - - - - - - - - - getRegisteredNameserver - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getRegisteredNameserver

-
-
-
-
-
- Classes - - SoftLayer_Dns_Domain_Registration - -
- Tags - - method - - sldn - - dns - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Dns_Domain_Registration::getRegisteredNameserver -

- - -

- Retrieves a registered nameserver. -

-

Description

- - The getRegisteredNameserver method retrieves registered nameservers. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration/{SoftLayer_Dns_Domain_RegistrationID}/getRegisteredNameserver'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Dns_Domain_Registration/getRegistrantVerificationStatus/index.html b/reference/services/SoftLayer_Dns_Domain_Registration/getRegistrantVerificationStatus/index.html deleted file mode 100644 index 6b1846398ca..00000000000 --- a/reference/services/SoftLayer_Dns_Domain_Registration/getRegistrantVerificationStatus/index.html +++ /dev/null @@ -1,275 +0,0 @@ - - - - - - - - - - - - - - - - getRegistrantVerificationStatus - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getRegistrantVerificationStatus

-
-
-
-
-
- Classes - - SoftLayer_Dns_Domain_Registration - -
- Tags - - method - - sldn - - dns - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Dns_Domain_Registration::getRegistrantVerificationStatus -

- - -

- -

-

Description

- - The registrant verification status. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration/{SoftLayer_Dns_Domain_RegistrationID}/getRegistrantVerificationStatus'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Dns_Domain_Registration/getRegistrantVerificationStatusDetail/index.html b/reference/services/SoftLayer_Dns_Domain_Registration/getRegistrantVerificationStatusDetail/index.html deleted file mode 100644 index b9922fa2cb4..00000000000 --- a/reference/services/SoftLayer_Dns_Domain_Registration/getRegistrantVerificationStatusDetail/index.html +++ /dev/null @@ -1,273 +0,0 @@ - - - - - - - - - - - - - - - - getRegistrantVerificationStatusDetail - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getRegistrantVerificationStatusDetail

-
-
-
-
-
- Classes - - SoftLayer_Dns_Domain_Registration - -
- Tags - - method - - sldn - - dns - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Dns_Domain_Registration::getRegistrantVerificationStatusDetail -

- - -

- Retrieves registrant verification status. -

-

Description

- - When a domain is registered or transferred, or when the registrant contact information is changed, the registrant must reply to an email requesting them to confirm that the submitted contact information is correct. This method returns the current state of the verification request. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration/{SoftLayer_Dns_Domain_RegistrationID}/getRegistrantVerificationStatusDetail'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Dns_Domain_Registration/getServiceProvider/index.html b/reference/services/SoftLayer_Dns_Domain_Registration/getServiceProvider/index.html deleted file mode 100644 index 9688459b6ff..00000000000 --- a/reference/services/SoftLayer_Dns_Domain_Registration/getServiceProvider/index.html +++ /dev/null @@ -1,275 +0,0 @@ - - - - - - - - - - - - - - - - getServiceProvider - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getServiceProvider

-
-
-
-
-
- Classes - - SoftLayer_Dns_Domain_Registration - -
- Tags - - method - - sldn - - dns - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Dns_Domain_Registration::getServiceProvider -

- - -

- -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration/{SoftLayer_Dns_Domain_RegistrationID}/getServiceProvider'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Dns_Domain_Registration/getTransferInformation/index.html b/reference/services/SoftLayer_Dns_Domain_Registration/getTransferInformation/index.html deleted file mode 100644 index e5929166964..00000000000 --- a/reference/services/SoftLayer_Dns_Domain_Registration/getTransferInformation/index.html +++ /dev/null @@ -1,292 +0,0 @@ - - - - - - - - - - - - - - - - getTransferInformation - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getTransferInformation

-
-
-
-
-
- Classes - - SoftLayer_Dns_Domain_Registration - -
- Tags - - method - - sldn - - dns - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Dns_Domain_Registration::getTransferInformation -

- - -

- Retrieve domain transfer information. -

-

Description

- - The getTransferInformation method checks to see if the domain can be transferred and also can be used to check the status of the last transfer request. - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
domainNamestringDomain Name
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration/getTransferInformation'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Dns_Domain_Registration/index.html b/reference/services/SoftLayer_Dns_Domain_Registration/index.html deleted file mode 100644 index 50601ec8292..00000000000 --- a/reference/services/SoftLayer_Dns_Domain_Registration/index.html +++ /dev/null @@ -1,468 +0,0 @@ - - - - - - - - - - - - - SoftLayer_Dns_Domain_Registration - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Dns_Domain_Registration

-
-
-
-
-
- Classes - - SoftLayer_Dns_Domain_Registration - -
- Tags - - service - - sldn - - dns - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Dns_Domain_Registration

- - -
- -
- - -

Description

- -
Deprecated
- - [DEPRECATED] Registration and management of domain names and domain related services. - -
-

Methods

-
-
-
- -
-
-
-
- - - - - -
-

addNameserversToDomain

- -

Adds nameservers to a domain.

- -
- - - -
-

deleteRegisteredNameserver

- -

Deletes a registered nameserver.

- -
- - - -
-

getAccount

- -

The SoftLayer customer account that the domain is registered to.

- -
- - - -
-

getAuthenticationCode

- -

Get the authentication code for a domain.

- -
- - - -
-

getDomainInformation

- -

Retrieve all domain information.

- -
- - - -
-

getDomainNameservers

- -

Retrieve domain nameservers.

- -
- - - -
-

getDomainRegistrationStatus

- -

The domain registration status.

- -
- - - -
-

getExtendedAttributes

- -

Retrieves extended attributes.

- -
- - - -
-

getObject

- -

Retrieve a SoftLayer_Dns_Domain_Registration record.

- -
- - - -
-

getRegisteredNameserver

- -

Retrieves a registered nameserver.

- -
- - - -
-

getRegistrantVerificationStatus

- -

The registrant verification status.

- -
- - - -
-

getRegistrantVerificationStatusDetail

- -

Retrieves registrant verification status.

- -
- - - -
-

getServiceProvider

- -

- -
- - - -
-

getTransferInformation

- -

Retrieve domain transfer information.

- -
- - - -
-

lockDomain

- -

Locks a domain.

- -
- - - -
-

lookupDomain

- -

Lookup available domains and suggests other similar domain names

- -
- - - -
-

modifyContact

- -

Modifies contact information for a domain.

- -
- - - -
-

modifyRegisteredNameserver

- -

Modifies a registered nameserver.

- -
- - - -
-

registerNameserver

- -

Creates a nameserver.

- -
- - - -
-

removeNameserversFromDomain

- -

Removes nameservers from a domain.

- -
- - - -
-

sendAuthenticationCode

- -

Sends the authentication code

- -
- - - -
-

sendRegistrantVerificationEmail

- -

Sends verification email to the registrant.

- -
- - - -
-

sendTransferApprovalEmail

- -

Resends a transfer approval email message.

- -
- - - -
-

setAuthenticationCode

- -

Sets the authentication code for a domain.

- -
- - - -
-

unlockDomain

- -

Unlocks a domain.

- -
- - -
-
- -
- -
-
- - - -
- - - - - - - diff --git a/reference/services/SoftLayer_Dns_Domain_Registration/lockDomain/index.html b/reference/services/SoftLayer_Dns_Domain_Registration/lockDomain/index.html deleted file mode 100644 index 405d1990ceb..00000000000 --- a/reference/services/SoftLayer_Dns_Domain_Registration/lockDomain/index.html +++ /dev/null @@ -1,277 +0,0 @@ - - - - - - - - - - - - - - - - lockDomain - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

lockDomain

-
-
-
-
-
- Classes - - SoftLayer_Dns_Domain_Registration - -
- Tags - - method - - sldn - - dns - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Dns_Domain_Registration::lockDomain -

- - -

- Locks a domain. -

-

Description

- -

The lockDomain method locks a domain to prevent unauthorized, unwanted or accidental changes to the domain name. When set, the following actions are prohibited:

-
    -
  • Transferring of the domain name
  • -
  • Deletion of the domain name
  • -
- -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - boolean - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration/{SoftLayer_Dns_Domain_RegistrationID}/lockDomain'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Dns_Domain_Registration/lookupDomain/index.html b/reference/services/SoftLayer_Dns_Domain_Registration/lookupDomain/index.html deleted file mode 100644 index 02ebf3b8c12..00000000000 --- a/reference/services/SoftLayer_Dns_Domain_Registration/lookupDomain/index.html +++ /dev/null @@ -1,294 +0,0 @@ - - - - - - - - - - - - - - - - lookupDomain - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

lookupDomain

-
-
-
-
-
- Classes - - SoftLayer_Dns_Domain_Registration - -
- Tags - - method - - sldn - - dns - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Dns_Domain_Registration::lookupDomain -

- - -

- Lookup available domains and suggests other similar domain names -

-

Description

- - The lookupDomain method checks whether a specified domain name is available for registration in TLD’s, and suggests other similar domain names, and checks whether they are available as well. - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
domainNamestringThe domain name (i.e. example.com).
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration/lookupDomain'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Dns_Domain_Registration/modifyContact/index.html b/reference/services/SoftLayer_Dns_Domain_Registration/modifyContact/index.html deleted file mode 100644 index 51c621f4c27..00000000000 --- a/reference/services/SoftLayer_Dns_Domain_Registration/modifyContact/index.html +++ /dev/null @@ -1,295 +0,0 @@ - - - - - - - - - - - - - - - - modifyContact - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

modifyContact

-
-
-
-
-
- Classes - - SoftLayer_Dns_Domain_Registration - -
- Tags - - method - - sldn - - dns - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Dns_Domain_Registration::modifyContact -

- - -

- Modifies contact information for a domain. -

-

Description

- - The modifyContact method modifies contact information (admin, billing, owner, technical) for a domain. - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
contactSoftLayer_Container_Dns_Domain_Registration_ContactContact information
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - boolean - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [SoftLayer_Container_Dns_Domain_Registration_Contact]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration/{SoftLayer_Dns_Domain_RegistrationID}/modifyContact'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Dns_Domain_Registration/modifyRegisteredNameserver/index.html b/reference/services/SoftLayer_Dns_Domain_Registration/modifyRegisteredNameserver/index.html deleted file mode 100644 index ec8ae825444..00000000000 --- a/reference/services/SoftLayer_Dns_Domain_Registration/modifyRegisteredNameserver/index.html +++ /dev/null @@ -1,314 +0,0 @@ - - - - - - - - - - - - - - - - modifyRegisteredNameserver - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

modifyRegisteredNameserver

-
-
-
-
-
- Classes - - SoftLayer_Dns_Domain_Registration - -
- Tags - - method - - sldn - - dns - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Dns_Domain_Registration::modifyRegisteredNameserver -

- - -

- Modifies a registered nameserver. -

-

Description

- - The modifyRegisteredNameserver method modifies a nameserver that was registered. - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
oldNameserverstringThe old, fully qualified domain name of the nameserver
newNameserverstringThe new, fully qualified domain name for the nameserver
ipAddressstringThe IP Address of the nameserver
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - boolean - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string, string, string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration/{SoftLayer_Dns_Domain_RegistrationID}/modifyRegisteredNameserver'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Dns_Domain_Registration/registerNameserver/index.html b/reference/services/SoftLayer_Dns_Domain_Registration/registerNameserver/index.html deleted file mode 100644 index 6e89237419e..00000000000 --- a/reference/services/SoftLayer_Dns_Domain_Registration/registerNameserver/index.html +++ /dev/null @@ -1,304 +0,0 @@ - - - - - - - - - - - - - - - - registerNameserver - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

registerNameserver

-
-
-
-
-
- Classes - - SoftLayer_Dns_Domain_Registration - -
- Tags - - method - - sldn - - dns - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Dns_Domain_Registration::registerNameserver -

- - -

- Creates a nameserver. -

-

Description

- - The registerNameserver method creates a nameserver for the domain. - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
nameserverstringThe fully qualified name of the nameserver
ipAddressstringThe IP Address of the nameserver
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - boolean - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string, string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration/{SoftLayer_Dns_Domain_RegistrationID}/registerNameserver'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Dns_Domain_Registration/removeNameserversFromDomain/index.html b/reference/services/SoftLayer_Dns_Domain_Registration/removeNameserversFromDomain/index.html deleted file mode 100644 index ce74def0174..00000000000 --- a/reference/services/SoftLayer_Dns_Domain_Registration/removeNameserversFromDomain/index.html +++ /dev/null @@ -1,296 +0,0 @@ - - - - - - - - - - - - - - - - removeNameserversFromDomain - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

removeNameserversFromDomain

-
-
-
-
-
- Classes - - SoftLayer_Dns_Domain_Registration - -
- Tags - - method - - sldn - - dns - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Dns_Domain_Registration::removeNameserversFromDomain -

- - -

- Removes nameservers from a domain. -

-

Description

- - The removeNameserversFromDomain method removes nameservers from a domain for a domain that already has nameservers assigned to it. - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
nameserversstring[]Array of fully qualified name of the nameservers
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - boolean - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration/{SoftLayer_Dns_Domain_RegistrationID}/removeNameserversFromDomain'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Dns_Domain_Registration/sendAuthenticationCode/index.html b/reference/services/SoftLayer_Dns_Domain_Registration/sendAuthenticationCode/index.html deleted file mode 100644 index ac67120b1ef..00000000000 --- a/reference/services/SoftLayer_Dns_Domain_Registration/sendAuthenticationCode/index.html +++ /dev/null @@ -1,273 +0,0 @@ - - - - - - - - - - - - - - - - sendAuthenticationCode - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

sendAuthenticationCode

-
-
-
-
-
- Classes - - SoftLayer_Dns_Domain_Registration - -
- Tags - - method - - sldn - - dns - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Dns_Domain_Registration::sendAuthenticationCode -

- - -

- Sends the authentication code -

-

Description

- - The sendAuthenticationCode method sends the authentication code to the administrative contact for the domain. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - boolean - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration/{SoftLayer_Dns_Domain_RegistrationID}/sendAuthenticationCode'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Dns_Domain_Registration/sendRegistrantVerificationEmail/index.html b/reference/services/SoftLayer_Dns_Domain_Registration/sendRegistrantVerificationEmail/index.html deleted file mode 100644 index 51f921d4c52..00000000000 --- a/reference/services/SoftLayer_Dns_Domain_Registration/sendRegistrantVerificationEmail/index.html +++ /dev/null @@ -1,273 +0,0 @@ - - - - - - - - - - - - - - - - sendRegistrantVerificationEmail - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

sendRegistrantVerificationEmail

-
-
-
-
-
- Classes - - SoftLayer_Dns_Domain_Registration - -
- Tags - - method - - sldn - - dns - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Dns_Domain_Registration::sendRegistrantVerificationEmail -

- - -

- Sends verification email to the registrant. -

-

Description

- - When a domain is registered or transferred, or when the registrant contact information is changed, the registrant must reply to an email requesting them to confirm that the submitted contact information is correct. This method sends the verification email to the registrant. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - boolean - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration/{SoftLayer_Dns_Domain_RegistrationID}/sendRegistrantVerificationEmail'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Dns_Domain_Registration/sendTransferApprovalEmail/index.html b/reference/services/SoftLayer_Dns_Domain_Registration/sendTransferApprovalEmail/index.html deleted file mode 100644 index adaf32356ca..00000000000 --- a/reference/services/SoftLayer_Dns_Domain_Registration/sendTransferApprovalEmail/index.html +++ /dev/null @@ -1,273 +0,0 @@ - - - - - - - - - - - - - - - - sendTransferApprovalEmail - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

sendTransferApprovalEmail

-
-
-
-
-
- Classes - - SoftLayer_Dns_Domain_Registration - -
- Tags - - method - - sldn - - dns - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Dns_Domain_Registration::sendTransferApprovalEmail -

- - -

- Resends a transfer approval email message. -

-

Description

- - The sendTransferApprovalEmail method resends a transfer approval email message for a transfer that is in ‘pending owner approval’ state, to the admin contact listed for the domain at the time that the transfer request was submitted - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - boolean - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration/{SoftLayer_Dns_Domain_RegistrationID}/sendTransferApprovalEmail'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Dns_Domain_Registration/setAuthenticationCode/index.html b/reference/services/SoftLayer_Dns_Domain_Registration/setAuthenticationCode/index.html deleted file mode 100644 index a53b74341b6..00000000000 --- a/reference/services/SoftLayer_Dns_Domain_Registration/setAuthenticationCode/index.html +++ /dev/null @@ -1,294 +0,0 @@ - - - - - - - - - - - - - - - - setAuthenticationCode - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

setAuthenticationCode

-
-
-
-
-
- Classes - - SoftLayer_Dns_Domain_Registration - -
- Tags - - method - - sldn - - dns - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Dns_Domain_Registration::setAuthenticationCode -

- - -

- Sets the authentication code for a domain. -

-

Description

- - The setAuthenticationCode method sets the authentication code for the domain. The authentication code is a transfer key and provides an extra level of security, safeguarding domain names from unauthorized transfers. - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
authenticationCodestringAuthentication Code
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - boolean - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration/{SoftLayer_Dns_Domain_RegistrationID}/setAuthenticationCode'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Dns_Domain_Registration/unlockDomain/index.html b/reference/services/SoftLayer_Dns_Domain_Registration/unlockDomain/index.html deleted file mode 100644 index 9747497ae91..00000000000 --- a/reference/services/SoftLayer_Dns_Domain_Registration/unlockDomain/index.html +++ /dev/null @@ -1,273 +0,0 @@ - - - - - - - - - - - - - - - - unlockDomain - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

unlockDomain

-
-
-
-
-
- Classes - - SoftLayer_Dns_Domain_Registration - -
- Tags - - method - - sldn - - dns - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Dns_Domain_Registration::unlockDomain -

- - -

- Unlocks a domain. -

-

Description

- - The unlockDomain method unlocks a domain - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - boolean - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration/{SoftLayer_Dns_Domain_RegistrationID}/unlockDomain'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status/getAllObjects/index.html b/reference/services/SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status/getAllObjects/index.html deleted file mode 100644 index 8c5bafce2fd..00000000000 --- a/reference/services/SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status/getAllObjects/index.html +++ /dev/null @@ -1,275 +0,0 @@ - - - - - - - - - - - - - - - - getAllObjects - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getAllObjects

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status::getAllObjects -

- - -

- -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status/getAllObjects'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status/getObject/index.html b/reference/services/SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status/getObject/index.html deleted file mode 100644 index a496bd1fbd9..00000000000 --- a/reference/services/SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status/getObject/index.html +++ /dev/null @@ -1,275 +0,0 @@ - - - - - - - - - - - - - - - - getObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getObject

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status::getObject -

- - -

- Retrieve a SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status record. -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status/{SoftLayer_Dns_Domain_Registration_Registrant_Verification_StatusID}/getObject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status/index.html b/reference/services/SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status/index.html deleted file mode 100644 index 22081395274..00000000000 --- a/reference/services/SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status/index.html +++ /dev/null @@ -1,261 +0,0 @@ - - - - - - - - - - - - - SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status

- - -
- -
- - -

Description

- -
Deprecated
- - - -
-

Methods

-
-
-
- -
-
-
-
- - - - - -
-

getAllObjects

- -

- -
- - - -
-

getObject

- -

Retrieve a SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status record.

- -
- - -
-
- -
- -
-
- - - -
- - - - - - - diff --git a/reference/services/SoftLayer_Dns_Domain_Registration_Status/getAllObjects/index.html b/reference/services/SoftLayer_Dns_Domain_Registration_Status/getAllObjects/index.html deleted file mode 100644 index 62c6c26a7b9..00000000000 --- a/reference/services/SoftLayer_Dns_Domain_Registration_Status/getAllObjects/index.html +++ /dev/null @@ -1,275 +0,0 @@ - - - - - - - - - - - - - - - - getAllObjects - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getAllObjects

-
-
-
-
-
- Classes - - SoftLayer_Dns_Domain_Registration_Status - -
- Tags - - method - - sldn - - dns - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Dns_Domain_Registration_Status::getAllObjects -

- - -

- -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration_Status/getAllObjects'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Dns_Domain_Registration_Status/getObject/index.html b/reference/services/SoftLayer_Dns_Domain_Registration_Status/getObject/index.html deleted file mode 100644 index 582540ab9ca..00000000000 --- a/reference/services/SoftLayer_Dns_Domain_Registration_Status/getObject/index.html +++ /dev/null @@ -1,275 +0,0 @@ - - - - - - - - - - - - - - - - getObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getObject

-
-
-
-
-
- Classes - - SoftLayer_Dns_Domain_Registration_Status - -
- Tags - - method - - sldn - - dns - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Dns_Domain_Registration_Status::getObject -

- - -

- Retrieve a SoftLayer_Dns_Domain_Registration_Status record. -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration_Status/{SoftLayer_Dns_Domain_Registration_StatusID}/getObject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Dns_Domain_Registration_Status/index.html b/reference/services/SoftLayer_Dns_Domain_Registration_Status/index.html deleted file mode 100644 index 47bc60f9385..00000000000 --- a/reference/services/SoftLayer_Dns_Domain_Registration_Status/index.html +++ /dev/null @@ -1,261 +0,0 @@ - - - - - - - - - - - - - SoftLayer_Dns_Domain_Registration_Status - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Dns_Domain_Registration_Status

-
-
-
-
-
- Classes - - SoftLayer_Dns_Domain_Registration_Status - -
- Tags - - service - - sldn - - dns - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Dns_Domain_Registration_Status

- - -
- -
- - -

Description

- -
Deprecated
- - - -
-

Methods

-
-
-
- -
-
-
-
- - - - - -
-

getAllObjects

- -

- -
- - - -
-

getObject

- -

Retrieve a SoftLayer_Dns_Domain_Registration_Status record.

- -
- - -
-
- -
- -
-
- - - -
- - - - - - - diff --git a/reference/services/SoftLayer_Hardware/getDownstreamNetworkHardwareWithIncidents/index.html b/reference/services/SoftLayer_Hardware/getDownstreamNetworkHardwareWithIncidents/index.html deleted file mode 100644 index cceb23f4b00..00000000000 --- a/reference/services/SoftLayer_Hardware/getDownstreamNetworkHardwareWithIncidents/index.html +++ /dev/null @@ -1,332 +0,0 @@ - - - - - - - - - - - - - - - - getDownstreamNetworkHardwareWithIncidents - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getDownstreamNetworkHardwareWithIncidents

-
-
-
-
-
- Classes - - SoftLayer_Hardware - -
- Tags - - method - - sldn - - hardware - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Hardware::getDownstreamNetworkHardwareWithIncidents -

- - -
Deprecated
- -

- -

-

Description

- - All network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. [DEPRECATED] - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Hardware/{SoftLayer_HardwareID}/getDownstreamNetworkHardwareWithIncidents'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Hardware/getNetworkStatusAttribute/index.html b/reference/services/SoftLayer_Hardware/getNetworkStatusAttribute/index.html deleted file mode 100644 index 496a67e6a57..00000000000 --- a/reference/services/SoftLayer_Hardware/getNetworkStatusAttribute/index.html +++ /dev/null @@ -1,328 +0,0 @@ - - - - - - - - - - - - - - - - getNetworkStatusAttribute - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getNetworkStatusAttribute

-
-
-
-
-
- Classes - - SoftLayer_Hardware - -
- Tags - - method - - sldn - - hardware - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Hardware::getNetworkStatusAttribute -

- - -
Deprecated
- -

- -

-

Description

- - The hardware’s related network status attribute. [DEPRECATED] - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Hardware/{SoftLayer_HardwareID}/getNetworkStatusAttribute'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Hardware/getStorageNetworkComponents/index.html b/reference/services/SoftLayer_Hardware/getStorageNetworkComponents/index.html deleted file mode 100644 index c68aaf1fd88..00000000000 --- a/reference/services/SoftLayer_Hardware/getStorageNetworkComponents/index.html +++ /dev/null @@ -1,332 +0,0 @@ - - - - - - - - - - - - - - - - getStorageNetworkComponents - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getStorageNetworkComponents

-
-
-
-
-
- Classes - - SoftLayer_Hardware - -
- Tags - - method - - sldn - - hardware - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Hardware::getStorageNetworkComponents -

- - -
Deprecated
- -

- -

-

Description

- - A piece of hardware’s private storage network components. [Deprecated] - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Hardware/{SoftLayer_HardwareID}/getStorageNetworkComponents'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Hardware_Component_Model/getMetricTrackingObject/index.html b/reference/services/SoftLayer_Hardware_Component_Model/getMetricTrackingObject/index.html deleted file mode 100644 index 1b16cfd9449..00000000000 --- a/reference/services/SoftLayer_Hardware_Component_Model/getMetricTrackingObject/index.html +++ /dev/null @@ -1,328 +0,0 @@ - - - - - - - - - - - - - - - - getMetricTrackingObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getMetricTrackingObject

-
-
-
-
-
- Classes - - SoftLayer_Hardware_Component_Model - -
- Tags - - method - - sldn - - hardware - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Hardware_Component_Model::getMetricTrackingObject -

- - -
Deprecated
- -

- -

-

Description

- - [DEPRECATED] - A hardware component models metric tracking object. This object records all periodic polled data available to this hardware componet model. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Hardware_Component_Model/{SoftLayer_Hardware_Component_ModelID}/getMetricTrackingObject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Hardware_Router/getBoundSubnets/index.html b/reference/services/SoftLayer_Hardware_Router/getBoundSubnets/index.html deleted file mode 100644 index 1a9789cdc40..00000000000 --- a/reference/services/SoftLayer_Hardware_Router/getBoundSubnets/index.html +++ /dev/null @@ -1,332 +0,0 @@ - - - - - - - - - - - - - - - - getBoundSubnets - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getBoundSubnets

-
-
-
-
-
- Classes - - SoftLayer_Hardware_Router - -
- Tags - - method - - sldn - - hardware - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Hardware_Router::getBoundSubnets -

- - -
Deprecated
- -

- -

-

Description

- - [DEPRECATED] Associated subnets for a router object. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getBoundSubnets'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Hardware_Router/getDownstreamNetworkHardwareWithIncidents/index.html b/reference/services/SoftLayer_Hardware_Router/getDownstreamNetworkHardwareWithIncidents/index.html deleted file mode 100644 index 29fee365c7b..00000000000 --- a/reference/services/SoftLayer_Hardware_Router/getDownstreamNetworkHardwareWithIncidents/index.html +++ /dev/null @@ -1,332 +0,0 @@ - - - - - - - - - - - - - - - - getDownstreamNetworkHardwareWithIncidents - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getDownstreamNetworkHardwareWithIncidents

-
-
-
-
-
- Classes - - SoftLayer_Hardware_Router - -
- Tags - - method - - sldn - - hardware - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Hardware_Router::getDownstreamNetworkHardwareWithIncidents -

- - -
Deprecated
- -

- -

-

Description

- - All network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. [DEPRECATED] - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getDownstreamNetworkHardwareWithIncidents'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Hardware_Router/getNetworkStatusAttribute/index.html b/reference/services/SoftLayer_Hardware_Router/getNetworkStatusAttribute/index.html deleted file mode 100644 index f1428ba16f6..00000000000 --- a/reference/services/SoftLayer_Hardware_Router/getNetworkStatusAttribute/index.html +++ /dev/null @@ -1,328 +0,0 @@ - - - - - - - - - - - - - - - - getNetworkStatusAttribute - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getNetworkStatusAttribute

-
-
-
-
-
- Classes - - SoftLayer_Hardware_Router - -
- Tags - - method - - sldn - - hardware - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Hardware_Router::getNetworkStatusAttribute -

- - -
Deprecated
- -

- -

-

Description

- - The hardware’s related network status attribute. [DEPRECATED] - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getNetworkStatusAttribute'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Hardware_Router/getStorageNetworkComponents/index.html b/reference/services/SoftLayer_Hardware_Router/getStorageNetworkComponents/index.html deleted file mode 100644 index 8cd7103139f..00000000000 --- a/reference/services/SoftLayer_Hardware_Router/getStorageNetworkComponents/index.html +++ /dev/null @@ -1,332 +0,0 @@ - - - - - - - - - - - - - - - - getStorageNetworkComponents - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getStorageNetworkComponents

-
-
-
-
-
- Classes - - SoftLayer_Hardware_Router - -
- Tags - - method - - sldn - - hardware - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Hardware_Router::getStorageNetworkComponents -

- - -
Deprecated
- -

- -

-

Description

- - A piece of hardware’s private storage network components. [Deprecated] - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getStorageNetworkComponents'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Hardware_SecurityModule/getBandwidthImage/index.html b/reference/services/SoftLayer_Hardware_SecurityModule/getBandwidthImage/index.html deleted file mode 100644 index b062b638955..00000000000 --- a/reference/services/SoftLayer_Hardware_SecurityModule/getBandwidthImage/index.html +++ /dev/null @@ -1,385 +0,0 @@ - - - - - - - - - - - - - - - - getBandwidthImage - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getBandwidthImage

-
-
-
-
-
- Classes - - SoftLayer_Hardware_SecurityModule - -
- Tags - - method - - sldn - - hardware - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Hardware_SecurityModule::getBandwidthImage -

- - -

- Retrieve a bandwidth image and textual description of that image for this server. -

-

Description

- - Use this method when needing a bandwidth image for a single server. It will gather the correct input parameters for the generic graphing utility automatically based on the snapshot specified. Use the $draw flag to suppress the generation of the actual binary PNG image. - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
networkTypeenum
  • public
  • private
snapshotRangeenum
  • day
  • week
  • 30day
  • previous_calendar_month
  • current_calendar_month
  • current_billing_cycle
  • previous_billing_cycle
  • specified_day
  • specified_range
drawbooleanTRUE to generate binary image otherwise just return text
dateSpecifieddateTimeInclude this parameter when snapshot is ‘specified_day’ or ‘specified_range’. Needs to be formatted as: ‘MM/DD/YYYY’
dateSpecifiedEnddateTimeInclude this parameter when snapshotRange is ‘specified_range’. Also formatted as ‘MM/DD/YYYY’.
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [enum, enum, boolean, dateTime, dateTime]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getBandwidthImage'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Hardware_SecurityModule/getDownstreamNetworkHardwareWithIncidents/index.html b/reference/services/SoftLayer_Hardware_SecurityModule/getDownstreamNetworkHardwareWithIncidents/index.html deleted file mode 100644 index c710d573796..00000000000 --- a/reference/services/SoftLayer_Hardware_SecurityModule/getDownstreamNetworkHardwareWithIncidents/index.html +++ /dev/null @@ -1,332 +0,0 @@ - - - - - - - - - - - - - - - - getDownstreamNetworkHardwareWithIncidents - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getDownstreamNetworkHardwareWithIncidents

-
-
-
-
-
- Classes - - SoftLayer_Hardware_SecurityModule - -
- Tags - - method - - sldn - - hardware - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Hardware_SecurityModule::getDownstreamNetworkHardwareWithIncidents -

- - -
Deprecated
- -

- -

-

Description

- - All network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. [DEPRECATED] - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getDownstreamNetworkHardwareWithIncidents'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Hardware_SecurityModule/getIsNfsCapable/index.html b/reference/services/SoftLayer_Hardware_SecurityModule/getIsNfsCapable/index.html deleted file mode 100644 index 44bd9b3f246..00000000000 --- a/reference/services/SoftLayer_Hardware_SecurityModule/getIsNfsCapable/index.html +++ /dev/null @@ -1,323 +0,0 @@ - - - - - - - - - - - - - - - - getIsNfsCapable - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getIsNfsCapable

-
-
-
-
-
- Classes - - SoftLayer_Hardware_SecurityModule - -
- Tags - - method - - sldn - - hardware - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Hardware_SecurityModule::getIsNfsCapable -

- - -

- -

-

Description

- - A server that has nfs capable drive. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

-
  • - - - - string - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getIsNfsCapable'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkStatusAttribute/index.html b/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkStatusAttribute/index.html deleted file mode 100644 index 73d9e8ab79a..00000000000 --- a/reference/services/SoftLayer_Hardware_SecurityModule/getNetworkStatusAttribute/index.html +++ /dev/null @@ -1,328 +0,0 @@ - - - - - - - - - - - - - - - - getNetworkStatusAttribute - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getNetworkStatusAttribute

-
-
-
-
-
- Classes - - SoftLayer_Hardware_SecurityModule - -
- Tags - - method - - sldn - - hardware - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Hardware_SecurityModule::getNetworkStatusAttribute -

- - -
Deprecated
- -

- -

-

Description

- - The hardware’s related network status attribute. [DEPRECATED] - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getNetworkStatusAttribute'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Hardware_SecurityModule/getPrivateBandwidthGraphImage/index.html b/reference/services/SoftLayer_Hardware_SecurityModule/getPrivateBandwidthGraphImage/index.html deleted file mode 100644 index 823c573b8c8..00000000000 --- a/reference/services/SoftLayer_Hardware_SecurityModule/getPrivateBandwidthGraphImage/index.html +++ /dev/null @@ -1,378 +0,0 @@ - - - - - - - - - - - - - - - - getPrivateBandwidthGraphImage - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getPrivateBandwidthGraphImage

-
-
-
-
-
- Classes - - SoftLayer_Hardware_SecurityModule - -
- Tags - - method - - sldn - - hardware - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Hardware_SecurityModule::getPrivateBandwidthGraphImage -

- - -

- Retrieve a graph of a server’s private network usage. -

-

Description

- - Retrieve a graph of a server’s private network bandwidth usage over the specified time frame. If no time frame is specified then getPublicBandwidthGraphImage retrieves the last 24 hours of public bandwidth usage. getPublicBandwidthGraphImage returns a PNG image - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
startTimestringThe starting point to retrieve bandwidth data from, specified as a dateTime.
endTimestringThe end point to retrieve bandwidth data to, specified as a dateTime.
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - base64Binary - -
- -

Error Handling

-
    - - -
  • Throw the exception “Unable to retrieve the public bandwidth graph for server {id}.” if the API is unable to retrieve a valid PNG bandwidth graph image.
  • - - - - - -
  • Throw the exception “The start time {startTime} is not a readable date format.” if an invalid start time is passed to getPublicBandwidthGraphImage.
  • - - - - - -
  • Throw the exception “The end time {endTime} is not a readable date format.” if an invalid end time is passed to getPublicBandwidthGraphImage.
  • - - - - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string, string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getPrivateBandwidthGraphImage'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Hardware_SecurityModule/getPrivateVlanByIpAddress/index.html b/reference/services/SoftLayer_Hardware_SecurityModule/getPrivateVlanByIpAddress/index.html deleted file mode 100644 index c8a01aad78b..00000000000 --- a/reference/services/SoftLayer_Hardware_SecurityModule/getPrivateVlanByIpAddress/index.html +++ /dev/null @@ -1,369 +0,0 @@ - - - - - - - - - - - - - - - - getPrivateVlanByIpAddress - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getPrivateVlanByIpAddress

-
-
-
-
-
- Classes - - SoftLayer_Hardware_SecurityModule - -
- Tags - - method - - sldn - - hardware - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Hardware_SecurityModule::getPrivateVlanByIpAddress -

- - -
Deprecated
- -

- Retrieve a backend network VLAN by searching for an IP address. -

-

Description

- - *** DEPRECATED *** -Retrieve a backend network VLAN by searching for an IP address - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
ipAddressstringThe server’s IP address you are searching for.
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - -

Error Handling

-
    - - -
  • Throw the exception “You must provide a valid IP address.” if an invalid IPV4 IP address was provided.
  • - - - - - -
  • Throw the exception “Unable to find a subnet.” if there is no subnet for the IP address provided.
  • - - - - - -
  • Throw the exception “Unable to find a valid network component for this IP address.” if a network component with the primary IP address the same as the one provided could not be found.
  • - - - - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Hardware_SecurityModule/getPrivateVlanByIpAddress'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Hardware_SecurityModule/getPublicBandwidthGraphImage/index.html b/reference/services/SoftLayer_Hardware_SecurityModule/getPublicBandwidthGraphImage/index.html deleted file mode 100644 index 88561d3cd8c..00000000000 --- a/reference/services/SoftLayer_Hardware_SecurityModule/getPublicBandwidthGraphImage/index.html +++ /dev/null @@ -1,378 +0,0 @@ - - - - - - - - - - - - - - - - getPublicBandwidthGraphImage - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getPublicBandwidthGraphImage

-
-
-
-
-
- Classes - - SoftLayer_Hardware_SecurityModule - -
- Tags - - method - - sldn - - hardware - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Hardware_SecurityModule::getPublicBandwidthGraphImage -

- - -

- Retrieve a graph of a server’s public network usage. -

-

Description

- - Retrieve a graph of a server’s public network bandwidth usage over the specified time frame. If no time frame is specified then getPublicBandwidthGraphImage retrieves the last 24 hours of public bandwidth usage. getPublicBandwidthGraphImage returns a PNG image measuring 827 pixels by 293 pixels. THIS METHOD GENERATES GRAPHS BASED ON THE NEW DATA WAREHOUSE REPOSITORY. - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
startTimedateTimeThe starting point to retrieve bandwidth data from, specified as a dateTime.
endTimedateTimeThe end point to retrieve bandwidth data to, specified as a dateTime.
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - base64Binary - -
- -

Error Handling

-
    - - -
  • Throw the exception “Unable to retrieve the public bandwidth graph for server {id}.” if the API is unable to retrieve a valid PNG bandwidth graph image.
  • - - - - - -
  • Throw the exception “The start time {startTime} is not a readable date format.” if an invalid start time is passed to getPublicBandwidthGraphImage.
  • - - - - - -
  • Throw the exception “The end time {endTime} is not a readable date format.” if an invalid end time is passed to getPublicBandwidthGraphImage.
  • - - - - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [dateTime, dateTime]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getPublicBandwidthGraphImage'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Hardware_SecurityModule/getStorageNetworkComponents/index.html b/reference/services/SoftLayer_Hardware_SecurityModule/getStorageNetworkComponents/index.html deleted file mode 100644 index b5b31afceb9..00000000000 --- a/reference/services/SoftLayer_Hardware_SecurityModule/getStorageNetworkComponents/index.html +++ /dev/null @@ -1,332 +0,0 @@ - - - - - - - - - - - - - - - - getStorageNetworkComponents - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getStorageNetworkComponents

-
-
-
-
-
- Classes - - SoftLayer_Hardware_SecurityModule - -
- Tags - - method - - sldn - - hardware - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Hardware_SecurityModule::getStorageNetworkComponents -

- - -
Deprecated
- -

- -

-

Description

- - A piece of hardware’s private storage network components. [Deprecated] - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getStorageNetworkComponents'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Hardware_SecurityModule750/getBandwidthImage/index.html b/reference/services/SoftLayer_Hardware_SecurityModule750/getBandwidthImage/index.html deleted file mode 100644 index d57c5ea6412..00000000000 --- a/reference/services/SoftLayer_Hardware_SecurityModule750/getBandwidthImage/index.html +++ /dev/null @@ -1,385 +0,0 @@ - - - - - - - - - - - - - - - - getBandwidthImage - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getBandwidthImage

-
-
-
-
-
- Classes - - SoftLayer_Hardware_SecurityModule750 - -
- Tags - - method - - sldn - - hardware - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Hardware_SecurityModule750::getBandwidthImage -

- - -

- Retrieve a bandwidth image and textual description of that image for this server. -

-

Description

- - Use this method when needing a bandwidth image for a single server. It will gather the correct input parameters for the generic graphing utility automatically based on the snapshot specified. Use the $draw flag to suppress the generation of the actual binary PNG image. - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
networkTypeenum
  • public
  • private
snapshotRangeenum
  • day
  • week
  • 30day
  • previous_calendar_month
  • current_calendar_month
  • current_billing_cycle
  • previous_billing_cycle
  • specified_day
  • specified_range
drawbooleanTRUE to generate binary image otherwise just return text
dateSpecifieddateTimeInclude this parameter when snapshot is ‘specified_day’ or ‘specified_range’. Needs to be formatted as: ‘MM/DD/YYYY’
dateSpecifiedEnddateTimeInclude this parameter when snapshotRange is ‘specified_range’. Also formatted as ‘MM/DD/YYYY’.
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [enum, enum, boolean, dateTime, dateTime]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getBandwidthImage'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Hardware_SecurityModule750/getDownstreamNetworkHardwareWithIncidents/index.html b/reference/services/SoftLayer_Hardware_SecurityModule750/getDownstreamNetworkHardwareWithIncidents/index.html deleted file mode 100644 index 7d66bfca79b..00000000000 --- a/reference/services/SoftLayer_Hardware_SecurityModule750/getDownstreamNetworkHardwareWithIncidents/index.html +++ /dev/null @@ -1,332 +0,0 @@ - - - - - - - - - - - - - - - - getDownstreamNetworkHardwareWithIncidents - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getDownstreamNetworkHardwareWithIncidents

-
-
-
-
-
- Classes - - SoftLayer_Hardware_SecurityModule750 - -
- Tags - - method - - sldn - - hardware - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Hardware_SecurityModule750::getDownstreamNetworkHardwareWithIncidents -

- - -
Deprecated
- -

- -

-

Description

- - All network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. [DEPRECATED] - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getDownstreamNetworkHardwareWithIncidents'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Hardware_SecurityModule750/getIsNfsCapable/index.html b/reference/services/SoftLayer_Hardware_SecurityModule750/getIsNfsCapable/index.html deleted file mode 100644 index a2d48b17bf9..00000000000 --- a/reference/services/SoftLayer_Hardware_SecurityModule750/getIsNfsCapable/index.html +++ /dev/null @@ -1,323 +0,0 @@ - - - - - - - - - - - - - - - - getIsNfsCapable - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getIsNfsCapable

-
-
-
-
-
- Classes - - SoftLayer_Hardware_SecurityModule750 - -
- Tags - - method - - sldn - - hardware - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Hardware_SecurityModule750::getIsNfsCapable -

- - -

- -

-

Description

- - A server that has nfs capable drive. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

-
  • - - - - string - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getIsNfsCapable'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkStatusAttribute/index.html b/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkStatusAttribute/index.html deleted file mode 100644 index f3d73e32c59..00000000000 --- a/reference/services/SoftLayer_Hardware_SecurityModule750/getNetworkStatusAttribute/index.html +++ /dev/null @@ -1,328 +0,0 @@ - - - - - - - - - - - - - - - - getNetworkStatusAttribute - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getNetworkStatusAttribute

-
-
-
-
-
- Classes - - SoftLayer_Hardware_SecurityModule750 - -
- Tags - - method - - sldn - - hardware - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Hardware_SecurityModule750::getNetworkStatusAttribute -

- - -
Deprecated
- -

- -

-

Description

- - The hardware’s related network status attribute. [DEPRECATED] - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getNetworkStatusAttribute'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Hardware_SecurityModule750/getPrivateBandwidthGraphImage/index.html b/reference/services/SoftLayer_Hardware_SecurityModule750/getPrivateBandwidthGraphImage/index.html deleted file mode 100644 index 19712126652..00000000000 --- a/reference/services/SoftLayer_Hardware_SecurityModule750/getPrivateBandwidthGraphImage/index.html +++ /dev/null @@ -1,378 +0,0 @@ - - - - - - - - - - - - - - - - getPrivateBandwidthGraphImage - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getPrivateBandwidthGraphImage

-
-
-
-
-
- Classes - - SoftLayer_Hardware_SecurityModule750 - -
- Tags - - method - - sldn - - hardware - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Hardware_SecurityModule750::getPrivateBandwidthGraphImage -

- - -

- Retrieve a graph of a server’s private network usage. -

-

Description

- - Retrieve a graph of a server’s private network bandwidth usage over the specified time frame. If no time frame is specified then getPublicBandwidthGraphImage retrieves the last 24 hours of public bandwidth usage. getPublicBandwidthGraphImage returns a PNG image - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
startTimestringThe starting point to retrieve bandwidth data from, specified as a dateTime.
endTimestringThe end point to retrieve bandwidth data to, specified as a dateTime.
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - base64Binary - -
- -

Error Handling

-
    - - -
  • Throw the exception “Unable to retrieve the public bandwidth graph for server {id}.” if the API is unable to retrieve a valid PNG bandwidth graph image.
  • - - - - - -
  • Throw the exception “The start time {startTime} is not a readable date format.” if an invalid start time is passed to getPublicBandwidthGraphImage.
  • - - - - - -
  • Throw the exception “The end time {endTime} is not a readable date format.” if an invalid end time is passed to getPublicBandwidthGraphImage.
  • - - - - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string, string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getPrivateBandwidthGraphImage'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Hardware_SecurityModule750/getPrivateVlanByIpAddress/index.html b/reference/services/SoftLayer_Hardware_SecurityModule750/getPrivateVlanByIpAddress/index.html deleted file mode 100644 index b57d1aaeedb..00000000000 --- a/reference/services/SoftLayer_Hardware_SecurityModule750/getPrivateVlanByIpAddress/index.html +++ /dev/null @@ -1,369 +0,0 @@ - - - - - - - - - - - - - - - - getPrivateVlanByIpAddress - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getPrivateVlanByIpAddress

-
-
-
-
-
- Classes - - SoftLayer_Hardware_SecurityModule750 - -
- Tags - - method - - sldn - - hardware - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Hardware_SecurityModule750::getPrivateVlanByIpAddress -

- - -
Deprecated
- -

- Retrieve a backend network VLAN by searching for an IP address. -

-

Description

- - *** DEPRECATED *** -Retrieve a backend network VLAN by searching for an IP address - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
ipAddressstringThe server’s IP address you are searching for.
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - -

Error Handling

-
    - - -
  • Throw the exception “You must provide a valid IP address.” if an invalid IPV4 IP address was provided.
  • - - - - - -
  • Throw the exception “Unable to find a subnet.” if there is no subnet for the IP address provided.
  • - - - - - -
  • Throw the exception “Unable to find a valid network component for this IP address.” if a network component with the primary IP address the same as the one provided could not be found.
  • - - - - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Hardware_SecurityModule750/getPrivateVlanByIpAddress'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Hardware_SecurityModule750/getPublicBandwidthGraphImage/index.html b/reference/services/SoftLayer_Hardware_SecurityModule750/getPublicBandwidthGraphImage/index.html deleted file mode 100644 index 9e79c00d687..00000000000 --- a/reference/services/SoftLayer_Hardware_SecurityModule750/getPublicBandwidthGraphImage/index.html +++ /dev/null @@ -1,378 +0,0 @@ - - - - - - - - - - - - - - - - getPublicBandwidthGraphImage - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getPublicBandwidthGraphImage

-
-
-
-
-
- Classes - - SoftLayer_Hardware_SecurityModule750 - -
- Tags - - method - - sldn - - hardware - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Hardware_SecurityModule750::getPublicBandwidthGraphImage -

- - -

- Retrieve a graph of a server’s public network usage. -

-

Description

- - Retrieve a graph of a server’s public network bandwidth usage over the specified time frame. If no time frame is specified then getPublicBandwidthGraphImage retrieves the last 24 hours of public bandwidth usage. getPublicBandwidthGraphImage returns a PNG image measuring 827 pixels by 293 pixels. THIS METHOD GENERATES GRAPHS BASED ON THE NEW DATA WAREHOUSE REPOSITORY. - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
startTimedateTimeThe starting point to retrieve bandwidth data from, specified as a dateTime.
endTimedateTimeThe end point to retrieve bandwidth data to, specified as a dateTime.
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - base64Binary - -
- -

Error Handling

-
    - - -
  • Throw the exception “Unable to retrieve the public bandwidth graph for server {id}.” if the API is unable to retrieve a valid PNG bandwidth graph image.
  • - - - - - -
  • Throw the exception “The start time {startTime} is not a readable date format.” if an invalid start time is passed to getPublicBandwidthGraphImage.
  • - - - - - -
  • Throw the exception “The end time {endTime} is not a readable date format.” if an invalid end time is passed to getPublicBandwidthGraphImage.
  • - - - - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [dateTime, dateTime]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getPublicBandwidthGraphImage'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Hardware_SecurityModule750/getStorageNetworkComponents/index.html b/reference/services/SoftLayer_Hardware_SecurityModule750/getStorageNetworkComponents/index.html deleted file mode 100644 index 768a5fa1173..00000000000 --- a/reference/services/SoftLayer_Hardware_SecurityModule750/getStorageNetworkComponents/index.html +++ /dev/null @@ -1,332 +0,0 @@ - - - - - - - - - - - - - - - - getStorageNetworkComponents - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getStorageNetworkComponents

-
-
-
-
-
- Classes - - SoftLayer_Hardware_SecurityModule750 - -
- Tags - - method - - sldn - - hardware - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Hardware_SecurityModule750::getStorageNetworkComponents -

- - -
Deprecated
- -

- -

-

Description

- - A piece of hardware’s private storage network components. [Deprecated] - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getStorageNetworkComponents'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Hardware_Server/getBandwidthImage/index.html b/reference/services/SoftLayer_Hardware_Server/getBandwidthImage/index.html deleted file mode 100644 index a74ad801e15..00000000000 --- a/reference/services/SoftLayer_Hardware_Server/getBandwidthImage/index.html +++ /dev/null @@ -1,385 +0,0 @@ - - - - - - - - - - - - - - - - getBandwidthImage - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getBandwidthImage

-
-
-
-
-
- Classes - - SoftLayer_Hardware_Server - -
- Tags - - method - - sldn - - hardware - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Hardware_Server::getBandwidthImage -

- - -

- Retrieve a bandwidth image and textual description of that image for this server. -

-

Description

- - Use this method when needing a bandwidth image for a single server. It will gather the correct input parameters for the generic graphing utility automatically based on the snapshot specified. Use the $draw flag to suppress the generation of the actual binary PNG image. - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
networkTypeenum
  • public
  • private
snapshotRangeenum
  • day
  • week
  • 30day
  • previous_calendar_month
  • current_calendar_month
  • current_billing_cycle
  • previous_billing_cycle
  • specified_day
  • specified_range
drawbooleanTRUE to generate binary image otherwise just return text
dateSpecifieddateTimeInclude this parameter when snapshot is ‘specified_day’ or ‘specified_range’. Needs to be formatted as: ‘MM/DD/YYYY’
dateSpecifiedEnddateTimeInclude this parameter when snapshotRange is ‘specified_range’. Also formatted as ‘MM/DD/YYYY’.
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [enum, enum, boolean, dateTime, dateTime]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getBandwidthImage'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Hardware_Server/getDownstreamNetworkHardwareWithIncidents/index.html b/reference/services/SoftLayer_Hardware_Server/getDownstreamNetworkHardwareWithIncidents/index.html deleted file mode 100644 index 19cff4252d7..00000000000 --- a/reference/services/SoftLayer_Hardware_Server/getDownstreamNetworkHardwareWithIncidents/index.html +++ /dev/null @@ -1,332 +0,0 @@ - - - - - - - - - - - - - - - - getDownstreamNetworkHardwareWithIncidents - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getDownstreamNetworkHardwareWithIncidents

-
-
-
-
-
- Classes - - SoftLayer_Hardware_Server - -
- Tags - - method - - sldn - - hardware - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Hardware_Server::getDownstreamNetworkHardwareWithIncidents -

- - -
Deprecated
- -

- -

-

Description

- - All network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. [DEPRECATED] - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getDownstreamNetworkHardwareWithIncidents'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Hardware_Server/getIsNfsCapable/index.html b/reference/services/SoftLayer_Hardware_Server/getIsNfsCapable/index.html deleted file mode 100644 index 0a4bd7a2e2c..00000000000 --- a/reference/services/SoftLayer_Hardware_Server/getIsNfsCapable/index.html +++ /dev/null @@ -1,323 +0,0 @@ - - - - - - - - - - - - - - - - getIsNfsCapable - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getIsNfsCapable

-
-
-
-
-
- Classes - - SoftLayer_Hardware_Server - -
- Tags - - method - - sldn - - hardware - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Hardware_Server::getIsNfsCapable -

- - -

- -

-

Description

- - A server that has nfs capable drive. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

-
  • - - - - string - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getIsNfsCapable'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Hardware_Server/getNetworkStatusAttribute/index.html b/reference/services/SoftLayer_Hardware_Server/getNetworkStatusAttribute/index.html deleted file mode 100644 index a55fa721c43..00000000000 --- a/reference/services/SoftLayer_Hardware_Server/getNetworkStatusAttribute/index.html +++ /dev/null @@ -1,328 +0,0 @@ - - - - - - - - - - - - - - - - getNetworkStatusAttribute - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getNetworkStatusAttribute

-
-
-
-
-
- Classes - - SoftLayer_Hardware_Server - -
- Tags - - method - - sldn - - hardware - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Hardware_Server::getNetworkStatusAttribute -

- - -
Deprecated
- -

- -

-

Description

- - The hardware’s related network status attribute. [DEPRECATED] - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getNetworkStatusAttribute'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Hardware_Server/getPrivateBandwidthGraphImage/index.html b/reference/services/SoftLayer_Hardware_Server/getPrivateBandwidthGraphImage/index.html deleted file mode 100644 index b49b9e05765..00000000000 --- a/reference/services/SoftLayer_Hardware_Server/getPrivateBandwidthGraphImage/index.html +++ /dev/null @@ -1,378 +0,0 @@ - - - - - - - - - - - - - - - - getPrivateBandwidthGraphImage - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getPrivateBandwidthGraphImage

-
-
-
-
-
- Classes - - SoftLayer_Hardware_Server - -
- Tags - - method - - sldn - - hardware - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Hardware_Server::getPrivateBandwidthGraphImage -

- - -

- Retrieve a graph of a server’s private network usage. -

-

Description

- - Retrieve a graph of a server’s private network bandwidth usage over the specified time frame. If no time frame is specified then getPublicBandwidthGraphImage retrieves the last 24 hours of public bandwidth usage. getPublicBandwidthGraphImage returns a PNG image - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
startTimestringThe starting point to retrieve bandwidth data from, specified as a dateTime.
endTimestringThe end point to retrieve bandwidth data to, specified as a dateTime.
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - base64Binary - -
- -

Error Handling

-
    - - -
  • Throw the exception “Unable to retrieve the public bandwidth graph for server {id}.” if the API is unable to retrieve a valid PNG bandwidth graph image.
  • - - - - - -
  • Throw the exception “The start time {startTime} is not a readable date format.” if an invalid start time is passed to getPublicBandwidthGraphImage.
  • - - - - - -
  • Throw the exception “The end time {endTime} is not a readable date format.” if an invalid end time is passed to getPublicBandwidthGraphImage.
  • - - - - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string, string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getPrivateBandwidthGraphImage'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Hardware_Server/getPrivateVlanByIpAddress/index.html b/reference/services/SoftLayer_Hardware_Server/getPrivateVlanByIpAddress/index.html deleted file mode 100644 index 1813a260afe..00000000000 --- a/reference/services/SoftLayer_Hardware_Server/getPrivateVlanByIpAddress/index.html +++ /dev/null @@ -1,369 +0,0 @@ - - - - - - - - - - - - - - - - getPrivateVlanByIpAddress - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getPrivateVlanByIpAddress

-
-
-
-
-
- Classes - - SoftLayer_Hardware_Server - -
- Tags - - method - - sldn - - hardware - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Hardware_Server::getPrivateVlanByIpAddress -

- - -
Deprecated
- -

- Retrieve a backend network VLAN by searching for an IP address. -

-

Description

- - *** DEPRECATED *** -Retrieve a backend network VLAN by searching for an IP address - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
ipAddressstringThe server’s IP address you are searching for.
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - -

Error Handling

-
    - - -
  • Throw the exception “You must provide a valid IP address.” if an invalid IPV4 IP address was provided.
  • - - - - - -
  • Throw the exception “Unable to find a subnet.” if there is no subnet for the IP address provided.
  • - - - - - -
  • Throw the exception “Unable to find a valid network component for this IP address.” if a network component with the primary IP address the same as the one provided could not be found.
  • - - - - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Hardware_Server/getPrivateVlanByIpAddress'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Hardware_Server/getPublicBandwidthGraphImage/index.html b/reference/services/SoftLayer_Hardware_Server/getPublicBandwidthGraphImage/index.html deleted file mode 100644 index 0c86d6c816c..00000000000 --- a/reference/services/SoftLayer_Hardware_Server/getPublicBandwidthGraphImage/index.html +++ /dev/null @@ -1,378 +0,0 @@ - - - - - - - - - - - - - - - - getPublicBandwidthGraphImage - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getPublicBandwidthGraphImage

-
-
-
-
-
- Classes - - SoftLayer_Hardware_Server - -
- Tags - - method - - sldn - - hardware - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Hardware_Server::getPublicBandwidthGraphImage -

- - -

- Retrieve a graph of a server’s public network usage. -

-

Description

- - Retrieve a graph of a server’s public network bandwidth usage over the specified time frame. If no time frame is specified then getPublicBandwidthGraphImage retrieves the last 24 hours of public bandwidth usage. getPublicBandwidthGraphImage returns a PNG image measuring 827 pixels by 293 pixels. THIS METHOD GENERATES GRAPHS BASED ON THE NEW DATA WAREHOUSE REPOSITORY. - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
startTimedateTimeThe starting point to retrieve bandwidth data from, specified as a dateTime.
endTimedateTimeThe end point to retrieve bandwidth data to, specified as a dateTime.
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - base64Binary - -
- -

Error Handling

-
    - - -
  • Throw the exception “Unable to retrieve the public bandwidth graph for server {id}.” if the API is unable to retrieve a valid PNG bandwidth graph image.
  • - - - - - -
  • Throw the exception “The start time {startTime} is not a readable date format.” if an invalid start time is passed to getPublicBandwidthGraphImage.
  • - - - - - -
  • Throw the exception “The end time {endTime} is not a readable date format.” if an invalid end time is passed to getPublicBandwidthGraphImage.
  • - - - - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [dateTime, dateTime]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getPublicBandwidthGraphImage'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Hardware_Server/getStorageNetworkComponents/index.html b/reference/services/SoftLayer_Hardware_Server/getStorageNetworkComponents/index.html deleted file mode 100644 index 7cd48152fdd..00000000000 --- a/reference/services/SoftLayer_Hardware_Server/getStorageNetworkComponents/index.html +++ /dev/null @@ -1,332 +0,0 @@ - - - - - - - - - - - - - - - - getStorageNetworkComponents - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getStorageNetworkComponents

-
-
-
-
-
- Classes - - SoftLayer_Hardware_Server - -
- Tags - - method - - sldn - - hardware - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Hardware_Server::getStorageNetworkComponents -

- - -
Deprecated
- -

- -

-

Description

- - A piece of hardware’s private storage network components. [Deprecated] - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getStorageNetworkComponents'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Location/getBackboneDependents/index.html b/reference/services/SoftLayer_Location/getBackboneDependents/index.html deleted file mode 100644 index 79436524f4a..00000000000 --- a/reference/services/SoftLayer_Location/getBackboneDependents/index.html +++ /dev/null @@ -1,281 +0,0 @@ - - - - - - - - - - - - - - - - getBackboneDependents - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getBackboneDependents

-
-
-
-
-
- Classes - - SoftLayer_Location - -
- Tags - - method - - sldn - - location - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Location::getBackboneDependents -

- - -
Deprecated
- -

- -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Location/{SoftLayer_LocationID}/getBackboneDependents'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Location/getMetricTrackingObject/index.html b/reference/services/SoftLayer_Location/getMetricTrackingObject/index.html deleted file mode 100644 index d9429b41883..00000000000 --- a/reference/services/SoftLayer_Location/getMetricTrackingObject/index.html +++ /dev/null @@ -1,328 +0,0 @@ - - - - - - - - - - - - - - - - getMetricTrackingObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getMetricTrackingObject

-
-
-
-
-
- Classes - - SoftLayer_Location - -
- Tags - - method - - sldn - - location - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Location::getMetricTrackingObject -

- - -
Deprecated
- -

- -

-

Description

- - [DEPRECATED] - A location’s metric tracking object. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Location/{SoftLayer_LocationID}/getMetricTrackingObject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Location/getOnlineSslVpnUserCount/index.html b/reference/services/SoftLayer_Location/getOnlineSslVpnUserCount/index.html deleted file mode 100644 index b9e94ec20b0..00000000000 --- a/reference/services/SoftLayer_Location/getOnlineSslVpnUserCount/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getOnlineSslVpnUserCount - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getOnlineSslVpnUserCount

-
-
-
-
-
- Classes - - SoftLayer_Location - -
- Tags - - method - - sldn - - location - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Location::getOnlineSslVpnUserCount -

- - -

- -

-

Description

- - The total number of users online using SoftLayer’s SSL VPN service for a location. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

-
  • - - - - int - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Location/{SoftLayer_LocationID}/getOnlineSslVpnUserCount'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Location_Datacenter/getBackboneDependents/index.html b/reference/services/SoftLayer_Location_Datacenter/getBackboneDependents/index.html deleted file mode 100644 index 02cab8409fa..00000000000 --- a/reference/services/SoftLayer_Location_Datacenter/getBackboneDependents/index.html +++ /dev/null @@ -1,281 +0,0 @@ - - - - - - - - - - - - - - - - getBackboneDependents - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getBackboneDependents

-
-
-
-
-
- Classes - - SoftLayer_Location_Datacenter - -
- Tags - - method - - sldn - - location - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Location_Datacenter::getBackboneDependents -

- - -
Deprecated
- -

- -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Location_Datacenter/{SoftLayer_Location_DatacenterID}/getBackboneDependents'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Location_Datacenter/getMetricTrackingObject/index.html b/reference/services/SoftLayer_Location_Datacenter/getMetricTrackingObject/index.html deleted file mode 100644 index 6759590a1d7..00000000000 --- a/reference/services/SoftLayer_Location_Datacenter/getMetricTrackingObject/index.html +++ /dev/null @@ -1,328 +0,0 @@ - - - - - - - - - - - - - - - - getMetricTrackingObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getMetricTrackingObject

-
-
-
-
-
- Classes - - SoftLayer_Location_Datacenter - -
- Tags - - method - - sldn - - location - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Location_Datacenter::getMetricTrackingObject -

- - -
Deprecated
- -

- -

-

Description

- - [DEPRECATED] - A location’s metric tracking object. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Location_Datacenter/{SoftLayer_Location_DatacenterID}/getMetricTrackingObject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Location_Datacenter/getOnlineSslVpnUserCount/index.html b/reference/services/SoftLayer_Location_Datacenter/getOnlineSslVpnUserCount/index.html deleted file mode 100644 index e9f63381c60..00000000000 --- a/reference/services/SoftLayer_Location_Datacenter/getOnlineSslVpnUserCount/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getOnlineSslVpnUserCount - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getOnlineSslVpnUserCount

-
-
-
-
-
- Classes - - SoftLayer_Location_Datacenter - -
- Tags - - method - - sldn - - location - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Location_Datacenter::getOnlineSslVpnUserCount -

- - -

- -

-

Description

- - The total number of users online using SoftLayer’s SSL VPN service for a location. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

-
  • - - - - int - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Location_Datacenter/{SoftLayer_Location_DatacenterID}/getOnlineSslVpnUserCount'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Location_Datacenter/getRoutableBoundSubnets/index.html b/reference/services/SoftLayer_Location_Datacenter/getRoutableBoundSubnets/index.html deleted file mode 100644 index 1b792eb3c95..00000000000 --- a/reference/services/SoftLayer_Location_Datacenter/getRoutableBoundSubnets/index.html +++ /dev/null @@ -1,332 +0,0 @@ - - - - - - - - - - - - - - - - getRoutableBoundSubnets - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getRoutableBoundSubnets

-
-
-
-
-
- Classes - - SoftLayer_Location_Datacenter - -
- Tags - - method - - sldn - - location - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Location_Datacenter::getRoutableBoundSubnets -

- - -
Deprecated
- -

- -

-

Description

- - [DEPRECATED] Retrieve all subnets that are eligible to be routed; those which the account has permission to associate with a vlan. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Location_Datacenter/{SoftLayer_Location_DatacenterID}/getRoutableBoundSubnets'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Metric_Tracking_Object/getBackboneBandwidthGraph/index.html b/reference/services/SoftLayer_Metric_Tracking_Object/getBackboneBandwidthGraph/index.html deleted file mode 100644 index a37da32cc41..00000000000 --- a/reference/services/SoftLayer_Metric_Tracking_Object/getBackboneBandwidthGraph/index.html +++ /dev/null @@ -1,292 +0,0 @@ - - - - - - - - - - - - - - - - getBackboneBandwidthGraph - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getBackboneBandwidthGraph

-
-
-
-
-
- Classes - - SoftLayer_Metric_Tracking_Object - -
- Tags - - method - - sldn - - metric - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Metric_Tracking_Object::getBackboneBandwidthGraph -

- - -
Deprecated
- -

- [DEPRECATED] Retrieve a graph of a SoftLayer backbone’s recent traffic activity. -

-

Description

- - [DEPRECATED] Retrieve a PNG image of the last 24 hours of bandwidth usage of one of SoftLayer’s network backbones. - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
graphTitlestringAn optional name to override a backbone graph image’s title
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - -
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Metric_Tracking_Object/getBandwidthGraph/index.html b/reference/services/SoftLayer_Metric_Tracking_Object/getBandwidthGraph/index.html deleted file mode 100644 index e3aefbdda04..00000000000 --- a/reference/services/SoftLayer_Metric_Tracking_Object/getBandwidthGraph/index.html +++ /dev/null @@ -1,418 +0,0 @@ - - - - - - - - - - - - - - - - getBandwidthGraph - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getBandwidthGraph

-
-
-
-
-
- Classes - - SoftLayer_Metric_Tracking_Object - -
- Tags - - method - - sldn - - metric - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Metric_Tracking_Object::getBandwidthGraph -

- - -
Deprecated
- -

- [DEPRECATED] Retrieve a bandwidth graph. -

-

Description

- - [DEPRECATED] Retrieve a PNG image of a bandwidth graph representing the bandwidth usage over time recorded by SofTLayer’s bandwidth pollers. - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
startDateTimedateTimeThe starting date of the range of graph data you wish to retrieve.
endDateTimedateTimeThe ending date of the range of graph data you wish to retrieve.
graphTypestring$graphType The type type of the bandwidth graph you wish to retrieve, either “public” or “private”.
fontSizeint$fontSize Size to draw the font on the graph labels and legend.
graphWidthint$graphWidth Number of pixel wide you would like to draw the graph.
graphHeightint$graphHeight Number of pixel high you would like to draw the graph.
doNotShowTimeZoneboolean$doNotShowTimeZone Whether or not you’d like the timezone printed on the graph margin.
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - -

Associated Methods

- - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [dateTime, dateTime, string, int, int, int, boolean]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Metric_Tracking_Object/{SoftLayer_Metric_Tracking_ObjectID}/getBandwidthGraph'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Metric_Tracking_Object/getDetailsForDateRange/index.html b/reference/services/SoftLayer_Metric_Tracking_Object/getDetailsForDateRange/index.html deleted file mode 100644 index 7e6a4404a4a..00000000000 --- a/reference/services/SoftLayer_Metric_Tracking_Object/getDetailsForDateRange/index.html +++ /dev/null @@ -1,377 +0,0 @@ - - - - - - - - - - - - - - - - getDetailsForDateRange - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getDetailsForDateRange

-
-
-
-
-
- Classes - - SoftLayer_Metric_Tracking_Object - -
- Tags - - method - - sldn - - metric - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Metric_Tracking_Object::getDetailsForDateRange -

- - -

- Retrieve metric detail data over a date range. -

-

Description

- - Retrieve a collection of detailed metric data over a date range. Ideal if you want to employ your own graphing systems. Note not all metrics support this method. Those that do not return null. - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
startDatedateTimeThe starting date of the range of data you wish to collect.
endDatedateTimeThe ending date of the range of data you wish to collect.
graphTypestring[]The type of metric to gather data for (InstanceCount, HostMemoryUsage, HostReservedMemoryUsage).
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - -

Associated Methods

- - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [dateTime, dateTime, string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Metric_Tracking_Object/{SoftLayer_Metric_Tracking_ObjectID}/getDetailsForDateRange'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Metric_Tracking_Object/getGraph/index.html b/reference/services/SoftLayer_Metric_Tracking_Object/getGraph/index.html deleted file mode 100644 index db6bcfad95f..00000000000 --- a/reference/services/SoftLayer_Metric_Tracking_Object/getGraph/index.html +++ /dev/null @@ -1,369 +0,0 @@ - - - - - - - - - - - - - - - - getGraph - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getGraph

-
-
-
-
-
- Classes - - SoftLayer_Metric_Tracking_Object - -
- Tags - - method - - sldn - - metric - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Metric_Tracking_Object::getGraph -

- - -
Deprecated
- -

- [DEPRECATED] Retrieve a graph of a virtual hosting platform’s per instance use. -

-

Description

- - [DEPRECATED] Retrieve a PNG image of a metric in graph form. - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
startDateTimedateTimetimestamp of the starting date of the graph
endDateTimedateTimetimestamp of the ending date of the graph
graphTypestring[]type of the graph (“public” or “private” for bandwidth, “InstanceCount” or “HostMemoryUsage” or “HostReservedMemoryUsage” for virtual hosts)
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [dateTime, dateTime, string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Metric_Tracking_Object/{SoftLayer_Metric_Tracking_ObjectID}/getGraph'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Metric_Tracking_Object/getSummary/index.html b/reference/services/SoftLayer_Metric_Tracking_Object/getSummary/index.html deleted file mode 100644 index 28051fc029f..00000000000 --- a/reference/services/SoftLayer_Metric_Tracking_Object/getSummary/index.html +++ /dev/null @@ -1,353 +0,0 @@ - - - - - - - - - - - - - - - - getSummary - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getSummary

-
-
-
-
-
- Classes - - SoftLayer_Metric_Tracking_Object - -
- Tags - - method - - sldn - - metric - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Metric_Tracking_Object::getSummary -

- - -

- Retrieve metric summary. -

-

Description

- - Retrieve a metric summary. Ideal if you want to employ your own graphing systems. Note not all metric types contain a summary. These return null. - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
graphTypestringThe type of metric to gather data for (InstanceCount, HostMemoryUsage, HostReservedMemoryUsage).
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - -

Associated Methods

- - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Metric_Tracking_Object/{SoftLayer_Metric_Tracking_ObjectID}/getSummary'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network/getObject/index.html b/reference/services/SoftLayer_Network/getObject/index.html deleted file mode 100644 index ecee2405173..00000000000 --- a/reference/services/SoftLayer_Network/getObject/index.html +++ /dev/null @@ -1,275 +0,0 @@ - - - - - - - - - - - - - - - - getObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getObject

-
-
-
-
-
- Classes - - SoftLayer_Network - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network::getObject -

- - -

- Retrieve a SoftLayer_Network record. -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network/{SoftLayer_NetworkID}/getObject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Application_Delivery_Controller/getBandwidthImageByDate/index.html b/reference/services/SoftLayer_Network_Application_Delivery_Controller/getBandwidthImageByDate/index.html deleted file mode 100644 index e3efa541c05..00000000000 --- a/reference/services/SoftLayer_Network_Application_Delivery_Controller/getBandwidthImageByDate/index.html +++ /dev/null @@ -1,365 +0,0 @@ - - - - - - - - - - - - - - - - getBandwidthImageByDate - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getBandwidthImageByDate

-
-
-
-
-
- Classes - - SoftLayer_Network_Application_Delivery_Controller - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Application_Delivery_Controller::getBandwidthImageByDate -

- - -

- Retrieve a visual representation of the amount of network traffic that occurred for the specified time frame for an application delivery controller. -

-

Description

- - Use this method when needing a bandwidth image for a single application delivery controller. It will gather the correct input parameters for the generic graphing utility based on the date ranges - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
startDateTimedateTimedatetime of the start date of the graph
endDateTimedateTimedatetime of the ending date of the graph
networkTypestring$networkType type of the graph, either “public” or “private”
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [dateTime, dateTime, string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Application_Delivery_Controller/{SoftLayer_Network_Application_Delivery_ControllerID}/getBandwidthImageByDate'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Application_Delivery_Controller/getLiveLoadBalancerServiceGraphImage/index.html b/reference/services/SoftLayer_Network_Application_Delivery_Controller/getLiveLoadBalancerServiceGraphImage/index.html deleted file mode 100644 index cc714c45382..00000000000 --- a/reference/services/SoftLayer_Network_Application_Delivery_Controller/getLiveLoadBalancerServiceGraphImage/index.html +++ /dev/null @@ -1,368 +0,0 @@ - - - - - - - - - - - - - - - - getLiveLoadBalancerServiceGraphImage - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getLiveLoadBalancerServiceGraphImage

-
-
-
-
-
- Classes - - SoftLayer_Network_Application_Delivery_Controller - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Application_Delivery_Controller::getLiveLoadBalancerServiceGraphImage -

- - -

- Get the connection or status graph image for an application delivery controller service. -

-

Description

- -

Get the graph image for an application delivery controller service based on the supplied graph type and metric. The available graph types are: ‘connections’ and ‘status’, and the available metrics are: ‘day’, ‘week’ and ‘month’.

-

This method returns the raw binary image data.

- - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
serviceSoftLayer_Network_LoadBalancer_ServiceThe load balancer object you wish to retrieve a graph for
graphTypestringThe string “connections” or “status” depending on the type of graph you wish to retrieve
metricstringThe string “day”, “week”, or “month” depending on the duration of data you wish to retrieve in your graph
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - base64Binary - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [SoftLayer_Network_LoadBalancer_Service, string, string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Application_Delivery_Controller/{SoftLayer_Network_Application_Delivery_ControllerID}/getLiveLoadBalancerServiceGraphImage'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getDedicatedBillingItem/index.html b/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getDedicatedBillingItem/index.html deleted file mode 100644 index 48b8740f969..00000000000 --- a/reference/services/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/getDedicatedBillingItem/index.html +++ /dev/null @@ -1,328 +0,0 @@ - - - - - - - - - - - - - - - - getDedicatedBillingItem - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getDedicatedBillingItem

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress::getDedicatedBillingItem -

- - -
Deprecated
- -

- -

-

Description

- - The current billing item for the load balancing device housing the virtual IP. This billing item represents a device which could contain other virtual IPs. Caution should be taken when canceling. This is only valid when dedicatedFlag is true. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress/{SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddressID}/getDedicatedBillingItem'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Backbone/getAllBackbones/index.html b/reference/services/SoftLayer_Network_Backbone/getAllBackbones/index.html deleted file mode 100644 index 6c3bbd1ed0f..00000000000 --- a/reference/services/SoftLayer_Network_Backbone/getAllBackbones/index.html +++ /dev/null @@ -1,285 +0,0 @@ - - - - - - - - - - - - - - - - getAllBackbones - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getAllBackbones

-
-
-
-
-
- Classes - - SoftLayer_Network_Backbone - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Backbone::getAllBackbones -

- - -

- Retrieve a list of all SoftLayer Backbones -

-

Description

- - Retrieve a list of all SoftLayer backbone connections. Use this method if you need all backbones or don’t know the id number of a specific backbone. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - -

Associated Methods

- - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Backbone/getAllBackbones'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Backbone/getBackbonesForLocationName/index.html b/reference/services/SoftLayer_Network_Backbone/getBackbonesForLocationName/index.html deleted file mode 100644 index fa25bf36330..00000000000 --- a/reference/services/SoftLayer_Network_Backbone/getBackbonesForLocationName/index.html +++ /dev/null @@ -1,302 +0,0 @@ - - - - - - - - - - - - - - - - getBackbonesForLocationName - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getBackbonesForLocationName

-
-
-
-
-
- Classes - - SoftLayer_Network_Backbone - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Backbone::getBackbonesForLocationName -

- - -

- Retrieve a list of all SoftLayer Backbones for a location name -

-

Description

- - Retrieve a list of all SoftLayer backbone connections for a location name. - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
locationNamestringname for the location address
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - -

Associated Methods

- - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Backbone/getBackbonesForLocationName'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Backbone/getGraphImage/index.html b/reference/services/SoftLayer_Network_Backbone/getGraphImage/index.html deleted file mode 100644 index 9c4d90d6ca3..00000000000 --- a/reference/services/SoftLayer_Network_Backbone/getGraphImage/index.html +++ /dev/null @@ -1,282 +0,0 @@ - - - - - - - - - - - - - - - - getGraphImage - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getGraphImage

-
-
-
-
-
- Classes - - SoftLayer_Network_Backbone - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Backbone::getGraphImage -

- - -
Deprecated
- -

- [DEPRECATED] Retrieve a graph of a SoftLayer backbone’s last 24 hours of activity. -

-

Description

- - [DEPRECATED] Retrieve a graph of a SoftLayer backbone’s last 24 hours of activity. getGraphImage returns a PNG image measuring 827 pixels by 293 pixels. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - base64Binary - -
- -

Error Handling

-
    - - -
  • Throw the exception “Unable to load the image for the backbone graph” if the API is unable to retrieve a valid PNG image for the backbone.
  • - - - - -
- - - -
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Backbone/getHealth/index.html b/reference/services/SoftLayer_Network_Backbone/getHealth/index.html deleted file mode 100644 index 1f3254a9ada..00000000000 --- a/reference/services/SoftLayer_Network_Backbone/getHealth/index.html +++ /dev/null @@ -1,277 +0,0 @@ - - - - - - - - - - - - - - - - getHealth - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getHealth

-
-
-
-
-
- Classes - - SoftLayer_Network_Backbone - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Backbone::getHealth -

- - -
Deprecated
- -

- -

-

Description

- - [Deprecated] A backbone’s status. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

-
  • - - - - string - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Backbone/{SoftLayer_Network_BackboneID}/getHealth'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Backbone/getLocation/index.html b/reference/services/SoftLayer_Network_Backbone/getLocation/index.html deleted file mode 100644 index 5f191745e29..00000000000 --- a/reference/services/SoftLayer_Network_Backbone/getLocation/index.html +++ /dev/null @@ -1,277 +0,0 @@ - - - - - - - - - - - - - - - - getLocation - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getLocation

-
-
-
-
-
- Classes - - SoftLayer_Network_Backbone - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Backbone::getLocation -

- - -
Deprecated
- -

- -

-

Description

- - [Deprecated] Which of the SoftLayer datacenters a backbone is connected to. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Backbone/{SoftLayer_Network_BackboneID}/getLocation'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Backbone/getNetworkComponent/index.html b/reference/services/SoftLayer_Network_Backbone/getNetworkComponent/index.html deleted file mode 100644 index 7ee48f7a4aa..00000000000 --- a/reference/services/SoftLayer_Network_Backbone/getNetworkComponent/index.html +++ /dev/null @@ -1,277 +0,0 @@ - - - - - - - - - - - - - - - - getNetworkComponent - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getNetworkComponent

-
-
-
-
-
- Classes - - SoftLayer_Network_Backbone - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Backbone::getNetworkComponent -

- - -
Deprecated
- -

- -

-

Description

- - [Deprecated] A backbone’s primary network component. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Backbone/{SoftLayer_Network_BackboneID}/getNetworkComponent'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Backbone/getObject/index.html b/reference/services/SoftLayer_Network_Backbone/getObject/index.html deleted file mode 100644 index 87b00d664be..00000000000 --- a/reference/services/SoftLayer_Network_Backbone/getObject/index.html +++ /dev/null @@ -1,294 +0,0 @@ - - - - - - - - - - - - - - - - getObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getObject

-
-
-
-
-
- Classes - - SoftLayer_Network_Backbone - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Backbone::getObject -

- - -

- Retrieve a SoftLayer_Network_Backbone record. -

-

Description

- - Retrieve an individual SoftLayer_Network_Backbone record. Use the getAllBackbones() method to retrieve a list of all SoftLayer network backbones. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - -

Error Handling

-
    - - -
  • Throw the error “Unable to find object with id of {id}.” if the given initialization parameter has an invalid id field.
  • - - - - -
- - - -

Associated Methods

- - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Backbone/{SoftLayer_Network_BackboneID}/getObject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Backbone/index.html b/reference/services/SoftLayer_Network_Backbone/index.html deleted file mode 100644 index ce027635928..00000000000 --- a/reference/services/SoftLayer_Network_Backbone/index.html +++ /dev/null @@ -1,303 +0,0 @@ - - - - - - - - - - - - - SoftLayer_Network_Backbone - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_Backbone

-
-
-
-
-
- Classes - - SoftLayer_Network_Backbone - -
- Tags - - service - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Network_Backbone

- - -
- -
- - -

Description

- -
Deprecated
- - A SoftLayer_Network_Backbone represents a single backbone connection from SoftLayer to the public Internet, from the Internet to the SoftLayer private network, or a link that connects the private networks between SoftLayer’s datacenters. The SoftLayer_Network_Backbone service is unique in that it is not referenced by any of the other SoftLayer API services. - -
-

Methods

-
-
-
- -
-
-
-
- - - - - -
-

getAllBackbones

- -

Retrieve a list of all SoftLayer Backbones

- -
- - - -
-

getBackbonesForLocationName

- -

Retrieve a list of all SoftLayer Backbones for a location name

- -
- - - - - -
-

getHealth

- -

[Deprecated] A backbone’s status.

- -
- - - - - -
-

getLocation

- -

[Deprecated] Which of the SoftLayer datacenters a backbone is connected to.

- -
- - - - - -
-

getNetworkComponent

- -

[Deprecated] A backbone’s primary network component.

- -
- - - -
-

getObject

- -

Retrieve a SoftLayer_Network_Backbone record.

- -
- - -
-
- -
- -
-
- - - -
- - - - - - - diff --git a/reference/services/SoftLayer_Network_Backbone_Location_Dependent/getAllObjects/index.html b/reference/services/SoftLayer_Network_Backbone_Location_Dependent/getAllObjects/index.html deleted file mode 100644 index 25da9be18b3..00000000000 --- a/reference/services/SoftLayer_Network_Backbone_Location_Dependent/getAllObjects/index.html +++ /dev/null @@ -1,275 +0,0 @@ - - - - - - - - - - - - - - - - getAllObjects - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getAllObjects

-
-
-
-
-
- Classes - - SoftLayer_Network_Backbone_Location_Dependent - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Backbone_Location_Dependent::getAllObjects -

- - -

- -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Backbone_Location_Dependent/getAllObjects'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Backbone_Location_Dependent/getDependentLocation/index.html b/reference/services/SoftLayer_Network_Backbone_Location_Dependent/getDependentLocation/index.html deleted file mode 100644 index d401486e4a6..00000000000 --- a/reference/services/SoftLayer_Network_Backbone_Location_Dependent/getDependentLocation/index.html +++ /dev/null @@ -1,277 +0,0 @@ - - - - - - - - - - - - - - - - getDependentLocation - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getDependentLocation

-
-
-
-
-
- Classes - - SoftLayer_Network_Backbone_Location_Dependent - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Backbone_Location_Dependent::getDependentLocation -

- - -
Deprecated
- -

- -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Backbone_Location_Dependent/{SoftLayer_Network_Backbone_Location_DependentID}/getDependentLocation'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Backbone_Location_Dependent/getObject/index.html b/reference/services/SoftLayer_Network_Backbone_Location_Dependent/getObject/index.html deleted file mode 100644 index 4528ae2ae35..00000000000 --- a/reference/services/SoftLayer_Network_Backbone_Location_Dependent/getObject/index.html +++ /dev/null @@ -1,275 +0,0 @@ - - - - - - - - - - - - - - - - getObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getObject

-
-
-
-
-
- Classes - - SoftLayer_Network_Backbone_Location_Dependent - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Backbone_Location_Dependent::getObject -

- - -

- Retrieve a SoftLayer_Network_Backbone_Location_Dependent record. -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Backbone_Location_Dependent/{SoftLayer_Network_Backbone_Location_DependentID}/getObject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Backbone_Location_Dependent/getSourceDependentsByName/index.html b/reference/services/SoftLayer_Network_Backbone_Location_Dependent/getSourceDependentsByName/index.html deleted file mode 100644 index b63339cd1ae..00000000000 --- a/reference/services/SoftLayer_Network_Backbone_Location_Dependent/getSourceDependentsByName/index.html +++ /dev/null @@ -1,294 +0,0 @@ - - - - - - - - - - - - - - - - getSourceDependentsByName - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getSourceDependentsByName

-
-
-
-
-
- Classes - - SoftLayer_Network_Backbone_Location_Dependent - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Backbone_Location_Dependent::getSourceDependentsByName -

- - -

- -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
locationNamestring
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Backbone_Location_Dependent/getSourceDependentsByName'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Backbone_Location_Dependent/getSourceLocation/index.html b/reference/services/SoftLayer_Network_Backbone_Location_Dependent/getSourceLocation/index.html deleted file mode 100644 index 770f31e5aa4..00000000000 --- a/reference/services/SoftLayer_Network_Backbone_Location_Dependent/getSourceLocation/index.html +++ /dev/null @@ -1,277 +0,0 @@ - - - - - - - - - - - - - - - - getSourceLocation - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getSourceLocation

-
-
-
-
-
- Classes - - SoftLayer_Network_Backbone_Location_Dependent - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Backbone_Location_Dependent::getSourceLocation -

- - -
Deprecated
- -

- -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Backbone_Location_Dependent/{SoftLayer_Network_Backbone_Location_DependentID}/getSourceLocation'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Backbone_Location_Dependent/index.html b/reference/services/SoftLayer_Network_Backbone_Location_Dependent/index.html deleted file mode 100644 index fcbc2027687..00000000000 --- a/reference/services/SoftLayer_Network_Backbone_Location_Dependent/index.html +++ /dev/null @@ -1,292 +0,0 @@ - - - - - - - - - - - - - SoftLayer_Network_Backbone_Location_Dependent - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_Backbone_Location_Dependent

-
-
-
-
-
- Classes - - SoftLayer_Network_Backbone_Location_Dependent - -
- Tags - - service - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Network_Backbone_Location_Dependent

- - -
- -
- - -

Description

- -
Deprecated
- - - -
-

Methods

-
-
-
- -
-
-
-
- - - - - -
-

getAllObjects

- -

- -
- - - - - - - - - -
-

getObject

- -

Retrieve a SoftLayer_Network_Backbone_Location_Dependent record.

- -
- - - - - - - - - -
-

getSourceLocation

- -

- -
- - -
-
- -
- -
-
- - - -
- - - - - - - diff --git a/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBandwidthImage/index.html b/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBandwidthImage/index.html deleted file mode 100644 index de2fb872ef3..00000000000 --- a/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getBandwidthImage/index.html +++ /dev/null @@ -1,385 +0,0 @@ - - - - - - - - - - - - - - - - getBandwidthImage - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getBandwidthImage

-
-
-
-
-
- Classes - - SoftLayer_Network_Bandwidth_Version1_Allotment - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Bandwidth_Version1_Allotment::getBandwidthImage -

- - -

- generate a graph image of all the bandwidth usage for an entire allotment of servers. -

-

Description

- - This method recurses through all servers on a Bandwidth Pool for a given snapshot range, gathers the necessary parameters, and then calls the bandwidth graphing server. The return result is a container that includes the min and max dates for all servers to be used in the query, as well as an image in PNG format. This method uses the new and improved drawing routines which should return in a reasonable time frame now that the new backend data warehouse is used. - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
networkTypeenum
  • public
  • private
snapshotRangeenum
  • day
  • week
  • 30day
  • previous_calendar_month
  • current_calendar_month
  • current_billing_cycle
  • previous_billing_cycle
  • specified_day
  • specified_range
drawbooleanTRUE to generate binary image otherwise just return text. Deprecated, images return fast enough now.
dateSpecifieddateTimeInclude this parameter when snapshot is ‘specified_day’ or ‘specified_range’. Needs to be formatted as: ‘MM/DD/YYYY’
dateSpecifiedEnddateTimeInclude this parameter when snapshotRange is ‘specified_range’. Also formatted as ‘MM/DD/YYYY’
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [enum, enum, boolean, dateTime, dateTime]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Bandwidth_Version1_Allotment/{SoftLayer_Network_Bandwidth_Version1_AllotmentID}/getBandwidthImage'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getManagedBareMetalInstances/index.html b/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getManagedBareMetalInstances/index.html deleted file mode 100644 index cd350e941ec..00000000000 --- a/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getManagedBareMetalInstances/index.html +++ /dev/null @@ -1,330 +0,0 @@ - - - - - - - - - - - - - - - - getManagedBareMetalInstances - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getManagedBareMetalInstances

-
-
-
-
-
- Classes - - SoftLayer_Network_Bandwidth_Version1_Allotment - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Bandwidth_Version1_Allotment::getManagedBareMetalInstances -

- - -

- -

-

Description

- - [DEPRECATED] The managed bare metal server instances contained within a virtual rack. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Bandwidth_Version1_Allotment/{SoftLayer_Network_Bandwidth_Version1_AllotmentID}/getManagedBareMetalInstances'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getManagedHardware/index.html b/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getManagedHardware/index.html deleted file mode 100644 index 2ea9f0ea8af..00000000000 --- a/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getManagedHardware/index.html +++ /dev/null @@ -1,330 +0,0 @@ - - - - - - - - - - - - - - - - getManagedHardware - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getManagedHardware

-
-
-
-
-
- Classes - - SoftLayer_Network_Bandwidth_Version1_Allotment - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Bandwidth_Version1_Allotment::getManagedHardware -

- - -

- -

-

Description

- - [DEPRECATED] The managed hardware contained within a virtual rack. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Bandwidth_Version1_Allotment/{SoftLayer_Network_Bandwidth_Version1_AllotmentID}/getManagedHardware'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getManagedVirtualGuests/index.html b/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getManagedVirtualGuests/index.html deleted file mode 100644 index 6d603338c8f..00000000000 --- a/reference/services/SoftLayer_Network_Bandwidth_Version1_Allotment/getManagedVirtualGuests/index.html +++ /dev/null @@ -1,330 +0,0 @@ - - - - - - - - - - - - - - - - getManagedVirtualGuests - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getManagedVirtualGuests

-
-
-
-
-
- Classes - - SoftLayer_Network_Bandwidth_Version1_Allotment - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Bandwidth_Version1_Allotment::getManagedVirtualGuests -

- - -

- -

-

Description

- - [DEPRECATED] The managed Virtual Server contained within a virtual rack. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Bandwidth_Version1_Allotment/{SoftLayer_Network_Bandwidth_Version1_AllotmentID}/getManagedVirtualGuests'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Account/getAccount/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Account/getAccount/index.html deleted file mode 100644 index 14af8a2073f..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Account/getAccount/index.html +++ /dev/null @@ -1,328 +0,0 @@ - - - - - - - - - - - - - - - - getAccount - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getAccount

-
-
-
-
-
- Classes - - SoftLayer_Network_CdnMarketplace_Account - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Account::getAccount -

- - -
Deprecated
- -

- -

-

Description

- - SoftLayer account to which the CDN account belongs. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Account/{SoftLayer_Network_CdnMarketplace_AccountID}/getAccount'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Account/getBillingItem/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Account/getBillingItem/index.html deleted file mode 100644 index 62969c7cec9..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Account/getBillingItem/index.html +++ /dev/null @@ -1,328 +0,0 @@ - - - - - - - - - - - - - - - - getBillingItem - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getBillingItem

-
-
-
-
-
- Classes - - SoftLayer_Network_CdnMarketplace_Account - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Account::getBillingItem -

- - -
Deprecated
- -

- -

-

Description

- - An associated parent billing item which is active. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Account/{SoftLayer_Network_CdnMarketplace_AccountID}/getBillingItem'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Account/getObject/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Account/getObject/index.html deleted file mode 100644 index b002003c85f..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Account/getObject/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getObject

-
-
-
-
-
- Classes - - SoftLayer_Network_CdnMarketplace_Account - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Account::getObject -

- - -

- Retrieve a SoftLayer_Network_CdnMarketplace_Account record. -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Account/{SoftLayer_Network_CdnMarketplace_AccountID}/getObject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Account/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Account/index.html deleted file mode 100644 index 20a309f08bc..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Account/index.html +++ /dev/null @@ -1,334 +0,0 @@ - - - - - - - - - - - - - SoftLayer_Network_CdnMarketplace_Account - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_CdnMarketplace_Account

-
-
-
-
-
- Classes - - SoftLayer_Network_CdnMarketplace_Account - -
- Tags - - service - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Network_CdnMarketplace_Account

- - -
- -
- - -

Description

- -
Deprecated
- - This class is deprecated and will be removed in future. - -
-

Methods

-
-
-
- -
-
-
-
- - - - - - - -
-

getAccount

- -

SoftLayer account to which the CDN account belongs.

- -
- - - - - -
-

getBillingItem

- -

An associated parent billing item which is active.

- -
- - - -
-

getObject

- -

Retrieve a SoftLayer_Network_CdnMarketplace_Account record.

- -
- - - -
-

verifyCdnAccountExists

- -

DEPRECATED

- -
- - -
-
- -
- -
-
- - - -
- - - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Account/verifyCdnAccountExists/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Account/verifyCdnAccountExists/index.html deleted file mode 100644 index 6828369d4be..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Account/verifyCdnAccountExists/index.html +++ /dev/null @@ -1,343 +0,0 @@ - - - - - - - - - - - - - - - - verifyCdnAccountExists - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

verifyCdnAccountExists

-
-
-
-
-
- Classes - - SoftLayer_Network_CdnMarketplace_Account - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Account::verifyCdnAccountExists -

- - -

- DEPRECATED -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
vendorNamestring
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - boolean - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Account/verifyCdnAccountExists'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/createGeoblocking/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/createGeoblocking/index.html deleted file mode 100644 index 2b1ec9c954f..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/createGeoblocking/index.html +++ /dev/null @@ -1,346 +0,0 @@ - - - - - - - - - - - - - - - - createGeoblocking - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

createGeoblocking

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking::createGeoblocking -

- - -
Deprecated
- -

- -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
inputSoftLayer_Container_Network_CdnMarketplace_Configuration_Input
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [SoftLayer_Container_Network_CdnMarketplace_Configuration_Input]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/createGeoblocking'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/deleteGeoblocking/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/deleteGeoblocking/index.html deleted file mode 100644 index 5c53df297e8..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/deleteGeoblocking/index.html +++ /dev/null @@ -1,346 +0,0 @@ - - - - - - - - - - - - - - - - deleteGeoblocking - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

deleteGeoblocking

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking::deleteGeoblocking -

- - -
Deprecated
- -

- -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
inputSoftLayer_Container_Network_CdnMarketplace_Configuration_Input
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [SoftLayer_Container_Network_CdnMarketplace_Configuration_Input]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/deleteGeoblocking'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/getGeoblocking/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/getGeoblocking/index.html deleted file mode 100644 index 6736628cc00..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/getGeoblocking/index.html +++ /dev/null @@ -1,346 +0,0 @@ - - - - - - - - - - - - - - - - getGeoblocking - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getGeoblocking

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking::getGeoblocking -

- - -
Deprecated
- -

- -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
inputSoftLayer_Container_Network_CdnMarketplace_Configuration_Input
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [SoftLayer_Container_Network_CdnMarketplace_Configuration_Input]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/getGeoblocking'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/getGeoblockingAllowedTypesAndRegions/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/getGeoblockingAllowedTypesAndRegions/index.html deleted file mode 100644 index ed2c0a1ec65..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/getGeoblockingAllowedTypesAndRegions/index.html +++ /dev/null @@ -1,345 +0,0 @@ - - - - - - - - - - - - - - - - getGeoblockingAllowedTypesAndRegions - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getGeoblockingAllowedTypesAndRegions

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking::getGeoblockingAllowedTypesAndRegions -

- - -
Deprecated
- -

- -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
uniqueIdstring
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/getGeoblockingAllowedTypesAndRegions'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/getObject/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/getObject/index.html deleted file mode 100644 index 3ff8fad793a..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/getObject/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getObject

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking::getObject -

- - -

- Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking record. -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/{SoftLayer_Network_CdnMarketplace_Configuration_Behavior_GeoblockingID}/getObject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/index.html deleted file mode 100644 index 3ae1a5a44f9..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/index.html +++ /dev/null @@ -1,358 +0,0 @@ - - - - - - - - - - - - - SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking

- - -
- -
- - -

Description

- -
Deprecated
- - - -
-

Methods

-
-
-
- -
-
-
-
- - - - - - - -
-

createGeoblocking

- -

- -
- - - - - -
-

deleteGeoblocking

- -

- -
- - - - - -
-

getGeoblocking

- -

- -
- - - - - - - - - -
-

getObject

- -

Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking record.

- -
- - - - - -
-

updateGeoblocking

- -

- -
- - -
-
- -
- -
-
- - - -
- - - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/updateGeoblocking/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/updateGeoblocking/index.html deleted file mode 100644 index d0e00ef9c0d..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/updateGeoblocking/index.html +++ /dev/null @@ -1,346 +0,0 @@ - - - - - - - - - - - - - - - - updateGeoblocking - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

updateGeoblocking

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking::updateGeoblocking -

- - -
Deprecated
- -

- -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
inputSoftLayer_Container_Network_CdnMarketplace_Configuration_Input
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [SoftLayer_Container_Network_CdnMarketplace_Configuration_Input]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking/updateGeoblocking'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/createHotlinkProtection/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/createHotlinkProtection/index.html deleted file mode 100644 index 85142c2d9b6..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/createHotlinkProtection/index.html +++ /dev/null @@ -1,346 +0,0 @@ - - - - - - - - - - - - - - - - createHotlinkProtection - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

createHotlinkProtection

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection::createHotlinkProtection -

- - -
Deprecated
- -

- -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
inputSoftLayer_Container_Network_CdnMarketplace_Configuration_Input
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [SoftLayer_Container_Network_CdnMarketplace_Configuration_Input]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/createHotlinkProtection'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/deleteHotlinkProtection/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/deleteHotlinkProtection/index.html deleted file mode 100644 index d4ae0489b78..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/deleteHotlinkProtection/index.html +++ /dev/null @@ -1,346 +0,0 @@ - - - - - - - - - - - - - - - - deleteHotlinkProtection - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

deleteHotlinkProtection

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection::deleteHotlinkProtection -

- - -
Deprecated
- -

- -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
inputSoftLayer_Container_Network_CdnMarketplace_Configuration_Input
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [SoftLayer_Container_Network_CdnMarketplace_Configuration_Input]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/deleteHotlinkProtection'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/getHotlinkProtection/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/getHotlinkProtection/index.html deleted file mode 100644 index 6b52aaeaec8..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/getHotlinkProtection/index.html +++ /dev/null @@ -1,346 +0,0 @@ - - - - - - - - - - - - - - - - getHotlinkProtection - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getHotlinkProtection

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection::getHotlinkProtection -

- - -
Deprecated
- -

- -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
inputSoftLayer_Container_Network_CdnMarketplace_Configuration_Input
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [SoftLayer_Container_Network_CdnMarketplace_Configuration_Input]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/getHotlinkProtection'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/getObject/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/getObject/index.html deleted file mode 100644 index 85da95d4221..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/getObject/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getObject

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection::getObject -

- - -

- Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection record. -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/{SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtectionID}/getObject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/index.html deleted file mode 100644 index 0467a063310..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/index.html +++ /dev/null @@ -1,347 +0,0 @@ - - - - - - - - - - - - - SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection

- - -
- -
- - -

Description

- -
Deprecated
- - - -
-

Methods

-
-
-
- -
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - -
-

getObject

- -

Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection record.

- -
- - - - - - - - -
-
- -
- -
-
- - - -
- - - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/updateHotlinkProtection/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/updateHotlinkProtection/index.html deleted file mode 100644 index 0dae52eb443..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/updateHotlinkProtection/index.html +++ /dev/null @@ -1,346 +0,0 @@ - - - - - - - - - - - - - - - - updateHotlinkProtection - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

updateHotlinkProtection

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection::updateHotlinkProtection -

- - -
Deprecated
- -

- -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
inputSoftLayer_Container_Network_CdnMarketplace_Configuration_Input
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [SoftLayer_Container_Network_CdnMarketplace_Configuration_Input]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection/updateHotlinkProtection'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/createModifyResponseHeader/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/createModifyResponseHeader/index.html deleted file mode 100644 index cb2897e5160..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/createModifyResponseHeader/index.html +++ /dev/null @@ -1,346 +0,0 @@ - - - - - - - - - - - - - - - - createModifyResponseHeader - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

createModifyResponseHeader

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader::createModifyResponseHeader -

- - -
Deprecated
- -

- DEPRECATED -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
inputSoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/createModifyResponseHeader'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/deleteModifyResponseHeader/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/deleteModifyResponseHeader/index.html deleted file mode 100644 index 3bda249a457..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/deleteModifyResponseHeader/index.html +++ /dev/null @@ -1,355 +0,0 @@ - - - - - - - - - - - - - - - - deleteModifyResponseHeader - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

deleteModifyResponseHeader

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader::deleteModifyResponseHeader -

- - -
Deprecated
- -

- DEPRECATED -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
uniqueIdstring
modResHeaderUniqueIdstring
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - string - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string, string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/deleteModifyResponseHeader'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/getObject/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/getObject/index.html deleted file mode 100644 index f92841a5cf9..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/getObject/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getObject

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader::getObject -

- - -

- Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader record. -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/{SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeaderID}/getObject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/index.html deleted file mode 100644 index 5f7c0d70719..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/index.html +++ /dev/null @@ -1,347 +0,0 @@ - - - - - - - - - - - - - SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader

- - -
- -
- - -

Description

- -
Deprecated
- - This class is deprecated and will be removed in future. - -
-

Methods

-
-
-
- -
-
-
-
- - - - - - - -
-

createModifyResponseHeader

- -

DEPRECATED

- -
- - - - - -
-

deleteModifyResponseHeader

- -

DEPRECATED

- -
- - - -
-

getObject

- -

Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader record.

- -
- - - - - -
-

listModifyResponseHeader

- -

DEPRECATED

- -
- - - - - -
-

updateModifyResponseHeader

- -

DEPRECATED

- -
- - -
-
- -
- -
-
- - - -
- - - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/listModifyResponseHeader/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/listModifyResponseHeader/index.html deleted file mode 100644 index 2f916186e88..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/listModifyResponseHeader/index.html +++ /dev/null @@ -1,347 +0,0 @@ - - - - - - - - - - - - - - - - listModifyResponseHeader - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

listModifyResponseHeader

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader::listModifyResponseHeader -

- - -
Deprecated
- -

- DEPRECATED -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
uniqueIdstring
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/listModifyResponseHeader'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/updateModifyResponseHeader/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/updateModifyResponseHeader/index.html deleted file mode 100644 index d86e1ca53c9..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/updateModifyResponseHeader/index.html +++ /dev/null @@ -1,348 +0,0 @@ - - - - - - - - - - - - - - - - updateModifyResponseHeader - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

updateModifyResponseHeader

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader::updateModifyResponseHeader -

- - -
Deprecated
- -

- DEPRECATED -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
inputSoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader/updateModifyResponseHeader'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/createTokenAuthPath/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/createTokenAuthPath/index.html deleted file mode 100644 index 3e4c153b677..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/createTokenAuthPath/index.html +++ /dev/null @@ -1,348 +0,0 @@ - - - - - - - - - - - - - - - - createTokenAuthPath - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

createTokenAuthPath

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth::createTokenAuthPath -

- - -
Deprecated
- -

- DEPRECATED -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
inputSoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_TokenAuth
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_TokenAuth]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/createTokenAuthPath'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/deleteTokenAuthPath/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/deleteTokenAuthPath/index.html deleted file mode 100644 index 4aec585c125..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/deleteTokenAuthPath/index.html +++ /dev/null @@ -1,355 +0,0 @@ - - - - - - - - - - - - - - - - deleteTokenAuthPath - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

deleteTokenAuthPath

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth::deleteTokenAuthPath -

- - -
Deprecated
- -

- DEPRECATED -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
uniqueIdstring
pathstring
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - string - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string, string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/deleteTokenAuthPath'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/getObject/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/getObject/index.html deleted file mode 100644 index 01a7bb6b97e..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/getObject/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getObject

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth::getObject -

- - -

- Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth record. -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/{SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuthID}/getObject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/index.html deleted file mode 100644 index 1ca45264ee2..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/index.html +++ /dev/null @@ -1,347 +0,0 @@ - - - - - - - - - - - - - SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth

- - -
- -
- - -

Description

- -
Deprecated
- - This service manages the paths for domain mapping configurations. - -
-

Methods

-
-
-
- -
-
-
-
- - - - - - - -
-

createTokenAuthPath

- -

DEPRECATED

- -
- - - - - -
-

deleteTokenAuthPath

- -

DEPRECATED

- -
- - - -
-

getObject

- -

Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth record.

- -
- - - - - -
-

listTokenAuthPath

- -

DEPRECATED

- -
- - - - - -
-

updateTokenAuthPath

- -

DEPRECATED

- -
- - -
-
- -
- -
-
- - - -
- - - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/listTokenAuthPath/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/listTokenAuthPath/index.html deleted file mode 100644 index 6f6b463bd7c..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/listTokenAuthPath/index.html +++ /dev/null @@ -1,347 +0,0 @@ - - - - - - - - - - - - - - - - listTokenAuthPath - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

listTokenAuthPath

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth::listTokenAuthPath -

- - -
Deprecated
- -

- DEPRECATED -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
uniqueIdstring
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/listTokenAuthPath'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/updateTokenAuthPath/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/updateTokenAuthPath/index.html deleted file mode 100644 index 84f86982bff..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/updateTokenAuthPath/index.html +++ /dev/null @@ -1,348 +0,0 @@ - - - - - - - - - - - - - - - - updateTokenAuthPath - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

updateTokenAuthPath

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth::updateTokenAuthPath -

- - -
Deprecated
- -

- DEPRECATED -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
inputSoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_TokenAuth
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_TokenAuth]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth/updateTokenAuthPath'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/createPurge/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/createPurge/index.html deleted file mode 100644 index aa8cc3f1d49..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/createPurge/index.html +++ /dev/null @@ -1,357 +0,0 @@ - - - - - - - - - - - - - - - - createPurge - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

createPurge

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge::createPurge -

- - -
Deprecated
- -

- DEPRECATED -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
uniqueIdstring
pathstring
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string, string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/createPurge'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/getObject/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/getObject/index.html deleted file mode 100644 index 9fca43a6703..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/getObject/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getObject

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge::getObject -

- - -

- Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge record. -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/{SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeID}/getObject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/getPurgeHistoryPerMapping/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/getPurgeHistoryPerMapping/index.html deleted file mode 100644 index 1a76efae705..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/getPurgeHistoryPerMapping/index.html +++ /dev/null @@ -1,357 +0,0 @@ - - - - - - - - - - - - - - - - getPurgeHistoryPerMapping - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getPurgeHistoryPerMapping

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge::getPurgeHistoryPerMapping -

- - -
Deprecated
- -

- DEPRECATED -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
uniqueIdstring
savedint
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string, int]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/getPurgeHistoryPerMapping'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/getPurgeStatus/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/getPurgeStatus/index.html deleted file mode 100644 index 833dba3618d..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/getPurgeStatus/index.html +++ /dev/null @@ -1,357 +0,0 @@ - - - - - - - - - - - - - - - - getPurgeStatus - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getPurgeStatus

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge::getPurgeStatus -

- - -
Deprecated
- -

- DEPRECATED -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
uniqueIdstring
pathstring
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string, string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/getPurgeStatus'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/index.html deleted file mode 100644 index 80d104f9719..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/index.html +++ /dev/null @@ -1,347 +0,0 @@ - - - - - - - - - - - - - SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge

- - -
- -
- - -

Description

- -
Deprecated
- - This class is deprecated and will be removed in future. - -
-

Methods

-
-
-
- -
-
-
-
- - - - - - - -
-

createPurge

- -

DEPRECATED

- -
- - - -
-

getObject

- -

Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge record.

- -
- - - - - -
-

getPurgeHistoryPerMapping

- -

DEPRECATED

- -
- - - - - -
-

getPurgeStatus

- -

DEPRECATED

- -
- - - - - -
-

saveOrUnsavePurgePath

- -

DEPRECATED

- -
- - -
-
- -
- -
-
- - - -
- - - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/saveOrUnsavePurgePath/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/saveOrUnsavePurgePath/index.html deleted file mode 100644 index bdf802be3b9..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/saveOrUnsavePurgePath/index.html +++ /dev/null @@ -1,367 +0,0 @@ - - - - - - - - - - - - - - - - saveOrUnsavePurgePath - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

saveOrUnsavePurgePath

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge::saveOrUnsavePurgePath -

- - -
Deprecated
- -

- DEPRECATED -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
uniqueIdstring
pathstring
saveOrUnsaveint
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string, string, int]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge/saveOrUnsavePurgePath'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/createPurgeGroup/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/createPurgeGroup/index.html deleted file mode 100644 index 99da5fae698..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/createPurgeGroup/index.html +++ /dev/null @@ -1,377 +0,0 @@ - - - - - - - - - - - - - - - - createPurgeGroup - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

createPurgeGroup

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup::createPurgeGroup -

- - -
Deprecated
- -

- DEPRECATED -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
uniqueIdstringDomain mapping uniqueID
groupNamestringName of purge group
pathsstring[]Array of paths
optionint
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string, string, string, int]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/createPurgeGroup'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/getObject/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/getObject/index.html deleted file mode 100644 index 7973fc76099..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/getObject/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getObject

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup::getObject -

- - -

- Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup record. -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/{SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroupID}/getObject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/getPurgeGroupByGroupId/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/getPurgeGroupByGroupId/index.html deleted file mode 100644 index 21a61184206..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/getPurgeGroupByGroupId/index.html +++ /dev/null @@ -1,355 +0,0 @@ - - - - - - - - - - - - - - - - getPurgeGroupByGroupId - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getPurgeGroupByGroupId

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup::getPurgeGroupByGroupId -

- - -
Deprecated
- -

- DEPRECATED -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
uniqueIdstringDomain mapping uniqueID
groupUniqueIdstringPurge group uniqueID
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string, string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/getPurgeGroupByGroupId'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/getPurgeGroupQuota/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/getPurgeGroupQuota/index.html deleted file mode 100644 index c393426472c..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/getPurgeGroupQuota/index.html +++ /dev/null @@ -1,324 +0,0 @@ - - - - - - - - - - - - - - - - getPurgeGroupQuota - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getPurgeGroupQuota

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup::getPurgeGroupQuota -

- - -
Deprecated
- -

- DEPRECATED -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - int - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/getPurgeGroupQuota'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/index.html deleted file mode 100644 index 56db1e45cdd..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/index.html +++ /dev/null @@ -1,391 +0,0 @@ - - - - - - - - - - - - - SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup

- - -
- -
- - -

Description

- -
Deprecated
- - This class is deprecated and will be removed in future. - -
-

Methods

-
-
-
- -
-
-
-
- - - - - - - -
-

createPurgeGroup

- -

DEPRECATED

- -
- - - -
-

getObject

- -

Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup record.

- -
- - - - - -
-

getPurgeGroupByGroupId

- -

DEPRECATED

- -
- - - - - -
-

getPurgeGroupQuota

- -

DEPRECATED

- -
- - - - - -
-

listFavoriteGroup

- -

DEPRECATED

- -
- - - - - -
-

listUnfavoriteGroup

- -

DEPRECATED

- -
- - - - - -
-

purgeByGroupIds

- -

DEPRECATED

- -
- - - - - -
-

removePurgeGroupFromFavorite

- -

DEPRECATED

- -
- - - - - -
-

savePurgeGroupAsFavorite

- -

DEPRECATED

- -
- - -
-
- -
- -
-
- - - -
- - - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/listFavoriteGroup/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/listFavoriteGroup/index.html deleted file mode 100644 index b26d87871eb..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/listFavoriteGroup/index.html +++ /dev/null @@ -1,347 +0,0 @@ - - - - - - - - - - - - - - - - listFavoriteGroup - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

listFavoriteGroup

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup::listFavoriteGroup -

- - -
Deprecated
- -

- DEPRECATED -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
uniqueIdstringDomain mapping uniqueID
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/listFavoriteGroup'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/listUnfavoriteGroup/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/listUnfavoriteGroup/index.html deleted file mode 100644 index 88cb1a04078..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/listUnfavoriteGroup/index.html +++ /dev/null @@ -1,347 +0,0 @@ - - - - - - - - - - - - - - - - listUnfavoriteGroup - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

listUnfavoriteGroup

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup::listUnfavoriteGroup -

- - -
Deprecated
- -

- DEPRECATED -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
uniqueIdstringDomain mapping uniqueID
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/listUnfavoriteGroup'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/purgeByGroupIds/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/purgeByGroupIds/index.html deleted file mode 100644 index fbd341646c8..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/purgeByGroupIds/index.html +++ /dev/null @@ -1,359 +0,0 @@ - - - - - - - - - - - - - - - - purgeByGroupIds - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

purgeByGroupIds

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup::purgeByGroupIds -

- - -
Deprecated
- -

- DEPRECATED -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
uniqueIdstringDomain mapping uniqueID
groupUniqueIdsstring[]Array of purge group uniqueID
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string, string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/purgeByGroupIds'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/removePurgeGroupFromFavorite/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/removePurgeGroupFromFavorite/index.html deleted file mode 100644 index b6169ada415..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/removePurgeGroupFromFavorite/index.html +++ /dev/null @@ -1,355 +0,0 @@ - - - - - - - - - - - - - - - - removePurgeGroupFromFavorite - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

removePurgeGroupFromFavorite

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup::removePurgeGroupFromFavorite -

- - -
Deprecated
- -

- DEPRECATED -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
uniqueIdstringDomain mapping uniqueID
groupUniqueIdstringPurge group uniqueID
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string, string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/removePurgeGroupFromFavorite'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/savePurgeGroupAsFavorite/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/savePurgeGroupAsFavorite/index.html deleted file mode 100644 index 85f501a4e5f..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/savePurgeGroupAsFavorite/index.html +++ /dev/null @@ -1,355 +0,0 @@ - - - - - - - - - - - - - - - - savePurgeGroupAsFavorite - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

savePurgeGroupAsFavorite

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup::savePurgeGroupAsFavorite -

- - -
Deprecated
- -

- DEPRECATED -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
uniqueIdstringDomain mapping uniqueID
groupUniqueIdstringPurge group uniqueID
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string, string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/savePurgeGroupAsFavorite'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory/getObject/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory/getObject/index.html deleted file mode 100644 index 9f79f97bff4..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory/getObject/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getObject

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory::getObject -

- - -

- Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory record. -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory/{SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistoryID}/getObject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory/index.html deleted file mode 100644 index 0d654efbd17..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory/index.html +++ /dev/null @@ -1,314 +0,0 @@ - - - - - - - - - - - - - SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory

- - -
- -
- - -

Description

- -
Deprecated
- - This class is deprecated and will be removed in future. - -
-

Methods

-
-
-
- -
-
-
-
- - - - - -
-

getObject

- -

Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory record.

- -
- - - - - -
-

listPurgeGroupHistory

- -

DEPRECATED

- -
- - -
-
- -
- -
-
- - - -
- - - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory/listPurgeGroupHistory/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory/listPurgeGroupHistory/index.html deleted file mode 100644 index 98c2e0b3698..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory/listPurgeGroupHistory/index.html +++ /dev/null @@ -1,347 +0,0 @@ - - - - - - - - - - - - - - - - listPurgeGroupHistory - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

listPurgeGroupHistory

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory::listPurgeGroupHistory -

- - -
Deprecated
- -

- DEPRECATED -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
uniqueIdstringDomain mapping uniqueID
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory/listPurgeGroupHistory'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/createTimeToLive/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/createTimeToLive/index.html deleted file mode 100644 index 78b099118d6..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/createTimeToLive/index.html +++ /dev/null @@ -1,365 +0,0 @@ - - - - - - - - - - - - - - - - createTimeToLive - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

createTimeToLive

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive::createTimeToLive -

- - -
Deprecated
- -

- DEPRECATED -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
uniqueIdstring
pathNamestring
ttlstring
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - string - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string, string, string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/createTimeToLive'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/deleteTimeToLive/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/deleteTimeToLive/index.html deleted file mode 100644 index c56638f1816..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/deleteTimeToLive/index.html +++ /dev/null @@ -1,355 +0,0 @@ - - - - - - - - - - - - - - - - deleteTimeToLive - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

deleteTimeToLive

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive::deleteTimeToLive -

- - -
Deprecated
- -

- -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
uniqueIdstring
pathNamestring
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - string - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string, string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/deleteTimeToLive'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/getObject/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/getObject/index.html deleted file mode 100644 index 316a2aabb24..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/getObject/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getObject

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive::getObject -

- - -

- Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive record. -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/{SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLiveID}/getObject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/index.html deleted file mode 100644 index 67990acd7f5..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/index.html +++ /dev/null @@ -1,347 +0,0 @@ - - - - - - - - - - - - - SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive

- - -
- -
- - -

Description

- -
Deprecated
- - This class is deprecated and will be removed in future. - -
-

Methods

-
-
-
- -
-
-
-
- - - - - - - -
-

createTimeToLive

- -

DEPRECATED

- -
- - - - - -
-

deleteTimeToLive

- -

- -
- - - -
-

getObject

- -

Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive record.

- -
- - - - - -
-

listTimeToLive

- -

- -
- - - - - -
-

updateTimeToLive

- -

DEPRECATED

- -
- - -
-
- -
- -
-
- - - -
- - - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/listTimeToLive/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/listTimeToLive/index.html deleted file mode 100644 index 82f1d8d26f3..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/listTimeToLive/index.html +++ /dev/null @@ -1,347 +0,0 @@ - - - - - - - - - - - - - - - - listTimeToLive - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

listTimeToLive

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive::listTimeToLive -

- - -
Deprecated
- -

- -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
uniqueIdstring
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/listTimeToLive'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/updateTimeToLive/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/updateTimeToLive/index.html deleted file mode 100644 index e2d60775390..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/updateTimeToLive/index.html +++ /dev/null @@ -1,385 +0,0 @@ - - - - - - - - - - - - - - - - updateTimeToLive - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

updateTimeToLive

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive::updateTimeToLive -

- - -
Deprecated
- -

- DEPRECATED -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
uniqueIdstring
oldPathstring
newPathstring
oldTtlstring
newTtlstring
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - string - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string, string, string, string, string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive/updateTimeToLive'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/createDomainMapping/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/createDomainMapping/index.html deleted file mode 100644 index 91be47a8b02..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/createDomainMapping/index.html +++ /dev/null @@ -1,346 +0,0 @@ - - - - - - - - - - - - - - - - createDomainMapping - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

createDomainMapping

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Configuration_Mapping::createDomainMapping -

- - -

- DEPRECATED -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
inputSoftLayer_Container_Network_CdnMarketplace_Configuration_Input
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [SoftLayer_Container_Network_CdnMarketplace_Configuration_Input]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/createDomainMapping'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/deleteDomainMapping/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/deleteDomainMapping/index.html deleted file mode 100644 index 46f37c22ea7..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/deleteDomainMapping/index.html +++ /dev/null @@ -1,345 +0,0 @@ - - - - - - - - - - - - - - - - deleteDomainMapping - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

deleteDomainMapping

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Configuration_Mapping::deleteDomainMapping -

- - -

- DEPRECATED -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
uniqueIdstring
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/deleteDomainMapping'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/getObject/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/getObject/index.html deleted file mode 100644 index 73cb1a4ce43..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/getObject/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getObject

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Configuration_Mapping::getObject -

- - -

- Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Mapping record. -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/{SoftLayer_Network_CdnMarketplace_Configuration_MappingID}/getObject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/index.html deleted file mode 100644 index c443db0b2b4..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/index.html +++ /dev/null @@ -1,393 +0,0 @@ - - - - - - - - - - - - - SoftLayer_Network_CdnMarketplace_Configuration_Mapping - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_CdnMarketplace_Configuration_Mapping

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Network_CdnMarketplace_Configuration_Mapping

- - -
- -
- - -

Description

- -
Deprecated
- - This class is deprecated and will be removed in future. - -
-

Methods

-
-
-
- -
-
-
-
- - - - - -
-

createDomainMapping

- -

DEPRECATED

- -
- - - -
-

deleteDomainMapping

- -

DEPRECATED

- -
- - - -
-

getObject

- -

Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Mapping record.

- -
- - - -
-

listDomainMappingByUniqueId

- -

DEPRECATED

- -
- - - -
-

listDomainMappings

- -

DEPRECATED

- -
- - - -
-

retryHttpsActionRequest

- -

DEPRECATED

- -
- - - -
-

startDomainMapping

- -

DEPRECATED

- -
- - - -
-

stopDomainMapping

- -

DEPRECATED

- -
- - - -
-

updateDomainMapping

- -

DEPRECATED

- -
- - - -
-

verifyCname

- -

DEPRECATED

- -
- - - -
-

verifyDomainMapping

- -

DEPRECATED

- -
- - -
-
- -
- -
-
- - - -
- - - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/listDomainMappingByUniqueId/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/listDomainMappingByUniqueId/index.html deleted file mode 100644 index dbe166d6fd7..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/listDomainMappingByUniqueId/index.html +++ /dev/null @@ -1,345 +0,0 @@ - - - - - - - - - - - - - - - - listDomainMappingByUniqueId - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

listDomainMappingByUniqueId

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Configuration_Mapping::listDomainMappingByUniqueId -

- - -

- DEPRECATED -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
uniqueIdstring
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/listDomainMappingByUniqueId'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/listDomainMappings/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/listDomainMappings/index.html deleted file mode 100644 index 00b5a81f0ff..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/listDomainMappings/index.html +++ /dev/null @@ -1,324 +0,0 @@ - - - - - - - - - - - - - - - - listDomainMappings - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

listDomainMappings

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Configuration_Mapping::listDomainMappings -

- - -

- DEPRECATED -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/listDomainMappings'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/retryHttpsActionRequest/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/retryHttpsActionRequest/index.html deleted file mode 100644 index cc799decec2..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/retryHttpsActionRequest/index.html +++ /dev/null @@ -1,345 +0,0 @@ - - - - - - - - - - - - - - - - retryHttpsActionRequest - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

retryHttpsActionRequest

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Configuration_Mapping::retryHttpsActionRequest -

- - -

- DEPRECATED -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
uniqueIdstring
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/retryHttpsActionRequest'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/startDomainMapping/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/startDomainMapping/index.html deleted file mode 100644 index 0969592b20d..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/startDomainMapping/index.html +++ /dev/null @@ -1,345 +0,0 @@ - - - - - - - - - - - - - - - - startDomainMapping - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

startDomainMapping

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Configuration_Mapping::startDomainMapping -

- - -

- DEPRECATED -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
uniqueIdstring
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/startDomainMapping'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/stopDomainMapping/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/stopDomainMapping/index.html deleted file mode 100644 index 1414268b4d9..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/stopDomainMapping/index.html +++ /dev/null @@ -1,345 +0,0 @@ - - - - - - - - - - - - - - - - stopDomainMapping - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

stopDomainMapping

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Configuration_Mapping::stopDomainMapping -

- - -

- DEPRECATED -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
uniqueIdstring
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/stopDomainMapping'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/updateDomainMapping/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/updateDomainMapping/index.html deleted file mode 100644 index febf8ed5abb..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/updateDomainMapping/index.html +++ /dev/null @@ -1,346 +0,0 @@ - - - - - - - - - - - - - - - - updateDomainMapping - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

updateDomainMapping

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Configuration_Mapping::updateDomainMapping -

- - -

- DEPRECATED -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
inputSoftLayer_Container_Network_CdnMarketplace_Configuration_Input
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [SoftLayer_Container_Network_CdnMarketplace_Configuration_Input]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/updateDomainMapping'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/verifyCname/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/verifyCname/index.html deleted file mode 100644 index cdc715b6a53..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/verifyCname/index.html +++ /dev/null @@ -1,343 +0,0 @@ - - - - - - - - - - - - - - - - verifyCname - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

verifyCname

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Configuration_Mapping::verifyCname -

- - -

- DEPRECATED -

-

Description

- - DEPRECATED - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
cnamestring
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - boolean - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/verifyCname'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/verifyDomainMapping/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/verifyDomainMapping/index.html deleted file mode 100644 index 52be57243b9..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/verifyDomainMapping/index.html +++ /dev/null @@ -1,345 +0,0 @@ - - - - - - - - - - - - - - - - verifyDomainMapping - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

verifyDomainMapping

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Configuration_Mapping::verifyDomainMapping -

- - -

- DEPRECATED -

-

Description

- - DEPRECATED - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
uniqueIdint
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [int]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/verifyDomainMapping'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/createOriginPath/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/createOriginPath/index.html deleted file mode 100644 index 49928579d85..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/createOriginPath/index.html +++ /dev/null @@ -1,348 +0,0 @@ - - - - - - - - - - - - - - - - createOriginPath - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

createOriginPath

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path::createOriginPath -

- - -
Deprecated
- -

- DEPRECATED -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
inputSoftLayer_Container_Network_CdnMarketplace_Configuration_Input
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [SoftLayer_Container_Network_CdnMarketplace_Configuration_Input]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/createOriginPath'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/deleteOriginPath/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/deleteOriginPath/index.html deleted file mode 100644 index bd32c88bae2..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/deleteOriginPath/index.html +++ /dev/null @@ -1,355 +0,0 @@ - - - - - - - - - - - - - - - - deleteOriginPath - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

deleteOriginPath

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path::deleteOriginPath -

- - -
Deprecated
- -

- DEPRECATED -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
uniqueIdstring
pathstring
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - string - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string, string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/deleteOriginPath'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/getObject/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/getObject/index.html deleted file mode 100644 index c4ee0c143ca..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/getObject/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getObject

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path::getObject -

- - -

- Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path record. -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/{SoftLayer_Network_CdnMarketplace_Configuration_Mapping_PathID}/getObject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/index.html deleted file mode 100644 index d8989bcab82..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/index.html +++ /dev/null @@ -1,347 +0,0 @@ - - - - - - - - - - - - - SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path

- - -
- -
- - -

Description

- -
Deprecated
- - This class is deprecated and will be removed in future. - -
-

Methods

-
-
-
- -
-
-
-
- - - - - - - -
-

createOriginPath

- -

DEPRECATED

- -
- - - - - -
-

deleteOriginPath

- -

DEPRECATED

- -
- - - -
-

getObject

- -

Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path record.

- -
- - - - - -
-

listOriginPath

- -

DEPRECATED

- -
- - - - - -
-

updateOriginPath

- -

DEPRECATED

- -
- - -
-
- -
- -
-
- - - -
- - - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/listOriginPath/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/listOriginPath/index.html deleted file mode 100644 index f826d506e3f..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/listOriginPath/index.html +++ /dev/null @@ -1,347 +0,0 @@ - - - - - - - - - - - - - - - - listOriginPath - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

listOriginPath

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path::listOriginPath -

- - -
Deprecated
- -

- DEPRECATED -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
uniqueIdstring
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/listOriginPath'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/updateOriginPath/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/updateOriginPath/index.html deleted file mode 100644 index 1ab11a3b936..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/updateOriginPath/index.html +++ /dev/null @@ -1,348 +0,0 @@ - - - - - - - - - - - - - - - - updateOriginPath - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

updateOriginPath

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path::updateOriginPath -

- - -
Deprecated
- -

- DEPRECATED -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
inputSoftLayer_Container_Network_CdnMarketplace_Configuration_Input
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [SoftLayer_Container_Network_CdnMarketplace_Configuration_Input]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path/updateOriginPath'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getCustomerInvoicingMetrics/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getCustomerInvoicingMetrics/index.html deleted file mode 100644 index a8b84cea9ff..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getCustomerInvoicingMetrics/index.html +++ /dev/null @@ -1,375 +0,0 @@ - - - - - - - - - - - - - - - - getCustomerInvoicingMetrics - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getCustomerInvoicingMetrics

-
-
-
-
-
- Classes - - SoftLayer_Network_CdnMarketplace_Metrics - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Metrics::getCustomerInvoicingMetrics -

- - -

- DEPRECATED -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
vendorNamestring
startDateintThe start data timestamp(UTC+0), the date can not be earlier than 93 days ago
endDateintThe end data timestamp(UTC+0), the date can not be later than 3 days ago
frequencystringThe frequency for query, supported type ‘day’, ‘aggregate’
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string, int, int, string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Metrics/getCustomerInvoicingMetrics'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getCustomerRealTimeMetrics/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getCustomerRealTimeMetrics/index.html deleted file mode 100644 index 8f6453681e4..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getCustomerRealTimeMetrics/index.html +++ /dev/null @@ -1,375 +0,0 @@ - - - - - - - - - - - - - - - - getCustomerRealTimeMetrics - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getCustomerRealTimeMetrics

-
-
-
-
-
- Classes - - SoftLayer_Network_CdnMarketplace_Metrics - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Metrics::getCustomerRealTimeMetrics -

- - -

- DEPRECATED -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
vendorNamestring
startTimeint
endTimeint
timeIntervalint
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string, int, int, int]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Metrics/getCustomerRealTimeMetrics'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getCustomerUsageMetrics/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getCustomerUsageMetrics/index.html deleted file mode 100644 index 0234ec01d63..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getCustomerUsageMetrics/index.html +++ /dev/null @@ -1,375 +0,0 @@ - - - - - - - - - - - - - - - - getCustomerUsageMetrics - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getCustomerUsageMetrics

-
-
-
-
-
- Classes - - SoftLayer_Network_CdnMarketplace_Metrics - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Metrics::getCustomerUsageMetrics -

- - -

- DEPRECATED -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
vendorNamestring
startDateint
endDateint
frequencystring
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string, int, int, string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Metrics/getCustomerUsageMetrics'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingBandwidthByRegionMetrics/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingBandwidthByRegionMetrics/index.html deleted file mode 100644 index 1c49017c5bd..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingBandwidthByRegionMetrics/index.html +++ /dev/null @@ -1,375 +0,0 @@ - - - - - - - - - - - - - - - - getMappingBandwidthByRegionMetrics - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getMappingBandwidthByRegionMetrics

-
-
-
-
-
- Classes - - SoftLayer_Network_CdnMarketplace_Metrics - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Metrics::getMappingBandwidthByRegionMetrics -

- - -

- DEPRECATED -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
mappingUniqueIdstring
startDateint
endDateint
frequencystring
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string, int, int, string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Metrics/getMappingBandwidthByRegionMetrics'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingBandwidthMetrics/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingBandwidthMetrics/index.html deleted file mode 100644 index 107af8956d5..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingBandwidthMetrics/index.html +++ /dev/null @@ -1,375 +0,0 @@ - - - - - - - - - - - - - - - - getMappingBandwidthMetrics - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getMappingBandwidthMetrics

-
-
-
-
-
- Classes - - SoftLayer_Network_CdnMarketplace_Metrics - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Metrics::getMappingBandwidthMetrics -

- - -

- DEPRECATED -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
mappingUniqueIdstring
startDateint
endDateint
frequencystring
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string, int, int, string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Metrics/getMappingBandwidthMetrics'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingHitsByTypeMetrics/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingHitsByTypeMetrics/index.html deleted file mode 100644 index 42359a3555c..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingHitsByTypeMetrics/index.html +++ /dev/null @@ -1,375 +0,0 @@ - - - - - - - - - - - - - - - - getMappingHitsByTypeMetrics - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getMappingHitsByTypeMetrics

-
-
-
-
-
- Classes - - SoftLayer_Network_CdnMarketplace_Metrics - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Metrics::getMappingHitsByTypeMetrics -

- - -

- DEPRECATED -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
mappingUniqueIdstring
startDateint
endDateint
frequencystring
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string, int, int, string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Metrics/getMappingHitsByTypeMetrics'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingHitsMetrics/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingHitsMetrics/index.html deleted file mode 100644 index 123e7e2508d..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingHitsMetrics/index.html +++ /dev/null @@ -1,375 +0,0 @@ - - - - - - - - - - - - - - - - getMappingHitsMetrics - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getMappingHitsMetrics

-
-
-
-
-
- Classes - - SoftLayer_Network_CdnMarketplace_Metrics - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Metrics::getMappingHitsMetrics -

- - -

- DEPRECATED -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
mappingUniqueIdstring
startDateint
endDateint
frequencystring
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string, int, int, string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Metrics/getMappingHitsMetrics'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingIntegratedMetrics/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingIntegratedMetrics/index.html deleted file mode 100644 index 0755571ad98..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingIntegratedMetrics/index.html +++ /dev/null @@ -1,375 +0,0 @@ - - - - - - - - - - - - - - - - getMappingIntegratedMetrics - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getMappingIntegratedMetrics

-
-
-
-
-
- Classes - - SoftLayer_Network_CdnMarketplace_Metrics - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Metrics::getMappingIntegratedMetrics -

- - -

- DEPRECATED -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
mappingUniqueIdstring
startTimeint
endTimeint
frequencystring
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string, int, int, string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Metrics/getMappingIntegratedMetrics'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingRealTimeMetrics/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingRealTimeMetrics/index.html deleted file mode 100644 index 3795032f9e2..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingRealTimeMetrics/index.html +++ /dev/null @@ -1,375 +0,0 @@ - - - - - - - - - - - - - - - - getMappingRealTimeMetrics - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getMappingRealTimeMetrics

-
-
-
-
-
- Classes - - SoftLayer_Network_CdnMarketplace_Metrics - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Metrics::getMappingRealTimeMetrics -

- - -

- DEPRECATED -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
mappingUniqueIdstring
startTimeint
endTimeint
timeIntervalint
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string, int, int, int]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Metrics/getMappingRealTimeMetrics'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingUsageMetrics/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingUsageMetrics/index.html deleted file mode 100644 index bca8960becc..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/getMappingUsageMetrics/index.html +++ /dev/null @@ -1,375 +0,0 @@ - - - - - - - - - - - - - - - - getMappingUsageMetrics - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getMappingUsageMetrics

-
-
-
-
-
- Classes - - SoftLayer_Network_CdnMarketplace_Metrics - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Metrics::getMappingUsageMetrics -

- - -

- DEPRECATED -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
mappingUniqueIdstring
startDateint
endDateint
frequencystring
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string, int, int, string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Metrics/getMappingUsageMetrics'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/index.html deleted file mode 100644 index 1ba45973936..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Metrics/index.html +++ /dev/null @@ -1,384 +0,0 @@ - - - - - - - - - - - - - SoftLayer_Network_CdnMarketplace_Metrics - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_CdnMarketplace_Metrics

-
-
-
-
-
- Classes - - SoftLayer_Network_CdnMarketplace_Metrics - -
- Tags - - service - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Network_CdnMarketplace_Metrics

- - -
- -
- - -

Description

- -
Deprecated
- - This class is deprecated and will be removed in future. - -
-

Methods

-
-
-
- -
-
-
-
- - - - - -
-

getCustomerInvoicingMetrics

- -

DEPRECATED

- -
- - - -
-

getCustomerRealTimeMetrics

- -

DEPRECATED

- -
- - - -
-

getCustomerUsageMetrics

- -

DEPRECATED

- -
- - - -
-

getMappingBandwidthByRegionMetrics

- -

DEPRECATED

- -
- - - -
-

getMappingBandwidthMetrics

- -

DEPRECATED

- -
- - - -
-

getMappingHitsByTypeMetrics

- -

DEPRECATED

- -
- - - -
-

getMappingHitsMetrics

- -

DEPRECATED

- -
- - - -
-

getMappingIntegratedMetrics

- -

DEPRECATED

- -
- - - -
-

getMappingRealTimeMetrics

- -

DEPRECATED

- -
- - - -
-

getMappingUsageMetrics

- -

DEPRECATED

- -
- - -
-
- -
- -
-
- - - -
- - - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Vendor/getObject/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Vendor/getObject/index.html deleted file mode 100644 index 9fb5498b15f..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Vendor/getObject/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getObject

-
-
-
-
-
- Classes - - SoftLayer_Network_CdnMarketplace_Vendor - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Vendor::getObject -

- - -

- Retrieve a SoftLayer_Network_CdnMarketplace_Vendor record. -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Vendor/{SoftLayer_Network_CdnMarketplace_VendorID}/getObject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Vendor/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Vendor/index.html deleted file mode 100644 index 87c4cdb083c..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Vendor/index.html +++ /dev/null @@ -1,312 +0,0 @@ - - - - - - - - - - - - - SoftLayer_Network_CdnMarketplace_Vendor - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_CdnMarketplace_Vendor

-
-
-
-
-
- Classes - - SoftLayer_Network_CdnMarketplace_Vendor - -
- Tags - - service - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Network_CdnMarketplace_Vendor

- - -
- -
- - -

Description

- -
Deprecated
- - This class is deprecated and will be removed in future. - -
-

Methods

-
-
-
- -
-
-
-
- - - - - -
-

getObject

- -

Retrieve a SoftLayer_Network_CdnMarketplace_Vendor record.

- -
- - - -
-

listVendors

- -

DEPRECATED

- -
- - -
-
- -
- -
-
- - - -
- - - - - - - diff --git a/reference/services/SoftLayer_Network_CdnMarketplace_Vendor/listVendors/index.html b/reference/services/SoftLayer_Network_CdnMarketplace_Vendor/listVendors/index.html deleted file mode 100644 index 4b5bbd073f7..00000000000 --- a/reference/services/SoftLayer_Network_CdnMarketplace_Vendor/listVendors/index.html +++ /dev/null @@ -1,324 +0,0 @@ - - - - - - - - - - - - - - - - listVendors - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

listVendors

-
-
-
-
-
- Classes - - SoftLayer_Network_CdnMarketplace_Vendor - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_CdnMarketplace_Vendor::listVendors -

- - -

- DEPRECATED -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Vendor/listVendors'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Component/getPortStatistics/index.html b/reference/services/SoftLayer_Network_Component/getPortStatistics/index.html deleted file mode 100644 index 2ba3f395493..00000000000 --- a/reference/services/SoftLayer_Network_Component/getPortStatistics/index.html +++ /dev/null @@ -1,338 +0,0 @@ - - - - - - - - - - - - - - - - getPortStatistics - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getPortStatistics

-
-
-
-
-
- Classes - - SoftLayer_Network_Component - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Component::getPortStatistics -

- - -
Deprecated
- -

- Retrieve various network statistics for the specific port. -

-

Description

- -

DEPRECATED - This operation will cease to function after April 4th, 2016 and will be removed from v3.2 -Retrieve various network statistics. The network statistics are retrieved from the network device using snmpget. Below is a list of statistics retrieved:

-
    -
  • Administrative Status
  • -
  • Operational Status
  • -
  • Maximum Transmission Unit
  • -
  • In Octets
  • -
  • Out Octets
  • -
  • In Unicast Packets
  • -
  • Out Unicast Packets
  • -
  • In Multicast Packets
  • -
  • Out Multicast Packets
  • -
- -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Component/{SoftLayer_Network_ComponentID}/getPortStatistics'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Gateway/changeGatewayVersion/index.html b/reference/services/SoftLayer_Network_Gateway/changeGatewayVersion/index.html deleted file mode 100644 index 8d27abbc894..00000000000 --- a/reference/services/SoftLayer_Network_Gateway/changeGatewayVersion/index.html +++ /dev/null @@ -1,304 +0,0 @@ - - - - - - - - - - - - - - - - changeGatewayVersion - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

changeGatewayVersion

-
-
-
-
-
- Classes - - SoftLayer_Network_Gateway - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Gateway::changeGatewayVersion -

- - -

- Change Juniper vSRX version on a Gateway -

-

Description

- - Used to create a transaction to upgrade or rollback the vSRX version for Juniper gateway. - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
versionIdintId of upgrade record in SoftLayer_Network_Gateway_VersionUpgrade
rollbackVersionboolean[optional] [default false] If true, then rollback version. If false, then Upgrade version
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - boolean - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [int, boolean]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Gateway/{SoftLayer_Network_GatewayID}/changeGatewayVersion'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Gateway/checkAccountWhiteList/index.html b/reference/services/SoftLayer_Network_Gateway/checkAccountWhiteList/index.html deleted file mode 100644 index 9eaeadb7f7d..00000000000 --- a/reference/services/SoftLayer_Network_Gateway/checkAccountWhiteList/index.html +++ /dev/null @@ -1,302 +0,0 @@ - - - - - - - - - - - - - - - - checkAccountWhiteList - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

checkAccountWhiteList

-
-
-
-
-
- Classes - - SoftLayer_Network_Gateway - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Gateway::checkAccountWhiteList -

- - -

- -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
accountIdint
categorystring
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - boolean - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [int, string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Gateway/checkAccountWhiteList'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Gateway/createObject/index.html b/reference/services/SoftLayer_Network_Gateway/createObject/index.html deleted file mode 100644 index 94435f47dc3..00000000000 --- a/reference/services/SoftLayer_Network_Gateway/createObject/index.html +++ /dev/null @@ -1,293 +0,0 @@ - - - - - - - - - - - - - - - - createObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

createObject

-
-
-
-
-
- Classes - - SoftLayer_Network_Gateway - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Gateway::createObject -

- - -

- Create a new server gateway -

-

Description

- - Create and return a new gateway. This object can be created with any number of members or VLANs, but they all must be in the same pod. By creating a gateway with members and/or VLANs attached, it is the equivalent of individually calling their createObject methods except this will start a single asynchronous process to setup the gateway. The status of this process can be checked using the status field. - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
templateObjectSoftLayer_Network_GatewayThe SoftLayer_Network_Gateway object that you wish to create.
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [SoftLayer_Network_Gateway]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Gateway/createObject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Gateway/editObject/index.html b/reference/services/SoftLayer_Network_Gateway/editObject/index.html deleted file mode 100644 index 1bb56ec8d0f..00000000000 --- a/reference/services/SoftLayer_Network_Gateway/editObject/index.html +++ /dev/null @@ -1,295 +0,0 @@ - - - - - - - - - - - - - - - - editObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

editObject

-
-
-
-
-
- Classes - - SoftLayer_Network_Gateway - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Gateway::editObject -

- - -

- Edit Gateway -

-

Description

- - Edit this gateway. Currently, the only value that can be edited is the name. - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
templateObjectSoftLayer_Network_GatewayA skeleton SoftLayer_Network_Gateway object with only the properties defined that you wish to change. Unchanged properties are left alone.
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - boolean - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [SoftLayer_Network_Gateway]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Gateway/{SoftLayer_Network_GatewayID}/editObject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Gateway/isAccountWhiteListed/index.html b/reference/services/SoftLayer_Network_Gateway/isAccountWhiteListed/index.html deleted file mode 100644 index 7bf92bbbb24..00000000000 --- a/reference/services/SoftLayer_Network_Gateway/isAccountWhiteListed/index.html +++ /dev/null @@ -1,294 +0,0 @@ - - - - - - - - - - - - - - - - isAccountWhiteListed - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

isAccountWhiteListed

-
-
-
-
-
- Classes - - SoftLayer_Network_Gateway - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Gateway::isAccountWhiteListed -

- - -

- -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
categorystring
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - boolean - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Gateway/{SoftLayer_Network_GatewayID}/isAccountWhiteListed'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Gateway/isRollbackAllowed/index.html b/reference/services/SoftLayer_Network_Gateway/isRollbackAllowed/index.html deleted file mode 100644 index 35166ff02e2..00000000000 --- a/reference/services/SoftLayer_Network_Gateway/isRollbackAllowed/index.html +++ /dev/null @@ -1,273 +0,0 @@ - - - - - - - - - - - - - - - - isRollbackAllowed - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

isRollbackAllowed

-
-
-
-
-
- Classes - - SoftLayer_Network_Gateway - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Gateway::isRollbackAllowed -

- - -

- -

-

Description

- - Returns true if rollback is allowed. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - boolean - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Gateway/{SoftLayer_Network_GatewayID}/isRollbackAllowed'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Gateway_VersionUpgrade/getAllByUpgradePkgUrlId/index.html b/reference/services/SoftLayer_Network_Gateway_VersionUpgrade/getAllByUpgradePkgUrlId/index.html deleted file mode 100644 index 289ea201bd1..00000000000 --- a/reference/services/SoftLayer_Network_Gateway_VersionUpgrade/getAllByUpgradePkgUrlId/index.html +++ /dev/null @@ -1,297 +0,0 @@ - - - - - - - - - - - - - - - - getAllByUpgradePkgUrlId - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getAllByUpgradePkgUrlId

-
-
-
-
-
- Classes - - SoftLayer_Network_Gateway_VersionUpgrade - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Gateway_VersionUpgrade::getAllByUpgradePkgUrlId -

- - -

- -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
upgradePkgUrlIdint
    -
  • upgradePkgUrlId to search for matching records.
  • -
-
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [int]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Gateway_VersionUpgrade/getAllByUpgradePkgUrlId'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Gateway_VersionUpgrade/getVsrxOrdersAllowedOS/index.html b/reference/services/SoftLayer_Network_Gateway_VersionUpgrade/getVsrxOrdersAllowedOS/index.html deleted file mode 100644 index e0e3d68b20b..00000000000 --- a/reference/services/SoftLayer_Network_Gateway_VersionUpgrade/getVsrxOrdersAllowedOS/index.html +++ /dev/null @@ -1,304 +0,0 @@ - - - - - - - - - - - - - - - - getVsrxOrdersAllowedOS - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getVsrxOrdersAllowedOS

-
-
-
-
-
- Classes - - SoftLayer_Network_Gateway_VersionUpgrade - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Gateway_VersionUpgrade::getVsrxOrdersAllowedOS -

- - -

- -

-

Description

- - Used to get a list per package of prices ids for allowed vSRX OS-es for new orders. - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
accountIdint
validateboolean
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [int, boolean]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Gateway_VersionUpgrade/getVsrxOrdersAllowedOS'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Interconnect_Tenant/isAdnAccount/index.html b/reference/services/SoftLayer_Network_Interconnect_Tenant/isAdnAccount/index.html deleted file mode 100644 index 2c67ce717ed..00000000000 --- a/reference/services/SoftLayer_Network_Interconnect_Tenant/isAdnAccount/index.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - - - - - - - - - - - isAdnAccount - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

isAdnAccount

-
-
-
-
-
- Classes - - SoftLayer_Network_Interconnect_Tenant - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Interconnect_Tenant::isAdnAccount -

- - -

- -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - boolean - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Interconnect_Tenant/isAdnAccount'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/addNsRecord/index.html b/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/addNsRecord/index.html deleted file mode 100644 index 4364a61107c..00000000000 --- a/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/addNsRecord/index.html +++ /dev/null @@ -1,288 +0,0 @@ - - - - - - - - - - - - - - - - addNsRecord - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

addNsRecord

-
-
-
-
-
- Classes - - SoftLayer_Network_LoadBalancer_Global_Account - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_LoadBalancer_Global_Account::addNsRecord -

- - -
Deprecated
- -

- [Deprecated] Add the required nameserver resource record for a global load balancer account. -

-

Description

- -

The global load balancer service has been deprecated and is no longer available.

-

If your globally load balanced domain is hosted on the SoftLayer nameservers this method will add the required NS resource record to your DNS zone file and remove any A records that match the host portion of a global load balancer account hostname.

- - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - boolean - -
- -

Error Handling

-
    - - -
  • Throw the exception “Operation addNsRecord has been deprecated and will be removed in API version 3.2.” when attempting to invoke this function.
  • - - - - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_LoadBalancer_Global_Account/{SoftLayer_Network_LoadBalancer_Global_AccountID}/addNsRecord'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/editObject/index.html b/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/editObject/index.html deleted file mode 100644 index 97df0dc41f7..00000000000 --- a/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/editObject/index.html +++ /dev/null @@ -1,310 +0,0 @@ - - - - - - - - - - - - - - - - editObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

editObject

-
-
-
-
-
- Classes - - SoftLayer_Network_LoadBalancer_Global_Account - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_LoadBalancer_Global_Account::editObject -

- - -
Deprecated
- -

- [Deprecated] Edit a global load balancer account and the hosts that make up the load balancing pool. -

-

Description

- -

The global load balancer service has been deprecated and is no longer available.

-

Edit the properties of a global load balancer account by passing in a modified instance of the object.

- - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
templateObjectSoftLayer_Network_LoadBalancer_Global_AccountA skeleton SoftLayer_Network_LoadBalancer_Global_Account object with only the properties defined that you wish to change. Unchanged properties are left alone.
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - boolean - -
- -

Error Handling

-
    - - -
  • Throw the exception “Operation editObject has been deprecated and will be removed in API version 3.2.” when attempting to invoke this function.
  • - - - - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [SoftLayer_Network_LoadBalancer_Global_Account]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_LoadBalancer_Global_Account/{SoftLayer_Network_LoadBalancer_Global_AccountID}/editObject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getAccount/index.html b/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getAccount/index.html deleted file mode 100644 index f40ac8da4bf..00000000000 --- a/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getAccount/index.html +++ /dev/null @@ -1,275 +0,0 @@ - - - - - - - - - - - - - - - - getAccount - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getAccount

-
-
-
-
-
- Classes - - SoftLayer_Network_LoadBalancer_Global_Account - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_LoadBalancer_Global_Account::getAccount -

- - -

- -

-

Description

- - Your SoftLayer customer account. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_LoadBalancer_Global_Account/{SoftLayer_Network_LoadBalancer_Global_AccountID}/getAccount'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getBillingItem/index.html b/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getBillingItem/index.html deleted file mode 100644 index d3316945eff..00000000000 --- a/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getBillingItem/index.html +++ /dev/null @@ -1,275 +0,0 @@ - - - - - - - - - - - - - - - - getBillingItem - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getBillingItem

-
-
-
-
-
- Classes - - SoftLayer_Network_LoadBalancer_Global_Account - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_LoadBalancer_Global_Account::getBillingItem -

- - -

- -

-

Description

- - The current billing item for a Global Load Balancer account. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_LoadBalancer_Global_Account/{SoftLayer_Network_LoadBalancer_Global_AccountID}/getBillingItem'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getHosts/index.html b/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getHosts/index.html deleted file mode 100644 index 6dc60d4b627..00000000000 --- a/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getHosts/index.html +++ /dev/null @@ -1,279 +0,0 @@ - - - - - - - - - - - - - - - - getHosts - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getHosts

-
-
-
-
-
- Classes - - SoftLayer_Network_LoadBalancer_Global_Account - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_LoadBalancer_Global_Account::getHosts -

- - -

- -

-

Description

- - The hosts in the load balancing pool for a global load balancer account. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_LoadBalancer_Global_Account/{SoftLayer_Network_LoadBalancer_Global_AccountID}/getHosts'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getLoadBalanceType/index.html b/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getLoadBalanceType/index.html deleted file mode 100644 index 05eb603a79e..00000000000 --- a/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getLoadBalanceType/index.html +++ /dev/null @@ -1,275 +0,0 @@ - - - - - - - - - - - - - - - - getLoadBalanceType - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getLoadBalanceType

-
-
-
-
-
- Classes - - SoftLayer_Network_LoadBalancer_Global_Account - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_LoadBalancer_Global_Account::getLoadBalanceType -

- - -

- -

-

Description

- - The load balance method of a global load balancer account - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_LoadBalancer_Global_Account/{SoftLayer_Network_LoadBalancer_Global_AccountID}/getLoadBalanceType'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getManagedResourceFlag/index.html b/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getManagedResourceFlag/index.html deleted file mode 100644 index 7352baf2ac1..00000000000 --- a/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getManagedResourceFlag/index.html +++ /dev/null @@ -1,275 +0,0 @@ - - - - - - - - - - - - - - - - getManagedResourceFlag - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getManagedResourceFlag

-
-
-
-
-
- Classes - - SoftLayer_Network_LoadBalancer_Global_Account - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_LoadBalancer_Global_Account::getManagedResourceFlag -

- - -

- -

-

Description

- - A flag indicating that the global load balancer is a managed resource. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

-
  • - - - - boolean - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_LoadBalancer_Global_Account/{SoftLayer_Network_LoadBalancer_Global_AccountID}/getManagedResourceFlag'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getObject/index.html b/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getObject/index.html deleted file mode 100644 index 5fac4eeb53d..00000000000 --- a/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/getObject/index.html +++ /dev/null @@ -1,275 +0,0 @@ - - - - - - - - - - - - - - - - getObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getObject

-
-
-
-
-
- Classes - - SoftLayer_Network_LoadBalancer_Global_Account - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_LoadBalancer_Global_Account::getObject -

- - -

- Retrieve a SoftLayer_Network_LoadBalancer_Global_Account record. -

-

Description

- - The global load balancer service has been deprecated and is no longer available. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_LoadBalancer_Global_Account/{SoftLayer_Network_LoadBalancer_Global_AccountID}/getObject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/index.html b/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/index.html deleted file mode 100644 index 61ab3c2fc18..00000000000 --- a/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/index.html +++ /dev/null @@ -1,332 +0,0 @@ - - - - - - - - - - - - - SoftLayer_Network_LoadBalancer_Global_Account - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_LoadBalancer_Global_Account

-
-
-
-
-
- Classes - - SoftLayer_Network_LoadBalancer_Global_Account - -
- Tags - - service - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Network_LoadBalancer_Global_Account

- - -
- -
- - -

Description

- -
Deprecated
- -

The global load balancer service has been deprecated and is no longer available.

-

A global load balancer account enables you to load balance traffic between servers that are in geographically diverse locations. SoftLayer’s global load balancers act as a highly modified DNS server. SoftLayer’s global load balancers work by accepting DNS requests for a specific hostname, choosing a host from a load balancing pool using the load balance method specified, and returning a destination IP address through a DNS response.

- - -
-

Methods

-
-
-
- -
-
-
-
- - - - - - - -
-

addNsRecord

- -

[Deprecated] Add the required nameserver resource record for a global load balancer account.

- -
- - - - - -
-

editObject

- -

[Deprecated] Edit a global load balancer account and the hosts that make up the load balancing pool.

- -
- - - -
-

getAccount

- -

Your SoftLayer customer account.

- -
- - - -
-

getBillingItem

- -

The current billing item for a Global Load Balancer account.

- -
- - - -
-

getHosts

- -

The hosts in the load balancing pool for a global load balancer account.

- -
- - - -
-

getLoadBalanceType

- -

The load balance method of a global load balancer account

- -
- - - -
-

getManagedResourceFlag

- -

A flag indicating that the global load balancer is a managed resource.

- -
- - - -
-

getObject

- -

Retrieve a SoftLayer_Network_LoadBalancer_Global_Account record.

- -
- - - - - -
-

removeNsRecord

- -

[Deprecated] Remove the required nameserver resource record for a global load balancer account.

- -
- - -
-
- -
- -
-
- - - -
- - - - - - - diff --git a/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/removeNsRecord/index.html b/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/removeNsRecord/index.html deleted file mode 100644 index fa36a40b4f3..00000000000 --- a/reference/services/SoftLayer_Network_LoadBalancer_Global_Account/removeNsRecord/index.html +++ /dev/null @@ -1,288 +0,0 @@ - - - - - - - - - - - - - - - - removeNsRecord - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

removeNsRecord

-
-
-
-
-
- Classes - - SoftLayer_Network_LoadBalancer_Global_Account - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_LoadBalancer_Global_Account::removeNsRecord -

- - -
Deprecated
- -

- [Deprecated] Remove the required nameserver resource record for a global load balancer account. -

-

Description

- -

The global load balancer service has been deprecated and is no longer available.

-

If your globally load balanced domain is hosted on the SoftLayer nameservers this method will remove the NS resource record from your DNS zone file.

- - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - boolean - -
- -

Error Handling

-
    - - -
  • Throw the exception “Operation removeNsRecord has been deprecated and will be removed in API version 3.2.” when attempting to invoke this function.
  • - - - - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_LoadBalancer_Global_Account/{SoftLayer_Network_LoadBalancer_Global_AccountID}/removeNsRecord'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_LoadBalancer_Global_Host/deleteObject/index.html b/reference/services/SoftLayer_Network_LoadBalancer_Global_Host/deleteObject/index.html deleted file mode 100644 index fce4fb8f7ca..00000000000 --- a/reference/services/SoftLayer_Network_LoadBalancer_Global_Host/deleteObject/index.html +++ /dev/null @@ -1,288 +0,0 @@ - - - - - - - - - - - - - - - - deleteObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

deleteObject

-
-
-
-
-
- Classes - - SoftLayer_Network_LoadBalancer_Global_Host - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_LoadBalancer_Global_Host::deleteObject -

- - -
Deprecated
- -

- [Deprecated] Remove a host from the load balancing pool of a global load balancer account. -

-

Description

- -

The global load balancer service has been deprecated and is no longer available.

-

Remove a host from the load balancing pool of a global load balancer account.

- - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - boolean - -
- -

Error Handling

-
    - - -
  • Throw the exception “Operation removeNsRecord has been deprecated and will be removed in API version 3.2.” when attempting to invoke this function.
  • - - - - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_LoadBalancer_Global_Host/{SoftLayer_Network_LoadBalancer_Global_HostID}/deleteObject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_LoadBalancer_Global_Host/getLoadBalancerAccount/index.html b/reference/services/SoftLayer_Network_LoadBalancer_Global_Host/getLoadBalancerAccount/index.html deleted file mode 100644 index 10b45d4cfd6..00000000000 --- a/reference/services/SoftLayer_Network_LoadBalancer_Global_Host/getLoadBalancerAccount/index.html +++ /dev/null @@ -1,275 +0,0 @@ - - - - - - - - - - - - - - - - getLoadBalancerAccount - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getLoadBalancerAccount

-
-
-
-
-
- Classes - - SoftLayer_Network_LoadBalancer_Global_Host - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_LoadBalancer_Global_Host::getLoadBalancerAccount -

- - -

- -

-

Description

- - The global load balancer account a host belongs to. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_LoadBalancer_Global_Host/{SoftLayer_Network_LoadBalancer_Global_HostID}/getLoadBalancerAccount'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_LoadBalancer_Global_Host/getObject/index.html b/reference/services/SoftLayer_Network_LoadBalancer_Global_Host/getObject/index.html deleted file mode 100644 index 4d019b7377d..00000000000 --- a/reference/services/SoftLayer_Network_LoadBalancer_Global_Host/getObject/index.html +++ /dev/null @@ -1,275 +0,0 @@ - - - - - - - - - - - - - - - - getObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getObject

-
-
-
-
-
- Classes - - SoftLayer_Network_LoadBalancer_Global_Host - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_LoadBalancer_Global_Host::getObject -

- - -

- Retrieve a SoftLayer_Network_LoadBalancer_Global_Host record. -

-

Description

- - The global load balancer service has been deprecated and is no longer available. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_LoadBalancer_Global_Host/{SoftLayer_Network_LoadBalancer_Global_HostID}/getObject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_LoadBalancer_Global_Host/index.html b/reference/services/SoftLayer_Network_LoadBalancer_Global_Host/index.html deleted file mode 100644 index 903783aafa2..00000000000 --- a/reference/services/SoftLayer_Network_LoadBalancer_Global_Host/index.html +++ /dev/null @@ -1,274 +0,0 @@ - - - - - - - - - - - - - SoftLayer_Network_LoadBalancer_Global_Host - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_LoadBalancer_Global_Host

-
-
-
-
-
- Classes - - SoftLayer_Network_LoadBalancer_Global_Host - -
- Tags - - service - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Network_LoadBalancer_Global_Host

- - -
- -
- - -

Description

- -
Deprecated
- -

The global load balancer service has been deprecated and is no longer available.

-

Every global load balancer account contains hosts that make up the load balancing pool. The global load balancers select hosts from this pool and return the destination IP in the DNS response. The SoftLayer_Network_LoadBalancer_Global_Host service represent these hosts.

- - -
-

Methods

-
-
-
- -
-
-
-
- - - - - - - -
-

deleteObject

- -

[Deprecated] Remove a host from the load balancing pool of a global load balancer account.

- -
- - - -
-

getLoadBalancerAccount

- -

The global load balancer account a host belongs to.

- -
- - - -
-

getObject

- -

Retrieve a SoftLayer_Network_LoadBalancer_Global_Host record.

- -
- - -
-
- -
- -
-
- - - -
- - - - - - - diff --git a/reference/services/SoftLayer_Network_Media_Transcode_Account/createTranscodeAccount/index.html b/reference/services/SoftLayer_Network_Media_Transcode_Account/createTranscodeAccount/index.html deleted file mode 100644 index 1673d82dbbe..00000000000 --- a/reference/services/SoftLayer_Network_Media_Transcode_Account/createTranscodeAccount/index.html +++ /dev/null @@ -1,284 +0,0 @@ - - - - - - - - - - - - - - - - createTranscodeAccount - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

createTranscodeAccount

-
-
-
-
-
- Classes - - SoftLayer_Network_Media_Transcode_Account - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Media_Transcode_Account::createTranscodeAccount -

- - -

- Creates a new transcode account -

-

Description

- - With this method, you can create a transcode account. Individual SoftLayer account can have a single Transcode account. You have to pass your SoftLayer account id as a parameter. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - boolean - -
- -

Error Handling

-
    - - -
  • Throw the exception if a SoftLayer account is inactive or disabled.
  • - - - - - -
  • Throw the exception if a user already has a Transcode account.
  • - - - - -
- - - -
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Media_Transcode_Account/createTranscodeJob/index.html b/reference/services/SoftLayer_Network_Media_Transcode_Account/createTranscodeJob/index.html deleted file mode 100644 index 7e415ddd326..00000000000 --- a/reference/services/SoftLayer_Network_Media_Transcode_Account/createTranscodeJob/index.html +++ /dev/null @@ -1,318 +0,0 @@ - - - - - - - - - - - - - - - - createTranscodeJob - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

createTranscodeJob

-
-
-
-
-
- Classes - - SoftLayer_Network_Media_Transcode_Account - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Media_Transcode_Account::createTranscodeJob -

- - -

- Creates a transcode job -

-

Description

- -

‘‘‘Note’’’. This method is obsolete. Please use the SoftLayer_Network_Media_Transcode_Job::createObject method on SoftLayer_Network_Media_Transcode_Job object instead. SoftLayer_Network_Media_Transcode_Job::createObject returns an object of a newly created Transcode Job.

-

With this method, you can create a transcode job.

-

The very first step of creating a transcode job is to upload your media files to the /in directory on your Transcode FTP space. Then, you have to pass a SoftLayer_Network_Media_Transcode_Job object as a parameter for this method.

-

There are 4 required properties of SoftLayer_Network_Media_Transcode_Job object: transcodePresetName, transcodePresetGuid, inputFile, and outputFile. A transcode preset is a configuration that defines a certain media output. You can retrieve all the supported presets with the SoftLayer_Network_Media_Transcode_Account::getPresets method. You can also use SoftLayer_Network_Media_Transcode_Account::getPresetDetail method to get more information on a preset. Use these two methods to determine appropriate values for “transcodePresetName” and “transcodePresetGuid” properties. For an “inputFile”, you must specify a file that exists in the /in directory of your Transcode FTP space. An “outputFile” name will be used by the Transcode server for naming a transcoded file. An output file name must be in /out directory. If your outputFile name already exists in the /out directory, the Transcode server will append a file name with _n (an underscore and the total number of files with the identical name plus 1).

-

The “name” property is optional and it can help you keep track of transcode jobs easily. “autoDeleteDuration” is another optional property that you can specify. It determines how soon your input file will be deleted. If autoDeleteDuration is set to zero, your input file will be removed immediately after the last transcode job running on it is completed. A value for autoDeleteDuration property is in seconds and the maximum value is 259200 which is 3 days.

-

An example SoftLayer_Network_Media_Transcode_Job parameter looks like this:

-
    -
  • name: My transcoding
  • -
  • transcodePresetName: F4V 896kbps 640x352 16x9 29.97fps
  • -
  • transcodePresetGuid: {87E01268-C3E3-4A85-9701-052C9AC42BD4}
  • -
  • inputFile: /in/my_birthday.wmv
  • -
  • outputFile: /out/my_birthday_flash
  • -
-

Notice that an output file does not have a file extension. The Transcode server will append a file extension based on an output format. A newly created transcode job will be in “Pending” status and it will be added to the Transcoding queue. You will receive a notification email whenever there is a status change on your transcode job. For example, the Transcode server starts to process your transcode job, you will be notified via an email.

-

You can add up to 3 pending jobs at a time. Transcode jobs with any other status such as “Complete” or “Error” will not be counted toward your pending jobs.

-

Once a job is complete, the Transcode server will place the output file into the /out directory along with a notification email. The files in the /out directory will be removed 3 days after they were created. You will need to use an FTP client to download transcoded files.

- - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
newJobSoftLayer_Network_Media_Transcode_JobA template object with details of a new job
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - boolean - -
- -

Error Handling

-
    - - -
  • Throw the exception if an invalid parameter is passed.
  • - - - - -
- - - -
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Media_Transcode_Account/getAccount/index.html b/reference/services/SoftLayer_Network_Media_Transcode_Account/getAccount/index.html deleted file mode 100644 index 3c4c34fba96..00000000000 --- a/reference/services/SoftLayer_Network_Media_Transcode_Account/getAccount/index.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - - - - - - - - - - - getAccount - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getAccount

-
-
-
-
-
- Classes - - SoftLayer_Network_Media_Transcode_Account - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Media_Transcode_Account::getAccount -

- - -

- -

-

Description

- - The SoftLayer account information - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - -
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Media_Transcode_Account/getDirectoryInformation/index.html b/reference/services/SoftLayer_Network_Media_Transcode_Account/getDirectoryInformation/index.html deleted file mode 100644 index 45385fcad39..00000000000 --- a/reference/services/SoftLayer_Network_Media_Transcode_Account/getDirectoryInformation/index.html +++ /dev/null @@ -1,325 +0,0 @@ - - - - - - - - - - - - - - - - getDirectoryInformation - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getDirectoryInformation

-
-
-
-
-
- Classes - - SoftLayer_Network_Media_Transcode_Account - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Media_Transcode_Account::getDirectoryInformation -

- - -

- Returns a directory listing -

-

Description

- - This method returns a collection of SoftLayer_Container_Network_Ftp_Directory objects. You can retrieve directory information for /in and /out directories. A SoftLayer_Container_Network_Directory_Listing object contains a type (indicating whether it is a file or a directory), name and file count if it is a directory. - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
directoryNamestringcomma separated Extensions to restrict results to
extensionFilterstringA directory name
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - -

Error Handling

-
    - - -
  • Throw the exception if connection to the Transcode FTP server fails
  • - - - - - -
  • Throw the exception if it fails to login to the Transcode FTP server fails
  • - - - - - -
  • Throw the exception if a directory doesn’t exist on the Transcode FTP server
  • - - - - -
- - - -
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Media_Transcode_Account/getFileDetail/index.html b/reference/services/SoftLayer_Network_Media_Transcode_Account/getFileDetail/index.html deleted file mode 100644 index 68b048a187c..00000000000 --- a/reference/services/SoftLayer_Network_Media_Transcode_Account/getFileDetail/index.html +++ /dev/null @@ -1,313 +0,0 @@ - - - - - - - - - - - - - - - - getFileDetail - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getFileDetail

-
-
-
-
-
- Classes - - SoftLayer_Network_Media_Transcode_Account - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Media_Transcode_Account::getFileDetail -

- - -

- Returns detailed information on a video or audio file -

-

Description

- - This method returns detailed information of a media file that resides in the Transcode FTP server. A SoftLayer_Container_Network_Media_Information object contains media details such as file size, media format, frame rate, aspect ratio and so on. This information is merely for reference purposes. You should not rely on this data. Our library grabs small pieces of data from a media file to gather media details. This information may not be available for some files. - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
sourcestringThe name of a source file
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - -

Error Handling

-
    - - -
  • Throw the exception if connection to the Transcode FTP server fails
  • - - - - - -
  • Throw the exception if it fails to login to the Transcode FTP server fails
  • - - - - - -
  • Throw the exception if a source file doesn’t exist on the Transcode FTP server
  • - - - - -
- - - -
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Media_Transcode_Account/getFtpAttributes/index.html b/reference/services/SoftLayer_Network_Media_Transcode_Account/getFtpAttributes/index.html deleted file mode 100644 index b3cbbfed157..00000000000 --- a/reference/services/SoftLayer_Network_Media_Transcode_Account/getFtpAttributes/index.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - - - - - - - - - - - getFtpAttributes - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getFtpAttributes

-
-
-
-
-
- Classes - - SoftLayer_Network_Media_Transcode_Account - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Media_Transcode_Account::getFtpAttributes -

- - -

- Returns Transcode FTP login credentials -

-

Description

- -

This method returns your Transcode FTP login credentials to the transcode.service.softlayer.com server.

-

The Transcode FTP server is available via the SoftLayer private network. There is no API method that you can upload a file to Transcode server so you need to use an FTP client. You will have /in and /out directories on the Transcode FTP server. You will have read-write privileges for /in directory and read-only privilege for /out directory. All the files in both /in and /out directories will be deleted after 72 hours from the creation date.

- - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - -
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Media_Transcode_Account/getObject/index.html b/reference/services/SoftLayer_Network_Media_Transcode_Account/getObject/index.html deleted file mode 100644 index a7726454d6b..00000000000 --- a/reference/services/SoftLayer_Network_Media_Transcode_Account/getObject/index.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - - - - - - - - - - - getObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getObject

-
-
-
-
-
- Classes - - SoftLayer_Network_Media_Transcode_Account - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Media_Transcode_Account::getObject -

- - -

- Retrieve a SoftLayer_Network_Media_Transcode_Account record. -

-

Description

- - getObject method retrieves the SoftLayer_Network_Media_Transcode_Account object whose ID number corresponds to the ID number of the initial parameter passed to the SoftLayer_Network_Media_Transcode_Account service. You can only retrieve a Transcode account assigned to your SoftLayer customer account. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - -
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Media_Transcode_Account/getPresetDetail/index.html b/reference/services/SoftLayer_Network_Media_Transcode_Account/getPresetDetail/index.html deleted file mode 100644 index de5930693fd..00000000000 --- a/reference/services/SoftLayer_Network_Media_Transcode_Account/getPresetDetail/index.html +++ /dev/null @@ -1,303 +0,0 @@ - - - - - - - - - - - - - - - - getPresetDetail - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getPresetDetail

-
-
-
-
-
- Classes - - SoftLayer_Network_Media_Transcode_Account - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Media_Transcode_Account::getPresetDetail -

- - -

- Returns details on a transcode output preset -

-

Description

- - This method returns an array of SoftLayer_Container_Network_Media_Transcode_Preset_Element objects. Each preset has its own collection of preset elements such as encoder, frame rate, aspect ratio and so on. Each element object has a default value for itself and an array of SoftLayer_Container_Network_Media_Transcode_Preset_Element_Option objects. For example, “Frame Rate” element for “Windows Media 9 - Download - 1 Mbps - NTSC - Constrained VBR” preset has 19 element options. 15.0 frame rate is selected by default. Currently, you are not able to change the default value. Customizing these values may be possible in the future. - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
guidstringThe unique id of a preset
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - -

Error Handling

-
    - - -
  • Throw an exception if connection to a Transcode server fails.
  • - - - - -
- - - -
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Media_Transcode_Account/getPresets/index.html b/reference/services/SoftLayer_Network_Media_Transcode_Account/getPresets/index.html deleted file mode 100644 index 516a15777ee..00000000000 --- a/reference/services/SoftLayer_Network_Media_Transcode_Account/getPresets/index.html +++ /dev/null @@ -1,282 +0,0 @@ - - - - - - - - - - - - - - - - getPresets - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getPresets

-
-
-
-
-
- Classes - - SoftLayer_Network_Media_Transcode_Account - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Media_Transcode_Account::getPresets -

- - -

- Returns an array of transcoding preset objects -

-

Description

- - A transcode preset is a configuration that defines a certain media output. This method returns an array of transcoding preset objects supported by SoftLayer’s Transcode server. Each SoftLayer_Container_Network_Media_Transcode_Preset contains a GUID property. You will need a GUID string when you create a new transcode job. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - -

Error Handling

-
    - - -
  • Throw an exception if connection to a Transcode server fails.
  • - - - - -
- - - -
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Media_Transcode_Account/getTranscodeJobs/index.html b/reference/services/SoftLayer_Network_Media_Transcode_Account/getTranscodeJobs/index.html deleted file mode 100644 index db68399affc..00000000000 --- a/reference/services/SoftLayer_Network_Media_Transcode_Account/getTranscodeJobs/index.html +++ /dev/null @@ -1,275 +0,0 @@ - - - - - - - - - - - - - - - - getTranscodeJobs - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getTranscodeJobs

-
-
-
-
-
- Classes - - SoftLayer_Network_Media_Transcode_Account - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Media_Transcode_Account::getTranscodeJobs -

- - -

- -

-

Description

- - Transcode jobs - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - -
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Media_Transcode_Account/index.html b/reference/services/SoftLayer_Network_Media_Transcode_Account/index.html deleted file mode 100644 index 8e3c283016d..00000000000 --- a/reference/services/SoftLayer_Network_Media_Transcode_Account/index.html +++ /dev/null @@ -1,335 +0,0 @@ - - - - - - - - - - - - - SoftLayer_Network_Media_Transcode_Account - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_Media_Transcode_Account

-
-
-
-
-
- Classes - - SoftLayer_Network_Media_Transcode_Account - -
- Tags - - service - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Network_Media_Transcode_Account

- - -
- -
- - -

Description

- -

Transcoding is a service which allows you to transcode media files to different formats. For example, if you have a Windows Media Video file you wish to stream in Flash Video format, transcoding would be the process to make this change. Individual SoftLayer customer can have a single Transcode account and you need to create a Transcode account to use the service. To create a Transcode account, go to the “Private Network” -> “Transcoding” page in the SoftLayer [https://manage.softlayer.com customer portal] or invoke SoftLayer_Network_Media_Transcode_Account::createTranscodeAccount method.

-

SoftLayer Transcoding service supports a large number of video and audio codecs. This means you can transcode many different types of movies. Refer to [http://knowledgelayer.softlayer.com/questions/409/SoftLayer+Transcoding+FAQ Transcode FAQ] for supported codes and media containers. Transcode server also has hundreds of pre-defined output formats that you can choose from.

-

A Transcode account object allows you to communicate with the Transcode FTP (transcode.service.softlayer.com server) server and Transcode server. You can retrieve a directory listing, details on a media file, Transcode output presets, and Transcode FTP login credentials. Most importantly, you can create transcode jobs through your Transcode account.

-

When a Transcode account is created, it creates an FTP account on the Transcode FTP. You can upload your media files to the /in directory and you can download transcoded media files from the /out directory. You can keep the files 3 days from the creation date. They will be automatically deleted after this point. For more details on the Transcode FTP server, refer to SoftLayer_Network_Media_Transcode_Account::getFtpAttributes method.

- - -
-

Methods

-
-
-
- -
-
-
-
- - - - - -
-

createTranscodeAccount

- -

Creates a new transcode account

- -
- - - -
-

createTranscodeJob

- -

Creates a transcode job

- -
- - - -
-

getAccount

- -

The SoftLayer account information

- -
- - - -
-

getDirectoryInformation

- -

Returns a directory listing

- -
- - - -
-

getFileDetail

- -

Returns detailed information on a video or audio file

- -
- - - -
-

getFtpAttributes

- -

Returns Transcode FTP login credentials

- -
- - - -
-

getObject

- -

Retrieve a SoftLayer_Network_Media_Transcode_Account record.

- -
- - - -
-

getPresetDetail

- -

Returns details on a transcode output preset

- -
- - - -
-

getPresets

- -

Returns an array of transcoding preset objects

- -
- - - -
-

getTranscodeJobs

- -

Transcode jobs

- -
- - -
-
- -
- -
-
- - - -
- - - - - - - diff --git a/reference/services/SoftLayer_Network_Media_Transcode_Job/createObject/index.html b/reference/services/SoftLayer_Network_Media_Transcode_Job/createObject/index.html deleted file mode 100644 index 40432325f7b..00000000000 --- a/reference/services/SoftLayer_Network_Media_Transcode_Job/createObject/index.html +++ /dev/null @@ -1,304 +0,0 @@ - - - - - - - - - - - - - - - - createObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

createObject

-
-
-
-
-
- Classes - - SoftLayer_Network_Media_Transcode_Job - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Media_Transcode_Job::createObject -

- - -

- Creates a transcode job -

-

Description

- -

With this method, you can create a transcode job.

-

The very first step of creating a transcode job is to upload your media files to the /in directory on your Transcode FTP space. Then, you have to pass a SoftLayer_Network_Media_Transcode_Job object as a parameter for this method.

-

There are 4 required properties of SoftLayer_Network_Media_Transcode_Job object: transcodePresetName, transcodePresetGuid, inputFile, and outputFile. A transcode preset is a configuration that defines a certain media output. You can retrieve all the supported presets with the SoftLayer_Network_Media_Transcode_Account::getPresets method. You can also use SoftLayer_Network_Media_Transcode_Account::getPresetDetail method to get more information on a preset. Use these two methods to determine appropriate values for “transcodePresetName” and “transcodePresetGuid” properties. For an “inputFile”, you must specify a file that exists in the /in directory of your Transcode FTP space. An “outputFile” name will be used by the Transcode server for naming a transcoded file. An output file name must be in /out directory. If your outputFile name already exists in the /out directory, the Transcode server will append a file name with _n (an underscore and the total number of files with the identical name plus 1).

-

The “name” property is optional and it can help you keep track of transcode jobs easily. “autoDeleteDuration” is another optional property that you can specify. It determines how soon your input file will be deleted. If autoDeleteDuration is set to zero, your input file will be removed immediately after the last transcode job running on it is completed. A value for autoDeleteDuration property is in seconds and the maximum value is 259200 which is 3 days.

-

An example SoftLayer_Network_Media_Transcode_Job parameter looks like this:

-
    -
  • name: My transcoding
  • -
  • transcodePresetName: F4V 896kbps 640x352 16x9 29.97fps
  • -
  • transcodePresetGuid: {87E01268-C3E3-4A85-9701-052C9AC42BD4}
  • -
  • inputFile: /in/my_birthday.wmv
  • -
  • outputFile: /out/my_birthday_flash
  • -
-

Notice that an output file does not have a file extension. The Transcode server will append a file extension based on an output format. A newly created transcode job will be in “Pending” status and it will be added to the Transcoding queue. You will receive a notification email whenever there is a status change on your transcode job. For example, the Transcode server starts to process your transcode job, you will be notified via an email.

-

You can add up to 3 pending jobs at a time. Transcode jobs with any other status such as “Complete” or “Error” will not be counted toward your pending jobs.

-

Once a job is complete, the Transcode server will place the output file into the /out directory along with a notification email. The files in the /out directory will be removed 3 days after they were created. You will need to use an FTP client to download transcoded files.

- - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
templateObjectSoftLayer_Network_Media_Transcode_JobThe SoftLayer_Network_Media_Transcode_Job object that you wish to create.
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - -
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Media_Transcode_Job/getHistory/index.html b/reference/services/SoftLayer_Network_Media_Transcode_Job/getHistory/index.html deleted file mode 100644 index 657378244b6..00000000000 --- a/reference/services/SoftLayer_Network_Media_Transcode_Job/getHistory/index.html +++ /dev/null @@ -1,275 +0,0 @@ - - - - - - - - - - - - - - - - getHistory - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getHistory

-
-
-
-
-
- Classes - - SoftLayer_Network_Media_Transcode_Job - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Media_Transcode_Job::getHistory -

- - -

- -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - -
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Media_Transcode_Job/getObject/index.html b/reference/services/SoftLayer_Network_Media_Transcode_Job/getObject/index.html deleted file mode 100644 index ddabdb25596..00000000000 --- a/reference/services/SoftLayer_Network_Media_Transcode_Job/getObject/index.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - - - - - - - - - - - getObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getObject

-
-
-
-
-
- Classes - - SoftLayer_Network_Media_Transcode_Job - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Media_Transcode_Job::getObject -

- - -

- Retrieve a SoftLayer_Network_Media_Transcode_Job record. -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - -
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Media_Transcode_Job/getTranscodeAccount/index.html b/reference/services/SoftLayer_Network_Media_Transcode_Job/getTranscodeAccount/index.html deleted file mode 100644 index bb3fd729477..00000000000 --- a/reference/services/SoftLayer_Network_Media_Transcode_Job/getTranscodeAccount/index.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - - - - - - - - - - - getTranscodeAccount - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getTranscodeAccount

-
-
-
-
-
- Classes - - SoftLayer_Network_Media_Transcode_Job - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Media_Transcode_Job::getTranscodeAccount -

- - -

- -

-

Description

- - The transcode service account - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - -
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Media_Transcode_Job/getTranscodeStatus/index.html b/reference/services/SoftLayer_Network_Media_Transcode_Job/getTranscodeStatus/index.html deleted file mode 100644 index d6cdceaacf8..00000000000 --- a/reference/services/SoftLayer_Network_Media_Transcode_Job/getTranscodeStatus/index.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - - - - - - - - - - - getTranscodeStatus - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getTranscodeStatus

-
-
-
-
-
- Classes - - SoftLayer_Network_Media_Transcode_Job - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Media_Transcode_Job::getTranscodeStatus -

- - -

- -

-

Description

- - The status information of a transcode job - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - -
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Media_Transcode_Job/getTranscodeStatusName/index.html b/reference/services/SoftLayer_Network_Media_Transcode_Job/getTranscodeStatusName/index.html deleted file mode 100644 index 547d3de8976..00000000000 --- a/reference/services/SoftLayer_Network_Media_Transcode_Job/getTranscodeStatusName/index.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - - - - - - - - - - - getTranscodeStatusName - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getTranscodeStatusName

-
-
-
-
-
- Classes - - SoftLayer_Network_Media_Transcode_Job - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Media_Transcode_Job::getTranscodeStatusName -

- - -

- -

-

Description

- - The status of a transcode job - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

-
  • - - - - string - -
- - - -
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Media_Transcode_Job/getUser/index.html b/reference/services/SoftLayer_Network_Media_Transcode_Job/getUser/index.html deleted file mode 100644 index b0767b0c63f..00000000000 --- a/reference/services/SoftLayer_Network_Media_Transcode_Job/getUser/index.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - - - - - - - - - - - getUser - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getUser

-
-
-
-
-
- Classes - - SoftLayer_Network_Media_Transcode_Job - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Media_Transcode_Job::getUser -

- - -

- -

-

Description

- - The SoftLayer user that created the transcode job - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - -
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Media_Transcode_Job/index.html b/reference/services/SoftLayer_Network_Media_Transcode_Job/index.html deleted file mode 100644 index a98cd186cd1..00000000000 --- a/reference/services/SoftLayer_Network_Media_Transcode_Job/index.html +++ /dev/null @@ -1,304 +0,0 @@ - - - - - - - - - - - - - SoftLayer_Network_Media_Transcode_Job - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_Media_Transcode_Job

-
-
-
-
-
- Classes - - SoftLayer_Network_Media_Transcode_Job - -
- Tags - - service - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Network_Media_Transcode_Job

- - -
- -
- - -

Description

- - SoftLayer_Network_Media_Transcode_Job holds information on a transcode job. To create a transcode job, use a SoftLayer_Network_Media_Transcode_Account object. - -
-

Methods

-
-
-
- -
-
-
-
- - - - - -
-

createObject

- -

Creates a transcode job

- -
- - - -
-

getHistory

- -

- -
- - - -
-

getObject

- -

Retrieve a SoftLayer_Network_Media_Transcode_Job record.

- -
- - - -
-

getTranscodeAccount

- -

The transcode service account

- -
- - - -
-

getTranscodeStatus

- -

The status information of a transcode job

- -
- - - -
-

getTranscodeStatusName

- -

The status of a transcode job

- -
- - - -
-

getUser

- -

The SoftLayer user that created the transcode job

- -
- - -
-
- -
- -
-
- - - -
- - - - - - - diff --git a/reference/services/SoftLayer_Network_Media_Transcode_Job_Status/getAllStatuses/index.html b/reference/services/SoftLayer_Network_Media_Transcode_Job_Status/getAllStatuses/index.html deleted file mode 100644 index d6e00e12aa8..00000000000 --- a/reference/services/SoftLayer_Network_Media_Transcode_Job_Status/getAllStatuses/index.html +++ /dev/null @@ -1,269 +0,0 @@ - - - - - - - - - - - - - - - - getAllStatuses - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getAllStatuses

-
-
-
-
-
- Classes - - SoftLayer_Network_Media_Transcode_Job_Status - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Media_Transcode_Job_Status::getAllStatuses -

- - -

- Returns all transcode job statuses -

-

Description

- - This method returns all transcode job statuses. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - -
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Media_Transcode_Job_Status/getObject/index.html b/reference/services/SoftLayer_Network_Media_Transcode_Job_Status/getObject/index.html deleted file mode 100644 index b2ab11d1c69..00000000000 --- a/reference/services/SoftLayer_Network_Media_Transcode_Job_Status/getObject/index.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - - - - - - - - - - - getObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getObject

-
-
-
-
-
- Classes - - SoftLayer_Network_Media_Transcode_Job_Status - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Media_Transcode_Job_Status::getObject -

- - -

- Retrieve a SoftLayer_Network_Media_Transcode_Job_Status record. -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - -
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Media_Transcode_Job_Status/index.html b/reference/services/SoftLayer_Network_Media_Transcode_Job_Status/index.html deleted file mode 100644 index 6f4b46d3f4b..00000000000 --- a/reference/services/SoftLayer_Network_Media_Transcode_Job_Status/index.html +++ /dev/null @@ -1,259 +0,0 @@ - - - - - - - - - - - - - SoftLayer_Network_Media_Transcode_Job_Status - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_Media_Transcode_Job_Status

-
-
-
-
-
- Classes - - SoftLayer_Network_Media_Transcode_Job_Status - -
- Tags - - service - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Network_Media_Transcode_Job_Status

- - -
- -
- - -

Description

- - A Transcode job’s status. It can be Pending, Processing, Complete, Error or Deleted. - -
-

Methods

-
-
-
- -
-
-
-
- - - - - -
-

getAllStatuses

- -

Returns all transcode job statuses

- -
- - - -
-

getObject

- -

Retrieve a SoftLayer_Network_Media_Transcode_Job_Status record.

- -
- - -
-
- -
- -
-
- - - -
- - - - - - - diff --git a/reference/services/SoftLayer_Network_Storage/getCdnUrls/index.html b/reference/services/SoftLayer_Network_Storage/getCdnUrls/index.html deleted file mode 100644 index 91a257385f2..00000000000 --- a/reference/services/SoftLayer_Network_Storage/getCdnUrls/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getCdnUrls - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getCdnUrls

-
-
-
-
-
- Classes - - SoftLayer_Network_Storage - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Storage::getCdnUrls -

- - -

- -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getCdnUrls'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Storage/getGraph/index.html b/reference/services/SoftLayer_Network_Storage/getGraph/index.html deleted file mode 100644 index f9b78cb8dc7..00000000000 --- a/reference/services/SoftLayer_Network_Storage/getGraph/index.html +++ /dev/null @@ -1,380 +0,0 @@ - - - - - - - - - - - - - - - - getGraph - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getGraph

-
-
-
-
-
- Classes - - SoftLayer_Network_Storage - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Storage::getGraph -

- - -
Deprecated
- -

- [DEPRECATED] Retrieve a graph representing the bandwidth used by a Storage account. -

-

Description

- -

{{CloudLayerOnlyMethod}} [DEPRECATED]

-

getGraph() retrieves a Storage account’s usage and returns a PNG graph image, title, and the minimum and maximum dates included in the graphed date range. Virtual Server storage accounts can also graph upload and download bandwidth usage.

- - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
startDatedateTimeThe starting date of the range of data you wish to collect.
endDatedateTimeThe ending date of the range of data you wish to collect.
typestringThe type of data you wish to graph. Either “usage”, “upload”, “download” or “bandwidth”.
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - -

Error Handling

-
    - - -
  • Throw the exception “Not yet implemented for this Storage type.” if the Storage type is not supported.
  • - - - - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [dateTime, dateTime, string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getGraph'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Storage_Backup_Evault/getCdnUrls/index.html b/reference/services/SoftLayer_Network_Storage_Backup_Evault/getCdnUrls/index.html deleted file mode 100644 index 942fd9ce406..00000000000 --- a/reference/services/SoftLayer_Network_Storage_Backup_Evault/getCdnUrls/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getCdnUrls - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getCdnUrls

-
-
-
-
-
- Classes - - SoftLayer_Network_Storage_Backup_Evault - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Storage_Backup_Evault::getCdnUrls -

- - -

- -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getCdnUrls'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Storage_Backup_Evault/getGraph/index.html b/reference/services/SoftLayer_Network_Storage_Backup_Evault/getGraph/index.html deleted file mode 100644 index 8a13b40f185..00000000000 --- a/reference/services/SoftLayer_Network_Storage_Backup_Evault/getGraph/index.html +++ /dev/null @@ -1,380 +0,0 @@ - - - - - - - - - - - - - - - - getGraph - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getGraph

-
-
-
-
-
- Classes - - SoftLayer_Network_Storage_Backup_Evault - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Storage_Backup_Evault::getGraph -

- - -
Deprecated
- -

- [DEPRECATED] Retrieve a graph representing the bandwidth used by a Storage account. -

-

Description

- -

{{CloudLayerOnlyMethod}} [DEPRECATED]

-

getGraph() retrieves a Storage account’s usage and returns a PNG graph image, title, and the minimum and maximum dates included in the graphed date range. Virtual Server storage accounts can also graph upload and download bandwidth usage.

- - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
startDatedateTimeThe starting date of the range of data you wish to collect.
endDatedateTimeThe ending date of the range of data you wish to collect.
typestringThe type of data you wish to graph. Either “usage”, “upload”, “download” or “bandwidth”.
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - -

Error Handling

-
    - - -
  • Throw the exception “Not yet implemented for this Storage type.” if the Storage type is not supported.
  • - - - - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [dateTime, dateTime, string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Storage_Backup_Evault/{SoftLayer_Network_Storage_Backup_EvaultID}/getGraph'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Storage_Iscsi/getCdnUrls/index.html b/reference/services/SoftLayer_Network_Storage_Iscsi/getCdnUrls/index.html deleted file mode 100644 index aa9504377d9..00000000000 --- a/reference/services/SoftLayer_Network_Storage_Iscsi/getCdnUrls/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getCdnUrls - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getCdnUrls

-
-
-
-
-
- Classes - - SoftLayer_Network_Storage_Iscsi - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Storage_Iscsi::getCdnUrls -

- - -

- -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getCdnUrls'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Storage_Iscsi/getGraph/index.html b/reference/services/SoftLayer_Network_Storage_Iscsi/getGraph/index.html deleted file mode 100644 index 9dc3816e636..00000000000 --- a/reference/services/SoftLayer_Network_Storage_Iscsi/getGraph/index.html +++ /dev/null @@ -1,380 +0,0 @@ - - - - - - - - - - - - - - - - getGraph - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getGraph

-
-
-
-
-
- Classes - - SoftLayer_Network_Storage_Iscsi - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Storage_Iscsi::getGraph -

- - -
Deprecated
- -

- [DEPRECATED] Retrieve a graph representing the bandwidth used by a Storage account. -

-

Description

- -

{{CloudLayerOnlyMethod}} [DEPRECATED]

-

getGraph() retrieves a Storage account’s usage and returns a PNG graph image, title, and the minimum and maximum dates included in the graphed date range. Virtual Server storage accounts can also graph upload and download bandwidth usage.

- - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
startDatedateTimeThe starting date of the range of data you wish to collect.
endDatedateTimeThe ending date of the range of data you wish to collect.
typestringThe type of data you wish to graph. Either “usage”, “upload”, “download” or “bandwidth”.
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - -

Error Handling

-
    - - -
  • Throw the exception “Not yet implemented for this Storage type.” if the Storage type is not supported.
  • - - - - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [dateTime, dateTime, string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Storage_Iscsi/{SoftLayer_Network_Storage_IscsiID}/getGraph'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/getAllObjects/index.html b/reference/services/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/getAllObjects/index.html deleted file mode 100644 index 9b63f09c4e7..00000000000 --- a/reference/services/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/getAllObjects/index.html +++ /dev/null @@ -1,328 +0,0 @@ - - - - - - - - - - - - - - - - getAllObjects - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getAllObjects

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref::getAllObjects -

- - -

- -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/getAllObjects'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/getCountry/index.html b/reference/services/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/getCountry/index.html deleted file mode 100644 index cf49d12606b..00000000000 --- a/reference/services/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/getCountry/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getCountry - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getCountry

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref::getCountry -

- - -

- -

-

Description

- - SoftLayer_Locale_Country Id. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/{SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_XrefID}/getCountry'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/getLocationGroup/index.html b/reference/services/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/getLocationGroup/index.html deleted file mode 100644 index ad641c039c8..00000000000 --- a/reference/services/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/getLocationGroup/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getLocationGroup - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getLocationGroup

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref::getLocationGroup -

- - -

- -

-

Description

- - Location Group ID of CleverSafe cross region. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/{SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_XrefID}/getLocationGroup'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/getObject/index.html b/reference/services/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/getObject/index.html deleted file mode 100644 index a395510b6de..00000000000 --- a/reference/services/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/getObject/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getObject

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref::getObject -

- - -

- Retrieve a SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref record. -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/{SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_XrefID}/getObject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/getValidCountriesForRegion/index.html b/reference/services/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/getValidCountriesForRegion/index.html deleted file mode 100644 index 124d8204a2d..00000000000 --- a/reference/services/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/getValidCountriesForRegion/index.html +++ /dev/null @@ -1,345 +0,0 @@ - - - - - - - - - - - - - - - - getValidCountriesForRegion - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getValidCountriesForRegion

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref::getValidCountriesForRegion -

- - -

- return countries assigned to the region having pricing info set. -

-

Description

- - Returns countries assigned to the region having pricing info set. - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
locationGroupNamestring
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/getValidCountriesForRegion'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/index.html b/reference/services/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/index.html deleted file mode 100644 index 1a23065e6fb..00000000000 --- a/reference/services/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/index.html +++ /dev/null @@ -1,337 +0,0 @@ - - - - - - - - - - - - - SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref

- - -
- -
- - -

Description

- - MassDataMigration_CrossRegion_Country_Xref provides a list of countries where Mass Data Migration Device could be shipped for each CleverSafe Object Storage Region. - -
-

Methods

-
-
-
- -
-
-
-
- - - - - -
-

getAllObjects

- -

- -
- - - -
-

getCountry

- -

SoftLayer_Locale_Country Id.

- -
- - - -
-

getLocationGroup

- -

Location Group ID of CleverSafe cross region.

- -
- - - -
-

getObject

- -

Retrieve a SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref record.

- -
- - - -
-

getValidCountriesForRegion

- -

return countries assigned to the region having pricing info set.

- -
- - -
-
- -
- -
-
- - - -
- - - - - - - diff --git a/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getAccount/index.html b/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getAccount/index.html deleted file mode 100644 index 266a38fd953..00000000000 --- a/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getAccount/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getAccount - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getAccount

-
-
-
-
-
- Classes - - SoftLayer_Network_Storage_MassDataMigration_Request - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Storage_MassDataMigration_Request::getAccount -

- - -

- -

-

Description

- - The account to which the request belongs. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Storage_MassDataMigration_Request/{SoftLayer_Network_Storage_MassDataMigration_RequestID}/getAccount'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getActiveTickets/index.html b/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getActiveTickets/index.html deleted file mode 100644 index 21e009c8cdc..00000000000 --- a/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getActiveTickets/index.html +++ /dev/null @@ -1,330 +0,0 @@ - - - - - - - - - - - - - - - - getActiveTickets - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getActiveTickets

-
-
-
-
-
- Classes - - SoftLayer_Network_Storage_MassDataMigration_Request - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Storage_MassDataMigration_Request::getActiveTickets -

- - -

- -

-

Description

- - The active tickets that are attached to the MDMS request. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Storage_MassDataMigration_Request/{SoftLayer_Network_Storage_MassDataMigration_RequestID}/getActiveTickets'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getAddress/index.html b/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getAddress/index.html deleted file mode 100644 index f0641e89b73..00000000000 --- a/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getAddress/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getAddress - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getAddress

-
-
-
-
-
- Classes - - SoftLayer_Network_Storage_MassDataMigration_Request - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Storage_MassDataMigration_Request::getAddress -

- - -

- -

-

Description

- - The customer address where the device is shipped to. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Storage_MassDataMigration_Request/{SoftLayer_Network_Storage_MassDataMigration_RequestID}/getAddress'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getAllObjects/index.html b/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getAllObjects/index.html deleted file mode 100644 index 1630a1483bd..00000000000 --- a/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getAllObjects/index.html +++ /dev/null @@ -1,328 +0,0 @@ - - - - - - - - - - - - - - - - getAllObjects - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getAllObjects

-
-
-
-
-
- Classes - - SoftLayer_Network_Storage_MassDataMigration_Request - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Storage_MassDataMigration_Request::getAllObjects -

- - -

- -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Storage_MassDataMigration_Request/getAllObjects'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getAllRequestStatuses/index.html b/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getAllRequestStatuses/index.html deleted file mode 100644 index 92625193625..00000000000 --- a/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getAllRequestStatuses/index.html +++ /dev/null @@ -1,324 +0,0 @@ - - - - - - - - - - - - - - - - getAllRequestStatuses - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getAllRequestStatuses

-
-
-
-
-
- Classes - - SoftLayer_Network_Storage_MassDataMigration_Request - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Storage_MassDataMigration_Request::getAllRequestStatuses -

- - -

- Retrieves a list of all the possible statuses -

-

Description

- - Retrieves a list of all the possible statuses to which a request may be set. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Storage_MassDataMigration_Request/getAllRequestStatuses'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getBillingItem/index.html b/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getBillingItem/index.html deleted file mode 100644 index 2fb61bf838d..00000000000 --- a/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getBillingItem/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getBillingItem - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getBillingItem

-
-
-
-
-
- Classes - - SoftLayer_Network_Storage_MassDataMigration_Request - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Storage_MassDataMigration_Request::getBillingItem -

- - -

- -

-

Description

- - An associated parent billing item which is active. Includes billing items which are scheduled to be cancelled in the future. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Storage_MassDataMigration_Request/{SoftLayer_Network_Storage_MassDataMigration_RequestID}/getBillingItem'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getCreateEmployee/index.html b/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getCreateEmployee/index.html deleted file mode 100644 index 009893943e6..00000000000 --- a/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getCreateEmployee/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getCreateEmployee - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getCreateEmployee

-
-
-
-
-
- Classes - - SoftLayer_Network_Storage_MassDataMigration_Request - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Storage_MassDataMigration_Request::getCreateEmployee -

- - -

- -

-

Description

- - The employee user who created the request. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Storage_MassDataMigration_Request/{SoftLayer_Network_Storage_MassDataMigration_RequestID}/getCreateEmployee'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getCreateUser/index.html b/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getCreateUser/index.html deleted file mode 100644 index db3d8e1070f..00000000000 --- a/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getCreateUser/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getCreateUser - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getCreateUser

-
-
-
-
-
- Classes - - SoftLayer_Network_Storage_MassDataMigration_Request - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Storage_MassDataMigration_Request::getCreateUser -

- - -

- -

-

Description

- - The customer user who created the request. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Storage_MassDataMigration_Request/{SoftLayer_Network_Storage_MassDataMigration_RequestID}/getCreateUser'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getDeviceConfiguration/index.html b/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getDeviceConfiguration/index.html deleted file mode 100644 index a5e7d02e0d9..00000000000 --- a/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getDeviceConfiguration/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getDeviceConfiguration - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getDeviceConfiguration

-
-
-
-
-
- Classes - - SoftLayer_Network_Storage_MassDataMigration_Request - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Storage_MassDataMigration_Request::getDeviceConfiguration -

- - -

- -

-

Description

- - The device configurations. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Storage_MassDataMigration_Request/{SoftLayer_Network_Storage_MassDataMigration_RequestID}/getDeviceConfiguration'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getDeviceModel/index.html b/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getDeviceModel/index.html deleted file mode 100644 index 5b8fc99b3ce..00000000000 --- a/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getDeviceModel/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getDeviceModel - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getDeviceModel

-
-
-
-
-
- Classes - - SoftLayer_Network_Storage_MassDataMigration_Request - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Storage_MassDataMigration_Request::getDeviceModel -

- - -

- -

-

Description

- - The model of device assigned to this request. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

-
  • - - - - string - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Storage_MassDataMigration_Request/{SoftLayer_Network_Storage_MassDataMigration_RequestID}/getDeviceModel'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getKeyContacts/index.html b/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getKeyContacts/index.html deleted file mode 100644 index 2dc8ee9ad50..00000000000 --- a/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getKeyContacts/index.html +++ /dev/null @@ -1,330 +0,0 @@ - - - - - - - - - - - - - - - - getKeyContacts - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getKeyContacts

-
-
-
-
-
- Classes - - SoftLayer_Network_Storage_MassDataMigration_Request - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Storage_MassDataMigration_Request::getKeyContacts -

- - -

- -

-

Description

- - The key contacts for this requests. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Storage_MassDataMigration_Request/{SoftLayer_Network_Storage_MassDataMigration_RequestID}/getKeyContacts'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getModifyEmployee/index.html b/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getModifyEmployee/index.html deleted file mode 100644 index f816685a953..00000000000 --- a/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getModifyEmployee/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getModifyEmployee - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getModifyEmployee

-
-
-
-
-
- Classes - - SoftLayer_Network_Storage_MassDataMigration_Request - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Storage_MassDataMigration_Request::getModifyEmployee -

- - -

- -

-

Description

- - The employee who last modified the request. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Storage_MassDataMigration_Request/{SoftLayer_Network_Storage_MassDataMigration_RequestID}/getModifyEmployee'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getModifyUser/index.html b/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getModifyUser/index.html deleted file mode 100644 index 807e774e820..00000000000 --- a/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getModifyUser/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getModifyUser - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getModifyUser

-
-
-
-
-
- Classes - - SoftLayer_Network_Storage_MassDataMigration_Request - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Storage_MassDataMigration_Request::getModifyUser -

- - -

- -

-

Description

- - The customer user who last modified the request. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Storage_MassDataMigration_Request/{SoftLayer_Network_Storage_MassDataMigration_RequestID}/getModifyUser'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getObject/index.html b/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getObject/index.html deleted file mode 100644 index 2559b4f29b3..00000000000 --- a/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getObject/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getObject

-
-
-
-
-
- Classes - - SoftLayer_Network_Storage_MassDataMigration_Request - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Storage_MassDataMigration_Request::getObject -

- - -

- Retrieve a SoftLayer_Network_Storage_MassDataMigration_Request record. -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Storage_MassDataMigration_Request/{SoftLayer_Network_Storage_MassDataMigration_RequestID}/getObject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getPendingRequests/index.html b/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getPendingRequests/index.html deleted file mode 100644 index 89aae7f536e..00000000000 --- a/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getPendingRequests/index.html +++ /dev/null @@ -1,324 +0,0 @@ - - - - - - - - - - - - - - - - getPendingRequests - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getPendingRequests

-
-
-
-
-
- Classes - - SoftLayer_Network_Storage_MassDataMigration_Request - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Storage_MassDataMigration_Request::getPendingRequests -

- - -

- Returns placeholder MDMS requests for any MDMS order pending approval. -

-

Description

- - Returns placeholder MDMS requests for any MDMS order pending approval. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Storage_MassDataMigration_Request/getPendingRequests'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getShipments/index.html b/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getShipments/index.html deleted file mode 100644 index 1b361a1d2eb..00000000000 --- a/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getShipments/index.html +++ /dev/null @@ -1,330 +0,0 @@ - - - - - - - - - - - - - - - - getShipments - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getShipments

-
-
-
-
-
- Classes - - SoftLayer_Network_Storage_MassDataMigration_Request - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Storage_MassDataMigration_Request::getShipments -

- - -

- -

-

Description

- - The shipments of the request. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Storage_MassDataMigration_Request/{SoftLayer_Network_Storage_MassDataMigration_RequestID}/getShipments'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getStatus/index.html b/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getStatus/index.html deleted file mode 100644 index 044ad506a9c..00000000000 --- a/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getStatus/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getStatus - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getStatus

-
-
-
-
-
- Classes - - SoftLayer_Network_Storage_MassDataMigration_Request - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Storage_MassDataMigration_Request::getStatus -

- - -

- -

-

Description

- - The status of the request. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Storage_MassDataMigration_Request/{SoftLayer_Network_Storage_MassDataMigration_RequestID}/getStatus'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getTicket/index.html b/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getTicket/index.html deleted file mode 100644 index c5812ace9e8..00000000000 --- a/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getTicket/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getTicket - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getTicket

-
-
-
-
-
- Classes - - SoftLayer_Network_Storage_MassDataMigration_Request - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Storage_MassDataMigration_Request::getTicket -

- - -

- -

-

Description

- - Ticket that is attached to this mass data migration request. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Storage_MassDataMigration_Request/{SoftLayer_Network_Storage_MassDataMigration_RequestID}/getTicket'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getTickets/index.html b/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getTickets/index.html deleted file mode 100644 index 1f1dcb18004..00000000000 --- a/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/getTickets/index.html +++ /dev/null @@ -1,330 +0,0 @@ - - - - - - - - - - - - - - - - getTickets - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getTickets

-
-
-
-
-
- Classes - - SoftLayer_Network_Storage_MassDataMigration_Request - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Storage_MassDataMigration_Request::getTickets -

- - -

- -

-

Description

- - All tickets that are attached to the mass data migration request. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Storage_MassDataMigration_Request/{SoftLayer_Network_Storage_MassDataMigration_RequestID}/getTickets'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/index.html b/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/index.html deleted file mode 100644 index 437bcd23b1b..00000000000 --- a/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request/index.html +++ /dev/null @@ -1,463 +0,0 @@ - - - - - - - - - - - - - SoftLayer_Network_Storage_MassDataMigration_Request - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_Storage_MassDataMigration_Request

-
-
-
-
-
- Classes - - SoftLayer_Network_Storage_MassDataMigration_Request - -
- Tags - - service - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Network_Storage_MassDataMigration_Request

- - -
- -
- - -

Description

- - Mass Data Migration Request Service allows users to request Massive storage device to copy onsite data. Once user has copied their data onto device, they ship it back to SoftLayer where device is connected to network and data is transferred to Object Storage bucket. Currently, the initial usage period is two weeks . Additional time for maintaining the media for continued may be purchased. Please contact sales for additional information regarding this. Once the usage period has elapsed. SoftLayer will disconnect the device. - -
-

Methods

-
-
-
- -
-
-
-
- - - - - -
-

getAccount

- -

The account to which the request belongs.

- -
- - - -
-

getActiveTickets

- -

The active tickets that are attached to the MDMS request.

- -
- - - -
-

getAddress

- -

The customer address where the device is shipped to.

- -
- - - -
-

getAllObjects

- -

- -
- - - -
-

getAllRequestStatuses

- -

Retrieves a list of all the possible statuses

- -
- - - -
-

getBillingItem

- -

An associated parent billing item which is active. Includes billing items which are scheduled to be cancelled in the future.

- -
- - - -
-

getCreateEmployee

- -

The employee user who created the request.

- -
- - - -
-

getCreateUser

- -

The customer user who created the request.

- -
- - - -
-

getDeviceConfiguration

- -

The device configurations.

- -
- - - -
-

getDeviceModel

- -

The model of device assigned to this request.

- -
- - - -
-

getKeyContacts

- -

The key contacts for this requests.

- -
- - - -
-

getModifyEmployee

- -

The employee who last modified the request.

- -
- - - -
-

getModifyUser

- -

The customer user who last modified the request.

- -
- - - -
-

getObject

- -

Retrieve a SoftLayer_Network_Storage_MassDataMigration_Request record.

- -
- - - -
-

getPendingRequests

- -

Returns placeholder MDMS requests for any MDMS order pending approval.

- -
- - - -
-

getShipments

- -

The shipments of the request.

- -
- - - -
-

getStatus

- -

The status of the request.

- -
- - - -
-

getTicket

- -

Ticket that is attached to this mass data migration request.

- -
- - - -
-

getTickets

- -

All tickets that are attached to the mass data migration request.

- -
- - -
-
- -
- -
-
- - - -
- - - - - - - diff --git a/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact/getAccount/index.html b/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact/getAccount/index.html deleted file mode 100644 index 6fb16ca8077..00000000000 --- a/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact/getAccount/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getAccount - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getAccount

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact::getAccount -

- - -

- -

-

Description

- - The request this key contact belongs to. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact/{SoftLayer_Network_Storage_MassDataMigration_Request_KeyContactID}/getAccount'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact/getObject/index.html b/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact/getObject/index.html deleted file mode 100644 index c8ffb5221af..00000000000 --- a/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact/getObject/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getObject

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact::getObject -

- - -

- Retrieve a SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact record. -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact/{SoftLayer_Network_Storage_MassDataMigration_Request_KeyContactID}/getObject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact/getRequest/index.html b/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact/getRequest/index.html deleted file mode 100644 index 1372c9324d2..00000000000 --- a/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact/getRequest/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getRequest - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getRequest

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact::getRequest -

- - -

- -

-

Description

- - The request this key contact belongs to. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact/{SoftLayer_Network_Storage_MassDataMigration_Request_KeyContactID}/getRequest'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact/index.html b/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact/index.html deleted file mode 100644 index 68381ec9f1e..00000000000 --- a/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact/index.html +++ /dev/null @@ -1,319 +0,0 @@ - - - - - - - - - - - - - SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact

- - -
- -
- - -

Description

- - The SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact data type contains name, email, and phone for key contact at customer location who will handle Mass Data Migration. - -
-

Methods

-
-
-
- -
-
-
-
- - - - - -
-

getAccount

- -

The request this key contact belongs to.

- -
- - - -
-

getObject

- -

Retrieve a SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact record.

- -
- - - -
-

getRequest

- -

The request this key contact belongs to.

- -
- - -
-
- -
- -
-
- - - -
- - - - - - - diff --git a/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request_Status/getObject/index.html b/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request_Status/getObject/index.html deleted file mode 100644 index a116049760d..00000000000 --- a/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request_Status/getObject/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getObject

-
-
-
-
- -
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Storage_MassDataMigration_Request_Status::getObject -

- - -

- Retrieve a SoftLayer_Network_Storage_MassDataMigration_Request_Status record. -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Storage_MassDataMigration_Request_Status/{SoftLayer_Network_Storage_MassDataMigration_Request_StatusID}/getObject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request_Status/index.html b/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request_Status/index.html deleted file mode 100644 index 4f0bb3ee40f..00000000000 --- a/reference/services/SoftLayer_Network_Storage_MassDataMigration_Request_Status/index.html +++ /dev/null @@ -1,301 +0,0 @@ - - - - - - - - - - - - - SoftLayer_Network_Storage_MassDataMigration_Request_Status - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_Storage_MassDataMigration_Request_Status

-
-
-
-
- -
-
- -
-
- - - -
-
- -

SoftLayer_Network_Storage_MassDataMigration_Request_Status

- - -
- -
- - -

Description

- - - -
-

Methods

-
-
-
- -
-
-
-
- - - - - -
-

getObject

- -

Retrieve a SoftLayer_Network_Storage_MassDataMigration_Request_Status record.

- -
- - -
-
- -
- -
-
- - - -
- - - - - - - diff --git a/reference/services/SoftLayer_Network_Subnet/createSubnetRouteUpdateTransaction/index.html b/reference/services/SoftLayer_Network_Subnet/createSubnetRouteUpdateTransaction/index.html deleted file mode 100644 index 0e6f91a425c..00000000000 --- a/reference/services/SoftLayer_Network_Subnet/createSubnetRouteUpdateTransaction/index.html +++ /dev/null @@ -1,350 +0,0 @@ - - - - - - - - - - - - - - - - createSubnetRouteUpdateTransaction - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

createSubnetRouteUpdateTransaction

-
-
-
-
-
- Classes - - SoftLayer_Network_Subnet - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Subnet::createSubnetRouteUpdateTransaction -

- - -
Deprecated
- -

- create a new transaction to modify a subnet route. -

-

Description

- -

DEPRECATED -This endpoint is deprecated in favor of the more expressive and capable SoftLayer_Network_Subnet::route, to which this endpoint now proxies. Refer to it for more information.

-

Similarly, unroute requests are proxied to SoftLayer_Network_Subnet::clearRoute.

- - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
newEndPointIpAddressstringThe IP address to route the subnet to
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - boolean - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/createSubnetRouteUpdateTransaction'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Subnet/createSwipTransaction/index.html b/reference/services/SoftLayer_Network_Subnet/createSwipTransaction/index.html deleted file mode 100644 index 1310feb2f2a..00000000000 --- a/reference/services/SoftLayer_Network_Subnet/createSwipTransaction/index.html +++ /dev/null @@ -1,350 +0,0 @@ - - - - - - - - - - - - - - - - createSwipTransaction - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

createSwipTransaction

-
-
-
-
-
- Classes - - SoftLayer_Network_Subnet - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Subnet::createSwipTransaction -

- - -
Deprecated
- -

- create a SWIP transaction for a subnet -

-

Description

- - DEPRECATED -This function is used to create a new SoftLayer SWIP transaction to register your RWHOIS data with ARIN. SWIP transactions can only be initiated on subnets that contain more than 8 IP addresses. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - boolean - -
- -

Error Handling

-
    - - -
  • Exception thrown if a SWIP is attempted on a private network subnet.
  • - - - - - -
  • Exception thrown if a SWIP is attempted on a subnet smaller than 8 IP addresses.
  • - - - - - -
  • Exception thrown if a SWIP is attempted on a subnet that already has a SWIP transaction in progress.
  • - - - - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/createSwipTransaction'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Subnet/findAllSubnetsAndActiveSwipTransactionStatus/index.html b/reference/services/SoftLayer_Network_Subnet/findAllSubnetsAndActiveSwipTransactionStatus/index.html deleted file mode 100644 index 41a353d4da7..00000000000 --- a/reference/services/SoftLayer_Network_Subnet/findAllSubnetsAndActiveSwipTransactionStatus/index.html +++ /dev/null @@ -1,333 +0,0 @@ - - - - - - - - - - - - - - - - findAllSubnetsAndActiveSwipTransactionStatus - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

findAllSubnetsAndActiveSwipTransactionStatus

-
-
-
-
-
- Classes - - SoftLayer_Network_Subnet - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Subnet::findAllSubnetsAndActiveSwipTransactionStatus -

- - -
Deprecated
- -

- Retrieve a list of subnets along with their SWIP transaction statuses. -

-

Description

- -

DEPRECATED -Retrieve a list of a SoftLayer customer’s subnets along with their SWIP transaction statuses. This is a shortcut method that combines the SoftLayer_Network_Subnet retrieval methods along with [[object masks]] to retrieve their subnets’ associated SWIP transactions as well.

-

This is a special function built for SoftLayer’s use on the SWIP section of the customer portal, but may also be useful for API users looking for the same data.

- - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Subnet/findAllSubnetsAndActiveSwipTransactionStatus'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Subnet/getActiveRegistration/index.html b/reference/services/SoftLayer_Network_Subnet/getActiveRegistration/index.html deleted file mode 100644 index c631f10c0f9..00000000000 --- a/reference/services/SoftLayer_Network_Subnet/getActiveRegistration/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getActiveRegistration - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getActiveRegistration

-
-
-
-
-
- Classes - - SoftLayer_Network_Subnet - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Subnet::getActiveRegistration -

- - -

- -

-

Description

- - The active regional internet registration for this subnet. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/getActiveRegistration'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Subnet/getActiveSwipTransaction/index.html b/reference/services/SoftLayer_Network_Subnet/getActiveSwipTransaction/index.html deleted file mode 100644 index e7a072ff510..00000000000 --- a/reference/services/SoftLayer_Network_Subnet/getActiveSwipTransaction/index.html +++ /dev/null @@ -1,328 +0,0 @@ - - - - - - - - - - - - - - - - getActiveSwipTransaction - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getActiveSwipTransaction

-
-
-
-
-
- Classes - - SoftLayer_Network_Subnet - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Subnet::getActiveSwipTransaction -

- - -
Deprecated
- -

- -

-

Description

- - DEPRECATED - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/getActiveSwipTransaction'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Subnet/getBoundRouters/index.html b/reference/services/SoftLayer_Network_Subnet/getBoundRouters/index.html deleted file mode 100644 index 9812d5cba02..00000000000 --- a/reference/services/SoftLayer_Network_Subnet/getBoundRouters/index.html +++ /dev/null @@ -1,332 +0,0 @@ - - - - - - - - - - - - - - - - getBoundRouters - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getBoundRouters

-
-
-
-
-
- Classes - - SoftLayer_Network_Subnet - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Subnet::getBoundRouters -

- - -
Deprecated
- -

- -

-

Description

- - [DEPRECATED] The list of network routers that this subnet is directly associated with, defining where this subnet may be routed on the network. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/getBoundRouters'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Subnet/getRegistrations/index.html b/reference/services/SoftLayer_Network_Subnet/getRegistrations/index.html deleted file mode 100644 index 33b0a914b9c..00000000000 --- a/reference/services/SoftLayer_Network_Subnet/getRegistrations/index.html +++ /dev/null @@ -1,330 +0,0 @@ - - - - - - - - - - - - - - - - getRegistrations - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getRegistrations

-
-
-
-
-
- Classes - - SoftLayer_Network_Subnet - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Subnet::getRegistrations -

- - -

- -

-

Description

- - The regional internet registrations that have been created for this subnet. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/getRegistrations'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Subnet/getSwipTransaction/index.html b/reference/services/SoftLayer_Network_Subnet/getSwipTransaction/index.html deleted file mode 100644 index b7565159e98..00000000000 --- a/reference/services/SoftLayer_Network_Subnet/getSwipTransaction/index.html +++ /dev/null @@ -1,332 +0,0 @@ - - - - - - - - - - - - - - - - getSwipTransaction - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getSwipTransaction

-
-
-
-
-
- Classes - - SoftLayer_Network_Subnet - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Subnet::getSwipTransaction -

- - -
Deprecated
- -

- -

-

Description

- - DEPRECATED - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/getSwipTransaction'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Subnet_IpAddress_Global/getActiveTransaction/index.html b/reference/services/SoftLayer_Network_Subnet_IpAddress_Global/getActiveTransaction/index.html deleted file mode 100644 index 75603c56fb3..00000000000 --- a/reference/services/SoftLayer_Network_Subnet_IpAddress_Global/getActiveTransaction/index.html +++ /dev/null @@ -1,328 +0,0 @@ - - - - - - - - - - - - - - - - getActiveTransaction - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getActiveTransaction

-
-
-
-
-
- Classes - - SoftLayer_Network_Subnet_IpAddress_Global - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Subnet_IpAddress_Global::getActiveTransaction -

- - -
Deprecated
- -

- -

-

Description

- - DEPRECATED - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Subnet_IpAddress_Global/{SoftLayer_Network_Subnet_IpAddress_GlobalID}/getActiveTransaction'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Subnet_IpAddress_Global/unroute/index.html b/reference/services/SoftLayer_Network_Subnet_IpAddress_Global/unroute/index.html deleted file mode 100644 index e38ae7922c3..00000000000 --- a/reference/services/SoftLayer_Network_Subnet_IpAddress_Global/unroute/index.html +++ /dev/null @@ -1,327 +0,0 @@ - - - - - - - - - - - - - - - - unroute - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

unroute

-
-
-
-
-
- Classes - - SoftLayer_Network_Subnet_IpAddress_Global - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Subnet_IpAddress_Global::unroute -

- - -
Deprecated
- -

- -

-

Description

- - DEPRECATED -This endpoint is deprecated in favor of SoftLayer_Network_Subnet::clearRoute, to which this endpoint now proxies. Refer to it for more information. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - boolean - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Subnet_IpAddress_Global/{SoftLayer_Network_Subnet_IpAddress_GlobalID}/unroute'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Subnet_Registration/clearRegistration/index.html b/reference/services/SoftLayer_Network_Subnet_Registration/clearRegistration/index.html deleted file mode 100644 index bb4f9e4791e..00000000000 --- a/reference/services/SoftLayer_Network_Subnet_Registration/clearRegistration/index.html +++ /dev/null @@ -1,328 +0,0 @@ - - - - - - - - - - - - - - - - clearRegistration - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

clearRegistration

-
-
-
-
-
- Classes - - SoftLayer_Network_Subnet_Registration - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Subnet_Registration::clearRegistration -

- - -
Deprecated
- -

- [Deprecated] Clear an existing registration -

-

Description

- -

The subnet registration service has been deprecated.

-

This method will initiate the removal of a subnet registration.

- - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - boolean - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Subnet_Registration/{SoftLayer_Network_Subnet_RegistrationID}/clearRegistration'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Subnet_Registration/createObject/index.html b/reference/services/SoftLayer_Network_Subnet_Registration/createObject/index.html deleted file mode 100644 index 9ab0ecc21eb..00000000000 --- a/reference/services/SoftLayer_Network_Subnet_Registration/createObject/index.html +++ /dev/null @@ -1,403 +0,0 @@ - - - - - - - - - - - - - - - - createObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

createObject

-
-
-
-
-
- Classes - - SoftLayer_Network_Subnet_Registration - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Subnet_Registration::createObject -

- - -
Deprecated
- -

- [Deprecated] Create a new subnet registration -

-

Description

- -

The subnet registration service has been deprecated.

-

Create registration with a global registrar to associate an assigned subnet with the provided contact details.

-

Contact information is provided in the form of a SoftLayer_Account_Regional_Registry_Detail, which reference can be provided when the registration is created or afterwards. Registrations without an associated person detail will remain in the OPEN status. To specify a person detail when creating a registration, the detailReferences property should be populated with a list item providing a detailId value referencing the SoftLayer_Account_Regional_Registry_Detail.

-

The same applies to SoftLayer_Account_Regional_Registry_Detail, though these references need not be provided. The system will create a reference to the network described by the registration’s subnet in the absence of a provided network detail reference. However, if a specific detail is referenced, it must describe the same subnet as the registration.

-

A template containing the following properties will create a subnet registration:

-
    -
  • networkIdentifier
  • -
  • cidr
  • -
  • detailReferences
  • -
-

networkIdentifier is the base address of the public, SoftLayer owned subnet which is being registered. cidr must be an integer representing the CIDR of the subnet to be registered. The networkIdentifier/cidr must represent an assigned subnet. detailReferences tie the registration to SoftLayer_Account_Regional_Registry_Detail objects.

- - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
templateObjectSoftLayer_Network_Subnet_RegistrationThe SoftLayer_Network_Subnet_Registration object that you wish to create.
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - -

Error Handling

-
    - - -
  • If a registration already exists for the subnet.
  • - - - - - -
  • If incapable of creating a registration for the provided subnet.
  • - - - - - -
  • If the subnet registration request is invalid.
  • - - - - - -
  • If the subnet could not be found for that account
  • - - - - - -
  • If the registration could not be created at this time and should be retried later.
  • - - - - -
- - - -

Associated Methods

- - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [SoftLayer_Network_Subnet_Registration]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Subnet_Registration/createObject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Subnet_Registration/createObjects/index.html b/reference/services/SoftLayer_Network_Subnet_Registration/createObjects/index.html deleted file mode 100644 index 4d7ebc88ee4..00000000000 --- a/reference/services/SoftLayer_Network_Subnet_Registration/createObjects/index.html +++ /dev/null @@ -1,360 +0,0 @@ - - - - - - - - - - - - - - - - createObjects - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

createObjects

-
-
-
-
-
- Classes - - SoftLayer_Network_Subnet_Registration - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Subnet_Registration::createObjects -

- - -
Deprecated
- -

- [Deprecated] Create registrations for multiple subnets -

-

Description

- -

The subnet registration service has been deprecated.

-

Create registrations with respective registrars to associate multiple assigned subnets with the provided contact details.

- - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
templateObjectsSoftLayer_Network_Subnet_Registration[]An array of SoftLayer_Network_Subnet_Registration objects that you wish to create.
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - -

Associated Methods

- - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [SoftLayer_Network_Subnet_Registration]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Subnet_Registration/createObjects'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Subnet_Registration/editObject/index.html b/reference/services/SoftLayer_Network_Subnet_Registration/editObject/index.html deleted file mode 100644 index c5ece94e463..00000000000 --- a/reference/services/SoftLayer_Network_Subnet_Registration/editObject/index.html +++ /dev/null @@ -1,350 +0,0 @@ - - - - - - - - - - - - - - - - editObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

editObject

-
-
-
-
-
- Classes - - SoftLayer_Network_Subnet_Registration - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Subnet_Registration::editObject -

- - -
Deprecated
- -

- [Deprecated] Edit an existing registration object -

-

Description

- -

The subnet registration service has been deprecated.

-

This method will edit an existing SoftLayer_Network_Subnet_Registration object. For more detail, see SoftLayer_Network_Subnet_Registration::createObject.

- - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
templateObjectSoftLayer_Network_Subnet_RegistrationA skeleton SoftLayer_Network_Subnet_Registration object with only the properties defined that you wish to change. Unchanged properties are left alone.
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - boolean - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [SoftLayer_Network_Subnet_Registration]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Subnet_Registration/{SoftLayer_Network_Subnet_RegistrationID}/editObject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Subnet_Registration/editRegistrationAttachedDetails/index.html b/reference/services/SoftLayer_Network_Subnet_Registration/editRegistrationAttachedDetails/index.html deleted file mode 100644 index 3188729c4ed..00000000000 --- a/reference/services/SoftLayer_Network_Subnet_Registration/editRegistrationAttachedDetails/index.html +++ /dev/null @@ -1,359 +0,0 @@ - - - - - - - - - - - - - - - - editRegistrationAttachedDetails - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

editRegistrationAttachedDetails

-
-
-
-
-
- Classes - - SoftLayer_Network_Subnet_Registration - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Subnet_Registration::editRegistrationAttachedDetails -

- - -
Deprecated
- -

- [Deprecated] Modify the link between a SoftLayer_Network_Subnet_Registration object and two SoftLayer_Account_Regional_Registry_Detail objects simultaneously. -

-

Description

- -

The subnet registration service has been deprecated.

-

This method modifies a single registration by modifying the current SoftLayer_Network_Subnet_Registration_Details objects that are linked to that registration.

- - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
personObjectSkeletonSoftLayer_Network_Subnet_Registration_Details
networkObjectSkeletonSoftLayer_Network_Subnet_Registration_Details
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - boolean - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [SoftLayer_Network_Subnet_Registration_Details, SoftLayer_Network_Subnet_Registration_Details]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Subnet_Registration/editRegistrationAttachedDetails'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Subnet_Registration/getAccount/index.html b/reference/services/SoftLayer_Network_Subnet_Registration/getAccount/index.html deleted file mode 100644 index c1b7b682984..00000000000 --- a/reference/services/SoftLayer_Network_Subnet_Registration/getAccount/index.html +++ /dev/null @@ -1,328 +0,0 @@ - - - - - - - - - - - - - - - - getAccount - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getAccount

-
-
-
-
-
- Classes - - SoftLayer_Network_Subnet_Registration - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Subnet_Registration::getAccount -

- - -
Deprecated
- -

- -

-

Description

- - [Deprecated] The account that this registration belongs to. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Subnet_Registration/{SoftLayer_Network_Subnet_RegistrationID}/getAccount'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Subnet_Registration/getDetailReferences/index.html b/reference/services/SoftLayer_Network_Subnet_Registration/getDetailReferences/index.html deleted file mode 100644 index d6b1c98b944..00000000000 --- a/reference/services/SoftLayer_Network_Subnet_Registration/getDetailReferences/index.html +++ /dev/null @@ -1,332 +0,0 @@ - - - - - - - - - - - - - - - - getDetailReferences - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getDetailReferences

-
-
-
-
-
- Classes - - SoftLayer_Network_Subnet_Registration - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Subnet_Registration::getDetailReferences -

- - -
Deprecated
- -

- -

-

Description

- - [Deprecated] The cross-reference records that tie the SoftLayer_Account_Regional_Registry_Detail objects to the registration object. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Subnet_Registration/{SoftLayer_Network_Subnet_RegistrationID}/getDetailReferences'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Subnet_Registration/getEvents/index.html b/reference/services/SoftLayer_Network_Subnet_Registration/getEvents/index.html deleted file mode 100644 index bd2a422617d..00000000000 --- a/reference/services/SoftLayer_Network_Subnet_Registration/getEvents/index.html +++ /dev/null @@ -1,332 +0,0 @@ - - - - - - - - - - - - - - - - getEvents - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getEvents

-
-
-
-
-
- Classes - - SoftLayer_Network_Subnet_Registration - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Subnet_Registration::getEvents -

- - -
Deprecated
- -

- -

-

Description

- - [Deprecated] The related registration events. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Subnet_Registration/{SoftLayer_Network_Subnet_RegistrationID}/getEvents'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Subnet_Registration/getNetworkDetail/index.html b/reference/services/SoftLayer_Network_Subnet_Registration/getNetworkDetail/index.html deleted file mode 100644 index 79a733a6d67..00000000000 --- a/reference/services/SoftLayer_Network_Subnet_Registration/getNetworkDetail/index.html +++ /dev/null @@ -1,328 +0,0 @@ - - - - - - - - - - - - - - - - getNetworkDetail - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getNetworkDetail

-
-
-
-
-
- Classes - - SoftLayer_Network_Subnet_Registration - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Subnet_Registration::getNetworkDetail -

- - -
Deprecated
- -

- -

-

Description

- - [Deprecated] The “network” detail object. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Subnet_Registration/{SoftLayer_Network_Subnet_RegistrationID}/getNetworkDetail'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Subnet_Registration/getObject/index.html b/reference/services/SoftLayer_Network_Subnet_Registration/getObject/index.html deleted file mode 100644 index c096a1ab7dd..00000000000 --- a/reference/services/SoftLayer_Network_Subnet_Registration/getObject/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getObject

-
-
-
-
-
- Classes - - SoftLayer_Network_Subnet_Registration - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Subnet_Registration::getObject -

- - -

- Retrieve a SoftLayer_Network_Subnet_Registration record. -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Subnet_Registration/{SoftLayer_Network_Subnet_RegistrationID}/getObject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Subnet_Registration/getPersonDetail/index.html b/reference/services/SoftLayer_Network_Subnet_Registration/getPersonDetail/index.html deleted file mode 100644 index 3fa91a5447f..00000000000 --- a/reference/services/SoftLayer_Network_Subnet_Registration/getPersonDetail/index.html +++ /dev/null @@ -1,328 +0,0 @@ - - - - - - - - - - - - - - - - getPersonDetail - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getPersonDetail

-
-
-
-
-
- Classes - - SoftLayer_Network_Subnet_Registration - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Subnet_Registration::getPersonDetail -

- - -
Deprecated
- -

- -

-

Description

- - [Deprecated] The “person” detail object. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Subnet_Registration/{SoftLayer_Network_Subnet_RegistrationID}/getPersonDetail'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Subnet_Registration/getRegionalInternetRegistry/index.html b/reference/services/SoftLayer_Network_Subnet_Registration/getRegionalInternetRegistry/index.html deleted file mode 100644 index 6baf8aefed7..00000000000 --- a/reference/services/SoftLayer_Network_Subnet_Registration/getRegionalInternetRegistry/index.html +++ /dev/null @@ -1,328 +0,0 @@ - - - - - - - - - - - - - - - - getRegionalInternetRegistry - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getRegionalInternetRegistry

-
-
-
-
-
- Classes - - SoftLayer_Network_Subnet_Registration - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Subnet_Registration::getRegionalInternetRegistry -

- - -
Deprecated
- -

- -

-

Description

- - [Deprecated] The related Regional Internet Registry. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Subnet_Registration/{SoftLayer_Network_Subnet_RegistrationID}/getRegionalInternetRegistry'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Subnet_Registration/getRegionalInternetRegistryHandle/index.html b/reference/services/SoftLayer_Network_Subnet_Registration/getRegionalInternetRegistryHandle/index.html deleted file mode 100644 index b0340d943d0..00000000000 --- a/reference/services/SoftLayer_Network_Subnet_Registration/getRegionalInternetRegistryHandle/index.html +++ /dev/null @@ -1,328 +0,0 @@ - - - - - - - - - - - - - - - - getRegionalInternetRegistryHandle - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getRegionalInternetRegistryHandle

-
-
-
-
-
- Classes - - SoftLayer_Network_Subnet_Registration - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Subnet_Registration::getRegionalInternetRegistryHandle -

- - -
Deprecated
- -

- -

-

Description

- - [Deprecated] The RIR handle that this registration object belongs to. This field may not be populated until the registration is complete. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Subnet_Registration/{SoftLayer_Network_Subnet_RegistrationID}/getRegionalInternetRegistryHandle'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Subnet_Registration/getStatus/index.html b/reference/services/SoftLayer_Network_Subnet_Registration/getStatus/index.html deleted file mode 100644 index cb79338dc6e..00000000000 --- a/reference/services/SoftLayer_Network_Subnet_Registration/getStatus/index.html +++ /dev/null @@ -1,328 +0,0 @@ - - - - - - - - - - - - - - - - getStatus - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getStatus

-
-
-
-
-
- Classes - - SoftLayer_Network_Subnet_Registration - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Subnet_Registration::getStatus -

- - -
Deprecated
- -

- -

-

Description

- - [Deprecated] The status of this registration. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Subnet_Registration/{SoftLayer_Network_Subnet_RegistrationID}/getStatus'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Subnet_Registration/getSubnet/index.html b/reference/services/SoftLayer_Network_Subnet_Registration/getSubnet/index.html deleted file mode 100644 index 981ef4c2375..00000000000 --- a/reference/services/SoftLayer_Network_Subnet_Registration/getSubnet/index.html +++ /dev/null @@ -1,328 +0,0 @@ - - - - - - - - - - - - - - - - getSubnet - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getSubnet

-
-
-
-
-
- Classes - - SoftLayer_Network_Subnet_Registration - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Subnet_Registration::getSubnet -

- - -
Deprecated
- -

- -

-

Description

- - [Deprecated] The subnet that this registration pertains to. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Subnet_Registration/{SoftLayer_Network_Subnet_RegistrationID}/getSubnet'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Subnet_Registration/index.html b/reference/services/SoftLayer_Network_Subnet_Registration/index.html deleted file mode 100644 index fa97e2a2910..00000000000 --- a/reference/services/SoftLayer_Network_Subnet_Registration/index.html +++ /dev/null @@ -1,460 +0,0 @@ - - - - - - - - - - - - - SoftLayer_Network_Subnet_Registration - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_Subnet_Registration

-
-
-
-
-
- Classes - - SoftLayer_Network_Subnet_Registration - -
- Tags - - service - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Network_Subnet_Registration

- - -
- -
- - -

Description

- -
Deprecated
- -

The subnet registration service has been deprecated.

-

Subnet registration objects are used to request and track registration of the subnet with the appropriate Regional Internet Registry (RIR). Registration for public subnets can be requested any time after assignment of the subnet.

-

Subnet Registration objects can be updated any time after they are created. This will result in the information being submitted to the RIR and the records on their end being refreshed.

- - -
-

Methods

-
-
-
- -
-
-
-
- - - - - - - -
-

clearRegistration

- -

[Deprecated] Clear an existing registration

- -
- - - - - -
-

createObject

- -

[Deprecated] Create a new subnet registration

- -
- - - - - -
-

createObjects

- -

[Deprecated] Create registrations for multiple subnets

- -
- - - - - -
-

editObject

- -

[Deprecated] Edit an existing registration object

- -
- - - - - -
-

editRegistrationAttachedDetails

- -

[Deprecated] Modify the link between a SoftLayer_Network_Subnet_Registration object and two SoftLayer_Account_Regional_Registry_Detail objects simultaneously.

- -
- - - - - -
-

getAccount

- -

[Deprecated] The account that this registration belongs to.

- -
- - - - - -
-

getDetailReferences

- -

[Deprecated] The cross-reference records that tie the SoftLayer_Account_Regional_Registry_Detail objects to the registration object.

- -
- - - - - -
-

getEvents

- -

[Deprecated] The related registration events.

- -
- - - - - -
-

getNetworkDetail

- -

[Deprecated] The “network” detail object.

- -
- - - -
-

getObject

- -

Retrieve a SoftLayer_Network_Subnet_Registration record.

- -
- - - - - -
-

getPersonDetail

- -

[Deprecated] The “person” detail object.

- -
- - - - - -
-

getRegionalInternetRegistry

- -

[Deprecated] The related Regional Internet Registry.

- -
- - - - - -
-

getRegionalInternetRegistryHandle

- -

[Deprecated] The RIR handle that this registration object belongs to. This field may not be populated until the registration is complete.

- -
- - - - - -
-

getStatus

- -

[Deprecated] The status of this registration.

- -
- - - - - -
-

getSubnet

- -

[Deprecated] The subnet that this registration pertains to.

- -
- - -
-
- -
- -
-
- - - -
- - - - - - - diff --git a/reference/services/SoftLayer_Network_Subnet_Registration_Details/createObject/index.html b/reference/services/SoftLayer_Network_Subnet_Registration_Details/createObject/index.html deleted file mode 100644 index 55aed272a63..00000000000 --- a/reference/services/SoftLayer_Network_Subnet_Registration_Details/createObject/index.html +++ /dev/null @@ -1,349 +0,0 @@ - - - - - - - - - - - - - - - - createObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

createObject

-
-
-
-
-
- Classes - - SoftLayer_Network_Subnet_Registration_Details - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Subnet_Registration_Details::createObject -

- - -
Deprecated
- -

- [Deprecated] Create a new association between a SoftLayer_Network_Subnet_Registration object and a SoftLayer_Account_Regional_Registry_Detail object. -

-

Description

- -

The subnet registration details service has been deprecated.

- This method will create a new SoftLayer_Network_Subnet_Registration_Details object. -

Input - SoftLayer_Network_Subnet_Registration_Details

- - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
templateObjectSoftLayer_Network_Subnet_Registration_DetailsThe SoftLayer_Network_Subnet_Registration_Details object that you wish to create.
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [SoftLayer_Network_Subnet_Registration_Details]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Subnet_Registration_Details/createObject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Subnet_Registration_Details/deleteObject/index.html b/reference/services/SoftLayer_Network_Subnet_Registration_Details/deleteObject/index.html deleted file mode 100644 index ed08100fa41..00000000000 --- a/reference/services/SoftLayer_Network_Subnet_Registration_Details/deleteObject/index.html +++ /dev/null @@ -1,328 +0,0 @@ - - - - - - - - - - - - - - - - deleteObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

deleteObject

-
-
-
-
-
- Classes - - SoftLayer_Network_Subnet_Registration_Details - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Subnet_Registration_Details::deleteObject -

- - -
Deprecated
- -

- [Deprecated] Remove an existing association between a SoftLayer_Network_Subnet_Registration object and a SoftLayer_Account_Regional_Registry_Detail object. -

-

Description

- -

The subnet registration details service has been deprecated.

-

This method will delete an existing SoftLayer_Account_Regional_Registry_Detail object.

- - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - boolean - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Subnet_Registration_Details/{SoftLayer_Network_Subnet_Registration_DetailsID}/deleteObject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Subnet_Registration_Details/getDetail/index.html b/reference/services/SoftLayer_Network_Subnet_Registration_Details/getDetail/index.html deleted file mode 100644 index 1658b91c232..00000000000 --- a/reference/services/SoftLayer_Network_Subnet_Registration_Details/getDetail/index.html +++ /dev/null @@ -1,328 +0,0 @@ - - - - - - - - - - - - - - - - getDetail - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getDetail

-
-
-
-
-
- Classes - - SoftLayer_Network_Subnet_Registration_Details - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Subnet_Registration_Details::getDetail -

- - -
Deprecated
- -

- -

-

Description

- - [Deprecated] The related SoftLayer_Account_Regional_Registry_Detail. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Subnet_Registration_Details/{SoftLayer_Network_Subnet_Registration_DetailsID}/getDetail'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Subnet_Registration_Details/getObject/index.html b/reference/services/SoftLayer_Network_Subnet_Registration_Details/getObject/index.html deleted file mode 100644 index ad822c4701f..00000000000 --- a/reference/services/SoftLayer_Network_Subnet_Registration_Details/getObject/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getObject

-
-
-
-
-
- Classes - - SoftLayer_Network_Subnet_Registration_Details - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Subnet_Registration_Details::getObject -

- - -

- Retrieve a SoftLayer_Network_Subnet_Registration_Details record. -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Subnet_Registration_Details/{SoftLayer_Network_Subnet_Registration_DetailsID}/getObject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Subnet_Registration_Details/getRegistration/index.html b/reference/services/SoftLayer_Network_Subnet_Registration_Details/getRegistration/index.html deleted file mode 100644 index 4a33b657eed..00000000000 --- a/reference/services/SoftLayer_Network_Subnet_Registration_Details/getRegistration/index.html +++ /dev/null @@ -1,328 +0,0 @@ - - - - - - - - - - - - - - - - getRegistration - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getRegistration

-
-
-
-
-
- Classes - - SoftLayer_Network_Subnet_Registration_Details - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Subnet_Registration_Details::getRegistration -

- - -
Deprecated
- -

- -

-

Description

- - [Deprecated] The related SoftLayer_Network_Subnet_Registration. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Subnet_Registration_Details/{SoftLayer_Network_Subnet_Registration_DetailsID}/getRegistration'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Subnet_Registration_Details/index.html b/reference/services/SoftLayer_Network_Subnet_Registration_Details/index.html deleted file mode 100644 index 5082922b980..00000000000 --- a/reference/services/SoftLayer_Network_Subnet_Registration_Details/index.html +++ /dev/null @@ -1,347 +0,0 @@ - - - - - - - - - - - - - SoftLayer_Network_Subnet_Registration_Details - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_Subnet_Registration_Details

-
-
-
-
-
- Classes - - SoftLayer_Network_Subnet_Registration_Details - -
- Tags - - service - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Network_Subnet_Registration_Details

- - -
- -
- - -

Description

- -
Deprecated
- - - -
-

Methods

-
-
-
- -
-
-
-
- - - - - - - -
-

createObject

- -

[Deprecated] Create a new association between a SoftLayer_Network_Subnet_Registration object and a SoftLayer_Account_Regional_Registry_Detail object.

- -
- - - - - -
-

deleteObject

- -

[Deprecated] Remove an existing association between a SoftLayer_Network_Subnet_Registration object and a SoftLayer_Account_Regional_Registry_Detail object.

- -
- - - - - -
-

getDetail

- -

[Deprecated] The related SoftLayer_Account_Regional_Registry_Detail.

- -
- - - -
-

getObject

- -

Retrieve a SoftLayer_Network_Subnet_Registration_Details record.

- -
- - - - - -
-

getRegistration

- -

[Deprecated] The related SoftLayer_Network_Subnet_Registration.

- -
- - -
-
- -
- -
-
- - - -
- - - - - - - diff --git a/reference/services/SoftLayer_Network_Subnet_Registration_Status/getAllObjects/index.html b/reference/services/SoftLayer_Network_Subnet_Registration_Status/getAllObjects/index.html deleted file mode 100644 index 05684d5f1ff..00000000000 --- a/reference/services/SoftLayer_Network_Subnet_Registration_Status/getAllObjects/index.html +++ /dev/null @@ -1,330 +0,0 @@ - - - - - - - - - - - - - - - - getAllObjects - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getAllObjects

-
-
-
-
-
- Classes - - SoftLayer_Network_Subnet_Registration_Status - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Subnet_Registration_Status::getAllObjects -

- - -
Deprecated
- -

- -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Subnet_Registration_Status/getAllObjects'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Subnet_Registration_Status/getObject/index.html b/reference/services/SoftLayer_Network_Subnet_Registration_Status/getObject/index.html deleted file mode 100644 index 29e57c03aa4..00000000000 --- a/reference/services/SoftLayer_Network_Subnet_Registration_Status/getObject/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getObject

-
-
-
-
-
- Classes - - SoftLayer_Network_Subnet_Registration_Status - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Subnet_Registration_Status::getObject -

- - -

- Retrieve a SoftLayer_Network_Subnet_Registration_Status record. -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Subnet_Registration_Status/{SoftLayer_Network_Subnet_Registration_StatusID}/getObject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Subnet_Registration_Status/index.html b/reference/services/SoftLayer_Network_Subnet_Registration_Status/index.html deleted file mode 100644 index dd893c62ee3..00000000000 --- a/reference/services/SoftLayer_Network_Subnet_Registration_Status/index.html +++ /dev/null @@ -1,314 +0,0 @@ - - - - - - - - - - - - - SoftLayer_Network_Subnet_Registration_Status - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_Subnet_Registration_Status

-
-
-
-
-
- Classes - - SoftLayer_Network_Subnet_Registration_Status - -
- Tags - - service - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Network_Subnet_Registration_Status

- - -
- -
- - -

Description

- -
Deprecated
- - - -
-

Methods

-
-
-
- -
-
-
-
- - - - - - - -
-

getAllObjects

- -

- -
- - - -
-

getObject

- -

Retrieve a SoftLayer_Network_Subnet_Registration_Status record.

- -
- - -
-
- -
- -
-
- - - -
- - - - - - - diff --git a/reference/services/SoftLayer_Network_Subnet_Rwhois_Data/editObject/index.html b/reference/services/SoftLayer_Network_Subnet_Rwhois_Data/editObject/index.html deleted file mode 100644 index fb7a8aae822..00000000000 --- a/reference/services/SoftLayer_Network_Subnet_Rwhois_Data/editObject/index.html +++ /dev/null @@ -1,358 +0,0 @@ - - - - - - - - - - - - - - - - editObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

editObject

-
-
-
-
-
- Classes - - SoftLayer_Network_Subnet_Rwhois_Data - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Subnet_Rwhois_Data::editObject -

- - -
Deprecated
- -

-

Edit the RWHOIS record by passing in a modified version of the record object. All fields are editable. The fields are as follows:

-
    -
  • companyName
  • -
  • firstName
  • -
  • lastName
  • -
  • city
  • -
  • country
  • -
  • postalCode
  • -
  • abuseEmail
  • -
  • address1
  • -
-

-

Description

- - Edit the RWHOIS record by passing in a modified version of the record object. All fields are editable. - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
templateObjectSoftLayer_Network_Subnet_Rwhois_DataA skeleton SoftLayer_Network_Subnet_Rwhois_Data object with only the properties defined that you wish to change. Unchanged properties are left alone.
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - boolean - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [SoftLayer_Network_Subnet_Rwhois_Data]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Subnet_Rwhois_Data/{SoftLayer_Network_Subnet_Rwhois_DataID}/editObject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Subnet_Rwhois_Data/getAccount/index.html b/reference/services/SoftLayer_Network_Subnet_Rwhois_Data/getAccount/index.html deleted file mode 100644 index 490738dc7bd..00000000000 --- a/reference/services/SoftLayer_Network_Subnet_Rwhois_Data/getAccount/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getAccount - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getAccount

-
-
-
-
-
- Classes - - SoftLayer_Network_Subnet_Rwhois_Data - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Subnet_Rwhois_Data::getAccount -

- - -

- -

-

Description

- - The SoftLayer customer account associated with this reverse WHOIS data. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Subnet_Rwhois_Data/{SoftLayer_Network_Subnet_Rwhois_DataID}/getAccount'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Subnet_Rwhois_Data/getObject/index.html b/reference/services/SoftLayer_Network_Subnet_Rwhois_Data/getObject/index.html deleted file mode 100644 index 4d6b68720b4..00000000000 --- a/reference/services/SoftLayer_Network_Subnet_Rwhois_Data/getObject/index.html +++ /dev/null @@ -1,328 +0,0 @@ - - - - - - - - - - - - - - - - getObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getObject

-
-
-
-
-
- Classes - - SoftLayer_Network_Subnet_Rwhois_Data - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Subnet_Rwhois_Data::getObject -

- - -

- Retrieve a SoftLayer_Network_Subnet_Rwhois_Data record. -

-

Description

- -

getObject retrieves the SoftLayer_Network_Subnet_Rwhois_Data object whose ID corresponds to the ID number of the init parameter passed to the SoftLayer_Network_Subnet_Rwhois_Data service.

-

The best way to get Rwhois Data for an account is through getRhwoisData on the Account service.

- - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Subnet_Rwhois_Data/{SoftLayer_Network_Subnet_Rwhois_DataID}/getObject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Subnet_Rwhois_Data/index.html b/reference/services/SoftLayer_Network_Subnet_Rwhois_Data/index.html deleted file mode 100644 index cff7db4b8b6..00000000000 --- a/reference/services/SoftLayer_Network_Subnet_Rwhois_Data/index.html +++ /dev/null @@ -1,337 +0,0 @@ - - - - - - - - - - - - - SoftLayer_Network_Subnet_Rwhois_Data - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_Subnet_Rwhois_Data

-
-
-
-
-
- Classes - - SoftLayer_Network_Subnet_Rwhois_Data - -
- Tags - - service - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Network_Subnet_Rwhois_Data

- - -
- -
- - -

Description

- -
Deprecated
- -

DEPRECATED -Use SoftLayer_Account_Regional_Registry_Detail and SoftLayer_Network_Subnet_Registration instead.

-

Every SoftLayer customer account has a RWHOIS record tied to it. This RWHOIS record is used by SoftLayer’s Reverse Whois system as well as SoftLayer’s Automated SWIP system.

-

This service allows you to update your stored RWHOIS record. Changing this record automatically updates the RWHOIS record in 24 hours, but does NOT update SWIP data. You will need to use the SWIP service to do that.

- - -
-

Methods

-
-
-
- -
-
-
-
- - - - - - - -
-

editObject

- -

Edit the RWHOIS record by passing in a modified version of the record object. All fields are editable. The fields are as follows:

-
    -
  • companyName
  • -
  • firstName
  • -
  • lastName
  • -
  • city
  • -
  • country
  • -
  • postalCode
  • -
  • abuseEmail
  • -
  • address1
  • -

- -
- - - -
-

getAccount

- -

The SoftLayer customer account associated with this reverse WHOIS data.

- -
- - - -
-

getObject

- -

Retrieve a SoftLayer_Network_Subnet_Rwhois_Data record.

- -
- - -
-
- -
- -
-
- - - -
- - - - - - - diff --git a/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/findMyTransactions/index.html b/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/findMyTransactions/index.html deleted file mode 100644 index 0c9581d318b..00000000000 --- a/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/findMyTransactions/index.html +++ /dev/null @@ -1,338 +0,0 @@ - - - - - - - - - - - - - - - - findMyTransactions - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

findMyTransactions

-
-
-
-
-
- Classes - - SoftLayer_Network_Subnet_Swip_Transaction - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Subnet_Swip_Transaction::findMyTransactions -

- - -
Deprecated
- -

- returns SWIP transaction objects that are currently in transaction with ARIN. -

-

Description

- - DEPRECATED -This function will return an array of SoftLayer_Network_Subnet_Swip_Transaction objects, one for each SWIP that is currently in transaction with ARIN. This includes all swip registrations, swip removal requests, and SWIP objects that are currently OK. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - -

Error Handling

-
    - - -
  • Exception thrown if this method is attempted on a subnet not owned by the user.
  • - - - - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Subnet_Swip_Transaction/findMyTransactions'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/getAccount/index.html b/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/getAccount/index.html deleted file mode 100644 index 23074f4c124..00000000000 --- a/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/getAccount/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getAccount - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getAccount

-
-
-
-
-
- Classes - - SoftLayer_Network_Subnet_Swip_Transaction - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Subnet_Swip_Transaction::getAccount -

- - -

- -

-

Description

- - The Account whose RWHOIS data was used to SWIP this subnet - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Subnet_Swip_Transaction/{SoftLayer_Network_Subnet_Swip_TransactionID}/getAccount'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/getObject/index.html b/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/getObject/index.html deleted file mode 100644 index 7c30f82dae1..00000000000 --- a/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/getObject/index.html +++ /dev/null @@ -1,327 +0,0 @@ - - - - - - - - - - - - - - - - getObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getObject

-
-
-
-
-
- Classes - - SoftLayer_Network_Subnet_Swip_Transaction - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Subnet_Swip_Transaction::getObject -

- - -

- Retrieve a SoftLayer_Network_Subnet_Swip_Transaction record. -

-

Description

- - DEPRECATED -getObject retrieves the SoftLayer_Network_Subnet_Swip_Transaction object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Network_Subnet_Swip_transaction service. You can only retrieve Swip transactions tied to the account. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Subnet_Swip_Transaction/{SoftLayer_Network_Subnet_Swip_TransactionID}/getObject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/getSubnet/index.html b/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/getSubnet/index.html deleted file mode 100644 index 6013a660e0f..00000000000 --- a/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/getSubnet/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getSubnet - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getSubnet

-
-
-
-
-
- Classes - - SoftLayer_Network_Subnet_Swip_Transaction - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Subnet_Swip_Transaction::getSubnet -

- - -

- -

-

Description

- - The subnet that this SWIP transaction was created for. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Subnet_Swip_Transaction/{SoftLayer_Network_Subnet_Swip_TransactionID}/getSubnet'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/index.html b/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/index.html deleted file mode 100644 index 6400fc4f248..00000000000 --- a/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/index.html +++ /dev/null @@ -1,390 +0,0 @@ - - - - - - - - - - - - - SoftLayer_Network_Subnet_Swip_Transaction - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Network_Subnet_Swip_Transaction

-
-
-
-
-
- Classes - - SoftLayer_Network_Subnet_Swip_Transaction - -
- Tags - - service - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Network_Subnet_Swip_Transaction

- - -
- -
- - -

Description

- -
Deprecated
- -

DEPRECATED -SoftLayer’s Automated Swip System is a finite state machine; it works by locally tracking a transaction between SoftLayer and the relevant Regional Internet Registry (RIR), assigning responsibility of a subnet to a customer. Transactions are dictated by the RIR’s processing system, and the nature of the communication medium with each RIR, namely their REST API.

-

Using this API, SoftLayer Customers are able to initiate, monitor, update, and remove Swip system transactions with ARIN and RIPE.

- - -
-

Methods

-
-
-
- -
-
-
-
- - - - - - - -
-

findMyTransactions

- -

returns SWIP transaction objects that are currently in transaction with ARIN.

- -
- - - -
-

getAccount

- -

The Account whose RWHOIS data was used to SWIP this subnet

- -
- - - -
-

getObject

- -

Retrieve a SoftLayer_Network_Subnet_Swip_Transaction record.

- -
- - - -
-

getSubnet

- -

The subnet that this SWIP transaction was created for.

- -
- - - - - -
-

removeAllSubnetSwips

- -

Removes registration information from ARIN for all your subnets

- -
- - - - - -
-

removeSwipData

- -

Deletes registration information from ARIN for a single subnet

- -
- - - - - -
-

resendSwipData

- -

Sends updated RWHOIS information to ARIN for a single subnet.

- -
- - - - - -
-

swipAllSubnets

- -

create SWIP transactions for all subnets that do not already have a SWIP transaction in progress.

- -
- - - - - -
-

updateAllSubnetSwips

- -

Update all subnets on the account with an “OK” status.

- -
- - -
-
- -
- -
-
- - - -
- - - - - - - diff --git a/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/removeAllSubnetSwips/index.html b/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/removeAllSubnetSwips/index.html deleted file mode 100644 index 0d1bad0bb3a..00000000000 --- a/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/removeAllSubnetSwips/index.html +++ /dev/null @@ -1,325 +0,0 @@ - - - - - - - - - - - - - - - - removeAllSubnetSwips - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

removeAllSubnetSwips

-
-
-
-
-
- Classes - - SoftLayer_Network_Subnet_Swip_Transaction - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Subnet_Swip_Transaction::removeAllSubnetSwips -

- - -
Deprecated
- -

- Removes registration information from ARIN for all your subnets -

-

Description

- - DEPRECATED -This method finds all subnets attached to your account that are in OK status and starts “DELETE” transactions with ARIN, allowing you to remove your SWIP registration information. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - int - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Subnet_Swip_Transaction/removeAllSubnetSwips'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/removeSwipData/index.html b/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/removeSwipData/index.html deleted file mode 100644 index 5c507cf937b..00000000000 --- a/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/removeSwipData/index.html +++ /dev/null @@ -1,344 +0,0 @@ - - - - - - - - - - - - - - - - removeSwipData - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

removeSwipData

-
-
-
-
-
- Classes - - SoftLayer_Network_Subnet_Swip_Transaction - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Subnet_Swip_Transaction::removeSwipData -

- - -
Deprecated
- -

- Deletes registration information from ARIN for a single subnet -

-

Description

- - DEPRECATED -This function, when called on an instantiated SWIP transaction, will allow you to start a “DELETE” transaction with ARIN, allowing you to remove your SWIP registration information. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - boolean - -
- -

Error Handling

-
    - - -
  • Exception thrown if this method is attempted on a subnet not owned by the user.
  • - - - - - -
  • Exception thrown if this SWIP is not in OK status. You cannot update a SWIP unless it is in OK status.
  • - - - - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Subnet_Swip_Transaction/{SoftLayer_Network_Subnet_Swip_TransactionID}/removeSwipData'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/resendSwipData/index.html b/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/resendSwipData/index.html deleted file mode 100644 index e658583e49b..00000000000 --- a/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/resendSwipData/index.html +++ /dev/null @@ -1,344 +0,0 @@ - - - - - - - - - - - - - - - - resendSwipData - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

resendSwipData

-
-
-
-
-
- Classes - - SoftLayer_Network_Subnet_Swip_Transaction - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Subnet_Swip_Transaction::resendSwipData -

- - -
Deprecated
- -

- Sends updated RWHOIS information to ARIN for a single subnet. -

-

Description

- - DEPRECATED -This function will allow you to update ARIN’s registration data for a subnet to your current RWHOIS data. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - boolean - -
- -

Error Handling

-
    - - -
  • Exception thrown if this method is attempted on a subnet not owned by the user.
  • - - - - - -
  • Exception thrown if this SWIP is not in OK status. You cannot update a SWIP unless it is in OK status.
  • - - - - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Subnet_Swip_Transaction/{SoftLayer_Network_Subnet_Swip_TransactionID}/resendSwipData'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/swipAllSubnets/index.html b/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/swipAllSubnets/index.html deleted file mode 100644 index 4c818d8c228..00000000000 --- a/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/swipAllSubnets/index.html +++ /dev/null @@ -1,325 +0,0 @@ - - - - - - - - - - - - - - - - swipAllSubnets - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

swipAllSubnets

-
-
-
-
-
- Classes - - SoftLayer_Network_Subnet_Swip_Transaction - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Subnet_Swip_Transaction::swipAllSubnets -

- - -
Deprecated
- -

- create SWIP transactions for all subnets that do not already have a SWIP transaction in progress. -

-

Description

- - DEPRECATED -swipAllSubnets finds all subnets attached to your account and attempts to create a SWIP transaction for all subnets that do not already have a SWIP transaction in progress. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - int - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Subnet_Swip_Transaction/swipAllSubnets'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/updateAllSubnetSwips/index.html b/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/updateAllSubnetSwips/index.html deleted file mode 100644 index dfeca6aea9e..00000000000 --- a/reference/services/SoftLayer_Network_Subnet_Swip_Transaction/updateAllSubnetSwips/index.html +++ /dev/null @@ -1,325 +0,0 @@ - - - - - - - - - - - - - - - - updateAllSubnetSwips - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

updateAllSubnetSwips

-
-
-
-
-
- Classes - - SoftLayer_Network_Subnet_Swip_Transaction - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Subnet_Swip_Transaction::updateAllSubnetSwips -

- - -
Deprecated
- -

- Update all subnets on the account with an “OK” status. -

-

Description

- - DEPRECATED -This method finds all subnets attached to your account that are in “OK” status and updates their data with ARIN. Use this function after you have updated your RWHOIS data if you want to keep SWIP up to date. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - int - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Subnet_Swip_Transaction/updateAllSubnetSwips'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Vlan/getExtensionRouter/index.html b/reference/services/SoftLayer_Network_Vlan/getExtensionRouter/index.html deleted file mode 100644 index 717ee0e694c..00000000000 --- a/reference/services/SoftLayer_Network_Vlan/getExtensionRouter/index.html +++ /dev/null @@ -1,328 +0,0 @@ - - - - - - - - - - - - - - - - getExtensionRouter - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getExtensionRouter

-
-
-
-
-
- Classes - - SoftLayer_Network_Vlan - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Vlan::getExtensionRouter -

- - -
Deprecated
- -

- -

-

Description

- - [DEPRECATED] The extension router that this VLAN is associated with. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/getExtensionRouter'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Vlan/getFirewallProtectableIpAddresses/index.html b/reference/services/SoftLayer_Network_Vlan/getFirewallProtectableIpAddresses/index.html deleted file mode 100644 index 5465f215e06..00000000000 --- a/reference/services/SoftLayer_Network_Vlan/getFirewallProtectableIpAddresses/index.html +++ /dev/null @@ -1,340 +0,0 @@ - - - - - - - - - - - - - - - - getFirewallProtectableIpAddresses - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getFirewallProtectableIpAddresses

-
-
-
-
-
- Classes - - SoftLayer_Network_Vlan - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Vlan::getFirewallProtectableIpAddresses -

- - -
Deprecated
- -

- [DEPRECATED] Retrieve the IP addresses routed on this VLAN that are protectable by a Hardware Firewall. -

-

Description

- - *** DEPRECATED *** -Retrieves the IP addresses routed on this VLAN that are protectable by a Hardware Firewall. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - -

Error Handling

-
    - - -
  • Throw the exception “Operation SoftLayer_Network_Vlan::getFirewallProtectableIpAddresses has been deprecated and will be removed in API version 3.2.”
  • - - - - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/getFirewallProtectableIpAddresses'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Vlan/getFirewallProtectableSubnets/index.html b/reference/services/SoftLayer_Network_Vlan/getFirewallProtectableSubnets/index.html deleted file mode 100644 index 445ebb4371f..00000000000 --- a/reference/services/SoftLayer_Network_Vlan/getFirewallProtectableSubnets/index.html +++ /dev/null @@ -1,340 +0,0 @@ - - - - - - - - - - - - - - - - getFirewallProtectableSubnets - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getFirewallProtectableSubnets

-
-
-
-
-
- Classes - - SoftLayer_Network_Vlan - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Vlan::getFirewallProtectableSubnets -

- - -
Deprecated
- -

- [DEPRECATED] Retrieve the subnets routed on this VLAN that are protectable by a Hardware Firewall. -

-

Description

- - *** DEPRECATED *** -Retrieves the subnets routed on this VLAN that are protectable by a Hardware Firewall. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - -

Error Handling

-
    - - -
  • Throw the exception “Operation SoftLayer_Network_Vlan::getFirewallProtectableSubnets has been deprecated and will be removed in API version 3.2.”
  • - - - - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/getFirewallProtectableSubnets'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Vlan/getNetwork/index.html b/reference/services/SoftLayer_Network_Vlan/getNetwork/index.html deleted file mode 100644 index ab66c9b4bb4..00000000000 --- a/reference/services/SoftLayer_Network_Vlan/getNetwork/index.html +++ /dev/null @@ -1,277 +0,0 @@ - - - - - - - - - - - - - - - - getNetwork - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getNetwork

-
-
-
-
-
- Classes - - SoftLayer_Network_Vlan - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Vlan::getNetwork -

- - -
Deprecated
- -

- -

-

Description

- - [DEPRECATED] The network in which this VLAN resides. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/getNetwork'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Vlan/getNetworkSpace/index.html b/reference/services/SoftLayer_Network_Vlan/getNetworkSpace/index.html deleted file mode 100644 index 5bb39754309..00000000000 --- a/reference/services/SoftLayer_Network_Vlan/getNetworkSpace/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getNetworkSpace - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getNetworkSpace

-
-
-
-
-
- Classes - - SoftLayer_Network_Vlan - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Vlan::getNetworkSpace -

- - -

- -

-

Description

- - The network that this VLAN is on, either PUBLIC or PRIVATE, if applicable. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

-
  • - - - - string - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/getNetworkSpace'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Vlan/getPrivateVlanByIpAddress/index.html b/reference/services/SoftLayer_Network_Vlan/getPrivateVlanByIpAddress/index.html deleted file mode 100644 index aa1d55b128f..00000000000 --- a/reference/services/SoftLayer_Network_Vlan/getPrivateVlanByIpAddress/index.html +++ /dev/null @@ -1,365 +0,0 @@ - - - - - - - - - - - - - - - - getPrivateVlanByIpAddress - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getPrivateVlanByIpAddress

-
-
-
-
-
- Classes - - SoftLayer_Network_Vlan - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Vlan::getPrivateVlanByIpAddress -

- - -
Deprecated
- -

- [DEPRECATED] Retrieve the private network VLAN associated with an IP address. -

-

Description

- - *** DEPRECATED *** -Retrieve the private network VLAN associated with an IP address. - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
ipAddressstringThe IPv4 address to search for
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - -

Error Handling

-
    - - -
  • Throw the exception “Operation SoftLayer_Network_Vlan::getPrivateVlanByIpAddress has been deprecated and will be removed in API version 3.2.”
  • - - - - -
- - - -

Associated Methods

- - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Vlan/getPrivateVlanByIpAddress'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Vlan/getPublicVlanByFqdn/index.html b/reference/services/SoftLayer_Network_Vlan/getPublicVlanByFqdn/index.html deleted file mode 100644 index 3bee240a4c0..00000000000 --- a/reference/services/SoftLayer_Network_Vlan/getPublicVlanByFqdn/index.html +++ /dev/null @@ -1,357 +0,0 @@ - - - - - - - - - - - - - - - - getPublicVlanByFqdn - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getPublicVlanByFqdn

-
-
-
-
-
- Classes - - SoftLayer_Network_Vlan - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Vlan::getPublicVlanByFqdn -

- - -
Deprecated
- -

- [DEPRECATED] Retrieve a public VLAN by an associated host’s fully-qualified domain name -

-

Description

- - *** DEPRECATED *** -Retrieves a public VLAN associated to the host matched by the given fully-qualified domain name. - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
fqdnstringThe fully-qualified domain name of the server you wish to search for. This follows the naming convention “{hostname}.{domain}”.
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - -

Error Handling

-
    - - -
  • Throw the exception “Operation SoftLayer_Network_Vlan::getPublicVlanByFqdn has been deprecated and will be removed in API version 3.2.”
  • - - - - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Vlan/getPublicVlanByFqdn'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Vlan/getReverseDomainRecords/index.html b/reference/services/SoftLayer_Network_Vlan/getReverseDomainRecords/index.html deleted file mode 100644 index 6bd24eae032..00000000000 --- a/reference/services/SoftLayer_Network_Vlan/getReverseDomainRecords/index.html +++ /dev/null @@ -1,340 +0,0 @@ - - - - - - - - - - - - - - - - getReverseDomainRecords - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getReverseDomainRecords

-
-
-
-
-
- Classes - - SoftLayer_Network_Vlan - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Vlan::getReverseDomainRecords -

- - -
Deprecated
- -

- [DEPRECATED] DNS PTR records associated with IP addresses routed on this VLAN. -

-

Description

- - *** DEPRECATED *** -Retrieves DNS PTR records associated with IP addresses routed on this VLAN. Results will be grouped by DNS domain with the “resourceRecords” property populated. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - -

Error Handling

-
    - - -
  • Throw the exception “Operation SoftLayer_Network_Vlan::getReverseDomainRecords has been deprecated and will be removed in API version 3.2.”
  • - - - - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/getReverseDomainRecords'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Vlan/getSecondaryRouter/index.html b/reference/services/SoftLayer_Network_Vlan/getSecondaryRouter/index.html deleted file mode 100644 index a1c317fd00f..00000000000 --- a/reference/services/SoftLayer_Network_Vlan/getSecondaryRouter/index.html +++ /dev/null @@ -1,328 +0,0 @@ - - - - - - - - - - - - - - - - getSecondaryRouter - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getSecondaryRouter

-
-
-
-
-
- Classes - - SoftLayer_Network_Vlan - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Vlan::getSecondaryRouter -

- - -
Deprecated
- -

- -

-

Description

- - [DEPRECATED] The secondary router device that this VLAN is associated with. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/getSecondaryRouter'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Network_Vlan/updateFirewallIntraVlanCommunication/index.html b/reference/services/SoftLayer_Network_Vlan/updateFirewallIntraVlanCommunication/index.html deleted file mode 100644 index 51118c3b8a8..00000000000 --- a/reference/services/SoftLayer_Network_Vlan/updateFirewallIntraVlanCommunication/index.html +++ /dev/null @@ -1,359 +0,0 @@ - - - - - - - - - - - - - - - - updateFirewallIntraVlanCommunication - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

updateFirewallIntraVlanCommunication

-
-
-
-
-
- Classes - - SoftLayer_Network_Vlan - -
- Tags - - method - - sldn - - network - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Network_Vlan::updateFirewallIntraVlanCommunication -

- - -
Deprecated
- -

- [DEPRECATED] Update the firewall associated to this VLAN to allow or disallow intra-VLAN communication. -

-

Description

- - *** DEPRECATED *** -Updates the firewall associated to this VLAN to allow or disallow intra-VLAN communication. - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
enabledbooleanWhether or not intra-VLAN communication should be enabled.
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - void - -
- -

Error Handling

-
    - - -
  • Throw the exception “VLAN does not have an associated firewall context.” if this VLAN does not have an associated firewall.
  • - - - - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [boolean]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/updateFirewallIntraVlanCommunication'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Product_Package/getCdnItems/index.html b/reference/services/SoftLayer_Product_Package/getCdnItems/index.html deleted file mode 100644 index 4a095678c01..00000000000 --- a/reference/services/SoftLayer_Product_Package/getCdnItems/index.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - - - - - - - - - - getCdnItems - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getCdnItems

-
-
-
-
-
- Classes - - SoftLayer_Product_Package - -
- Tags - - method - - sldn - - product - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Product_Package::getCdnItems -

- - -

- -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getCdnItems'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Product_Package/getDeploymentPackages/index.html b/reference/services/SoftLayer_Product_Package/getDeploymentPackages/index.html deleted file mode 100644 index ff6836d3cf0..00000000000 --- a/reference/services/SoftLayer_Product_Package/getDeploymentPackages/index.html +++ /dev/null @@ -1,330 +0,0 @@ - - - - - - - - - - - - - - - - getDeploymentPackages - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getDeploymentPackages

-
-
-
-
-
- Classes - - SoftLayer_Product_Package - -
- Tags - - method - - sldn - - product - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Product_Package::getDeploymentPackages -

- - -

- -

-

Description

- - The packages that are allowed in a multi-server solution. (Deprecated) - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getDeploymentPackages'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Product_Package/getDeployments/index.html b/reference/services/SoftLayer_Product_Package/getDeployments/index.html deleted file mode 100644 index 3ac740311ee..00000000000 --- a/reference/services/SoftLayer_Product_Package/getDeployments/index.html +++ /dev/null @@ -1,330 +0,0 @@ - - - - - - - - - - - - - - - - getDeployments - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getDeployments

-
-
-
-
-
- Classes - - SoftLayer_Product_Package - -
- Tags - - method - - sldn - - product - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Product_Package::getDeployments -

- - -

- -

-

Description

- - The package that represents a multi-server solution. (Deprecated) - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getDeployments'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Utility_Network/index.html b/reference/services/SoftLayer_Utility_Network/index.html deleted file mode 100644 index d04526a05b1..00000000000 --- a/reference/services/SoftLayer_Utility_Network/index.html +++ /dev/null @@ -1,310 +0,0 @@ - - - - - - - - - - - - - SoftLayer_Utility_Network - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Utility_Network

-
-
-
-
-
- Classes - - SoftLayer_Utility_Network - -
- Tags - - service - - sldn - - utility - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Utility_Network

- - -
- -
- - -

Description

- - The SoftLayer_Utility_Network service allows users to send network diagnostic requests from SoftLayer’s application servers to a given host on the Internet. - -
-

Methods

-
-
-
- -
-
-
-
- - - - - -
-

nsLookup

- -

Perform a nameserver lookup on given address.

- -
- - - -
-

whois

- -

Perform a WHOIS lookup on a given address.

- -
- - -
-
- -
- -
-
- - - -
- - - - - - - diff --git a/reference/services/SoftLayer_Utility_Network/nsLookup/index.html b/reference/services/SoftLayer_Utility_Network/nsLookup/index.html deleted file mode 100644 index e0d9c0ff711..00000000000 --- a/reference/services/SoftLayer_Utility_Network/nsLookup/index.html +++ /dev/null @@ -1,384 +0,0 @@ - - - - - - - - - - - - - - - - nsLookup - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

nsLookup

-
-
-
-
-
- Classes - - SoftLayer_Utility_Network - -
- Tags - - method - - sldn - - utility - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Utility_Network::nsLookup -

- - -

- Perform a nameserver lookup on given address. -

-

Description

- - A method used to return the nameserver information for a given address - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
addressstringAn IP address or hostname to nslookup.
typestringThe type of record to return A, MX, NS, CNAME, TXT.
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - string - -
- -

Error Handling

-
    - - -
  • Throw the exception “Please provide an address to nslookup.” if the address parameter is empty.
  • - - - - - -
  • Throw the exception “Please provide a valid IP address or hostname.” if the address parameter is not a valid IP address or hostname.
  • - - - - -
- - - -

Associated Methods

- - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string, string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Utility_Network/nsLookup'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Utility_Network/whois/index.html b/reference/services/SoftLayer_Utility_Network/whois/index.html deleted file mode 100644 index a213895e1ec..00000000000 --- a/reference/services/SoftLayer_Utility_Network/whois/index.html +++ /dev/null @@ -1,374 +0,0 @@ - - - - - - - - - - - - - - - - whois - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

whois

-
-
-
-
-
- Classes - - SoftLayer_Utility_Network - -
- Tags - - method - - sldn - - utility - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Utility_Network::whois -

- - -

- Perform a WHOIS lookup on a given address. -

-

Description

- - Perform a WHOIS lookup from SoftLayer’s application servers on the given IP address or hostname and return the raw results of that command. The returned result is similar to the result received from running the command whois from a UNIX command shell. A WHOIS lookup queries a host’s registrar to retrieve domain registrant information including registration date, expiry date, and the administrative, technical, billing, and abuse contacts responsible for a domain. WHOIS lookups are useful for determining a physical contact responsible for a particular domain. WHOIS lookups are also useful for determining domain availability. Running a WHOIS lookup on an IP address queries ARIN for that IP block’s ownership, and is helpful for determining a physical entity responsible for a certain IP address. - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
addressstringAn IP address or hostname to whois.
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - string - -
- -

Error Handling

-
    - - -
  • Throw the exception “Please provide an address to whois.” if the address parameter is empty.
  • - - - - - -
  • Throw the exception “Please provide a valid IP address or hostname.” if the address parameter is not a valid IP address or hostname.
  • - - - - -
- - - -

Associated Methods

- - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Utility_Network/whois'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Virtual_Guest/getBandwidthImage/index.html b/reference/services/SoftLayer_Virtual_Guest/getBandwidthImage/index.html deleted file mode 100644 index b845946584b..00000000000 --- a/reference/services/SoftLayer_Virtual_Guest/getBandwidthImage/index.html +++ /dev/null @@ -1,375 +0,0 @@ - - - - - - - - - - - - - - - - getBandwidthImage - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getBandwidthImage

-
-
-
-
-
- Classes - - SoftLayer_Virtual_Guest - -
- Tags - - method - - sldn - - virtual - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Virtual_Guest::getBandwidthImage -

- - -

- Retrieve a visual representation of the amount of network traffic that occurred for the specified time frame for a computing instance. -

-

Description

- - Use this method when needing a bandwidth image for a single guest. It will gather the correct input parameters for the generic graphing utility automatically based on the snapshot specified. - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
networkTypeenum
  • public
  • private
snapshotRangeenum
  • day
  • week
  • 30day
  • previous_calendar_month
  • current_calendar_month
  • current_billing_cycle
  • previous_billing_cycle
  • specified_day
  • specified_range
dateSpecifieddateTimeInclude this parameter when snapshot is ‘specified_day’ or ‘specified_range’. Needs to be formatted as: ‘MM/DD/YYYY’
dateSpecifiedEnddateTimeInclude this parameter when snapshotRange is ‘specified_range’. Also formatted as ‘MM/DD/YYYY’.’
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [enum, enum, dateTime, dateTime]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getBandwidthImage'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Virtual_Guest/getBandwidthImageByDate/index.html b/reference/services/SoftLayer_Virtual_Guest/getBandwidthImageByDate/index.html deleted file mode 100644 index 3c0600331f4..00000000000 --- a/reference/services/SoftLayer_Virtual_Guest/getBandwidthImageByDate/index.html +++ /dev/null @@ -1,365 +0,0 @@ - - - - - - - - - - - - - - - - getBandwidthImageByDate - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getBandwidthImageByDate

-
-
-
-
-
- Classes - - SoftLayer_Virtual_Guest - -
- Tags - - method - - sldn - - virtual - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Virtual_Guest::getBandwidthImageByDate -

- - -

- Retrieve a visual representation of the amount of network traffic that occurred for the specified time frame for a computing instance. -

-

Description

- - Use this method when needing a bandwidth image for a single guest. It will gather the correct input parameters for the generic graphing utility based on the date ranges - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
startDateTimedateTimedatetime of the start date of the graph
endDateTimedateTimedatetime of the ending date of the graph
networkTypestringtype of the graph, either “public” or “private”
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [dateTime, dateTime, string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getBandwidthImageByDate'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Virtual_Guest/getCpuMetricImage/index.html b/reference/services/SoftLayer_Virtual_Guest/getCpuMetricImage/index.html deleted file mode 100644 index 1d0403e8724..00000000000 --- a/reference/services/SoftLayer_Virtual_Guest/getCpuMetricImage/index.html +++ /dev/null @@ -1,355 +0,0 @@ - - - - - - - - - - - - - - - - getCpuMetricImage - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getCpuMetricImage

-
-
-
-
-
- Classes - - SoftLayer_Virtual_Guest - -
- Tags - - method - - sldn - - virtual - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Virtual_Guest::getCpuMetricImage -

- - -

- Retrieve a visual representation of the percentage of the amount of time that a cpu was in use for the specified time frame for a computing instance. -

-

Description

- - Use this method when needing a cpu usage image for a single guest. It will gather the correct input parameters for the generic graphing utility automatically based on the snapshot specified. - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
snapshotRangeenum
  • day
  • week
  • 30day
  • previous_calendar_month
  • current_calendar_month
  • current_billing_cycle
  • previous_billing_cycle
  • specified_day
dateSpecifieddateTimeInclude this parameter when snapshot is ‘specified_day’. Needs to be formatted as: ‘MM/DD/YYYY HH:00’
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [enum, dateTime]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getCpuMetricImage'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Virtual_Guest/getCpuMetricImageByDate/index.html b/reference/services/SoftLayer_Virtual_Guest/getCpuMetricImageByDate/index.html deleted file mode 100644 index 20073b30ab0..00000000000 --- a/reference/services/SoftLayer_Virtual_Guest/getCpuMetricImageByDate/index.html +++ /dev/null @@ -1,367 +0,0 @@ - - - - - - - - - - - - - - - - getCpuMetricImageByDate - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getCpuMetricImageByDate

-
-
-
-
-
- Classes - - SoftLayer_Virtual_Guest - -
- Tags - - method - - sldn - - virtual - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Virtual_Guest::getCpuMetricImageByDate -

- - -

- Retrieve a visual representation of the percentage of the amount of time that a cpu was in use for the specified time frame for a computing instance. -

-

Description

- - Use this method when needing a CPU usage image for a single guest. It will gather the correct input parameters for the generic graphing utility based on the date ranges - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
startDateTimedateTimedatetime of the start date of the graph
endDateTimedateTimedatetime of the ending date of the graph
cpuIndexesint[]reserved for future use. An array of cpu index numbers to specify which cpus to graph
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [dateTime, dateTime, int]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getCpuMetricImageByDate'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Virtual_Guest/getMemoryMetricImage/index.html b/reference/services/SoftLayer_Virtual_Guest/getMemoryMetricImage/index.html deleted file mode 100644 index aa5a3d0ac90..00000000000 --- a/reference/services/SoftLayer_Virtual_Guest/getMemoryMetricImage/index.html +++ /dev/null @@ -1,355 +0,0 @@ - - - - - - - - - - - - - - - - getMemoryMetricImage - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getMemoryMetricImage

-
-
-
-
-
- Classes - - SoftLayer_Virtual_Guest - -
- Tags - - method - - sldn - - virtual - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Virtual_Guest::getMemoryMetricImage -

- - -

- Retrieve a visual representation of the amount of memory used for the specified time frame for a computing instance. -

-

Description

- - Use this method when needing a memory usage image for a single guest. It will gather the correct input parameters for the generic graphing utility automatically based on the snapshot specified. - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
snapshotRangeenum
  • day
  • week
  • 30day
  • previous_calendar_month
  • current_calendar_month
  • current_billing_cycle
  • previous_billing_cycle
  • specified_day
  • specified_range
dateSpecifieddateTimeInclude this parameter when snapshot is ‘specified_day’ or ‘specified_range’. Needs to be formatted as: ‘MM/DD/YYYY’
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [enum, dateTime]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getMemoryMetricImage'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Virtual_Guest/getMemoryMetricImageByDate/index.html b/reference/services/SoftLayer_Virtual_Guest/getMemoryMetricImageByDate/index.html deleted file mode 100644 index 20a85d1d0c2..00000000000 --- a/reference/services/SoftLayer_Virtual_Guest/getMemoryMetricImageByDate/index.html +++ /dev/null @@ -1,355 +0,0 @@ - - - - - - - - - - - - - - - - getMemoryMetricImageByDate - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getMemoryMetricImageByDate

-
-
-
-
-
- Classes - - SoftLayer_Virtual_Guest - -
- Tags - - method - - sldn - - virtual - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Virtual_Guest::getMemoryMetricImageByDate -

- - -

- Retrieve a visual representation of the amount of memory used for the specified time frame for a computing instance. -

-

Description

- - Use this method when needing a image displaying the amount of memory used over time for a single computing instance. It will gather the correct input parameters for the generic graphing utility based on the date ranges - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
startDateTimedateTimedatetime of the start date of the graph
endDateTimedateTimedatetime of the ending date of the graph
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [dateTime, dateTime]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Virtual_Guest/{SoftLayer_Virtual_GuestID}/getMemoryMetricImageByDate'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getRiasAccount/index.html b/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getRiasAccount/index.html deleted file mode 100644 index faa64d3acce..00000000000 --- a/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getRiasAccount/index.html +++ /dev/null @@ -1,343 +0,0 @@ - - - - - - - - - - - - - - - - getRiasAccount - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getRiasAccount

-
-
-
-
-
- Classes - - SoftLayer_Virtual_Guest_Block_Device_Template_Group - -
- Tags - - method - - sldn - - virtual - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Virtual_Guest_Block_Device_Template_Group::getRiasAccount -

- - -

- -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
secretstring
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getRiasAccount'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Virtual_Host/getMetricTrackingObject/index.html b/reference/services/SoftLayer_Virtual_Host/getMetricTrackingObject/index.html deleted file mode 100644 index 7f455e0a5d4..00000000000 --- a/reference/services/SoftLayer_Virtual_Host/getMetricTrackingObject/index.html +++ /dev/null @@ -1,328 +0,0 @@ - - - - - - - - - - - - - - - - getMetricTrackingObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getMetricTrackingObject

-
-
-
-
-
- Classes - - SoftLayer_Virtual_Host - -
- Tags - - method - - sldn - - virtual - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Virtual_Host::getMetricTrackingObject -

- - -
Deprecated
- -

- -

-

Description

- - [DEPRECATED] - The metric tracking object for this virtual host. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Virtual_Host/{SoftLayer_Virtual_HostID}/getMetricTrackingObject'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Virtual_Storage_Repository/getAverageUsageMetricDataByDate/index.html b/reference/services/SoftLayer_Virtual_Storage_Repository/getAverageUsageMetricDataByDate/index.html deleted file mode 100644 index 51512f70123..00000000000 --- a/reference/services/SoftLayer_Virtual_Storage_Repository/getAverageUsageMetricDataByDate/index.html +++ /dev/null @@ -1,355 +0,0 @@ - - - - - - - - - - - - - - - - getAverageUsageMetricDataByDate - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getAverageUsageMetricDataByDate

-
-
-
-
-
- Classes - - SoftLayer_Virtual_Storage_Repository - -
- Tags - - method - - sldn - - virtual - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Virtual_Storage_Repository::getAverageUsageMetricDataByDate -

- - -

- Returns the average disk usage for the timeframe based on the parameters provided. -

-

Description

- - Returns the average disk space usage for a storage repository. - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
startDateTimedateTimedatetime of the start date of the graph
endDateTimedateTimedatetime of the ending date of the graph
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

-
  • - - - - float - -
- - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [dateTime, dateTime]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Virtual_Storage_Repository/{SoftLayer_Virtual_Storage_RepositoryID}/getAverageUsageMetricDataByDate'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Virtual_Storage_Repository/getUsageMetricDataByDate/index.html b/reference/services/SoftLayer_Virtual_Storage_Repository/getUsageMetricDataByDate/index.html deleted file mode 100644 index 2da9096e11b..00000000000 --- a/reference/services/SoftLayer_Virtual_Storage_Repository/getUsageMetricDataByDate/index.html +++ /dev/null @@ -1,357 +0,0 @@ - - - - - - - - - - - - - - - - getUsageMetricDataByDate - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getUsageMetricDataByDate

-
-
-
-
-
- Classes - - SoftLayer_Virtual_Storage_Repository - -
- Tags - - method - - sldn - - virtual - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Virtual_Storage_Repository::getUsageMetricDataByDate -

- - -

- Retrieve the metric data for disk space usage for a storage repository. -

-

Description

- - Retrieve disk usage data on a SoftLayer_Virtual_Guest image for the time range you provide. Each data entry objects contain ‘‘dateTime’’ and ‘‘counter’’ properties. ‘‘dateTime’’ property indicates the time that the disk usage data was measured and ‘‘counter’’ property holds the disk usage in bytes. - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
startDateTimedateTimedatetime of the start date of the graph
endDateTimedateTimedatetime of the ending date of the graph
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [dateTime, dateTime]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Virtual_Storage_Repository/{SoftLayer_Virtual_Storage_RepositoryID}/getUsageMetricDataByDate'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Virtual_Storage_Repository/getUsageMetricImageByDate/index.html b/reference/services/SoftLayer_Virtual_Storage_Repository/getUsageMetricImageByDate/index.html deleted file mode 100644 index 98e06442a05..00000000000 --- a/reference/services/SoftLayer_Virtual_Storage_Repository/getUsageMetricImageByDate/index.html +++ /dev/null @@ -1,355 +0,0 @@ - - - - - - - - - - - - - - - - getUsageMetricImageByDate - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getUsageMetricImageByDate

-
-
-
-
-
- Classes - - SoftLayer_Virtual_Storage_Repository - -
- Tags - - method - - sldn - - virtual - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Virtual_Storage_Repository::getUsageMetricImageByDate -

- - -

- Retrieve an image of the disk usage data on a SoftLayer_Virtual_Guest image for the time range you provide. -

-

Description

- - Returns a disk usage image based on disk usage specified by the input parameters. - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
startDateTimedateTimedatetime of the start date of the graph
endDateTimedateTimedatetime of the ending date of the graph
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - - -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [dateTime, dateTime]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Virtual_Storage_Repository/{SoftLayer_Virtual_Storage_RepositoryID}/getUsageMetricImageByDate'
-
-
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Workload_Citrix_Client/createResourceLocation/index.html b/reference/services/SoftLayer_Workload_Citrix_Client/createResourceLocation/index.html deleted file mode 100644 index 3fe673e22b4..00000000000 --- a/reference/services/SoftLayer_Workload_Citrix_Client/createResourceLocation/index.html +++ /dev/null @@ -1,289 +0,0 @@ - - - - - - - - - - - - - - - - createResourceLocation - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

createResourceLocation

-
-
-
-
-
- Classes - - SoftLayer_Workload_Citrix_Client - -
- Tags - - method - - sldn - - workload - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Workload_Citrix_Client::createResourceLocation -

- - -

- -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
citrixCredentialsSoftLayer_Workload_Citrix_Requestnull $citrixCredentials
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - -
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Workload_Citrix_Client/getResourceLocations/index.html b/reference/services/SoftLayer_Workload_Citrix_Client/getResourceLocations/index.html deleted file mode 100644 index 13147645fee..00000000000 --- a/reference/services/SoftLayer_Workload_Citrix_Client/getResourceLocations/index.html +++ /dev/null @@ -1,289 +0,0 @@ - - - - - - - - - - - - - - - - getResourceLocations - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getResourceLocations

-
-
-
-
-
- Classes - - SoftLayer_Workload_Citrix_Client - -
- Tags - - method - - sldn - - workload - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Workload_Citrix_Client::getResourceLocations -

- - -

- -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
citrixCredentialsSoftLayer_Workload_Citrix_Requestnull $citrixCredentials
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - -
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Workload_Citrix_Client/index.html b/reference/services/SoftLayer_Workload_Citrix_Client/index.html deleted file mode 100644 index 0b8020d4f20..00000000000 --- a/reference/services/SoftLayer_Workload_Citrix_Client/index.html +++ /dev/null @@ -1,268 +0,0 @@ - - - - - - - - - - - - - SoftLayer_Workload_Citrix_Client - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Workload_Citrix_Client

-
-
-
-
-
- Classes - - SoftLayer_Workload_Citrix_Client - -
- Tags - - service - - sldn - - workload - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Workload_Citrix_Client

- - -
- -
- - -

Description

- - The SoftLayer_Workload_Citrix_Client data type contains functionality to validate a Citrix account. - -
-

Methods

-
-
-
- -
-
-
-
- - - - - - - - - - - - - - - - -
-
- -
- -
-
- - - -
- - - - - - - diff --git a/reference/services/SoftLayer_Workload_Citrix_Client/validateCitrixCredentials/index.html b/reference/services/SoftLayer_Workload_Citrix_Client/validateCitrixCredentials/index.html deleted file mode 100644 index fb630fe3bf1..00000000000 --- a/reference/services/SoftLayer_Workload_Citrix_Client/validateCitrixCredentials/index.html +++ /dev/null @@ -1,289 +0,0 @@ - - - - - - - - - - - - - - - - validateCitrixCredentials - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

validateCitrixCredentials

-
-
-
-
-
- Classes - - SoftLayer_Workload_Citrix_Client - -
- Tags - - method - - sldn - - workload - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Workload_Citrix_Client::validateCitrixCredentials -

- - -

- -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
citrixCredentialsSoftLayer_Workload_Citrix_Requestnull $citrixCredentials
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - -
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Workload_Citrix_Deployment/createObject/index.html b/reference/services/SoftLayer_Workload_Citrix_Deployment/createObject/index.html deleted file mode 100644 index 4160b333ade..00000000000 --- a/reference/services/SoftLayer_Workload_Citrix_Deployment/createObject/index.html +++ /dev/null @@ -1,289 +0,0 @@ - - - - - - - - - - - - - - - - createObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

createObject

-
-
-
-
-
- Classes - - SoftLayer_Workload_Citrix_Deployment - -
- Tags - - method - - sldn - - workload - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Workload_Citrix_Deployment::createObject -

- - -

- -

-

Description

- - Creates a new Citrix Virtual Apps and Desktops deployment. - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
templateObjectSoftLayer_Workload_Citrix_DeploymentThe SoftLayer_Workload_Citrix_Deployment object that you wish to create.
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - -
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Workload_Citrix_Deployment/getAccount/index.html b/reference/services/SoftLayer_Workload_Citrix_Deployment/getAccount/index.html deleted file mode 100644 index 2d5e9a5f845..00000000000 --- a/reference/services/SoftLayer_Workload_Citrix_Deployment/getAccount/index.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - - - - - - - - - - - getAccount - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getAccount

-
-
-
-
-
- Classes - - SoftLayer_Workload_Citrix_Deployment - -
- Tags - - method - - sldn - - workload - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Workload_Citrix_Deployment::getAccount -

- - -

- -

-

Description

- - The SoftLayer_Account to which the deployment belongs. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - -
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Workload_Citrix_Deployment/getAllObjects/index.html b/reference/services/SoftLayer_Workload_Citrix_Deployment/getAllObjects/index.html deleted file mode 100644 index 54941b577a4..00000000000 --- a/reference/services/SoftLayer_Workload_Citrix_Deployment/getAllObjects/index.html +++ /dev/null @@ -1,273 +0,0 @@ - - - - - - - - - - - - - - - - getAllObjects - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getAllObjects

-
-
-
-
-
- Classes - - SoftLayer_Workload_Citrix_Deployment - -
- Tags - - method - - sldn - - workload - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Workload_Citrix_Deployment::getAllObjects -

- - -

- -

-

Description

- - Get all Citrix Virtual Apps And Desktop deployments. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - -
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Workload_Citrix_Deployment/getDeployment/index.html b/reference/services/SoftLayer_Workload_Citrix_Deployment/getDeployment/index.html deleted file mode 100644 index cc7e71b0801..00000000000 --- a/reference/services/SoftLayer_Workload_Citrix_Deployment/getDeployment/index.html +++ /dev/null @@ -1,290 +0,0 @@ - - - - - - - - - - - - - - - - getDeployment - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getDeployment

-
-
-
-
-
- Classes - - SoftLayer_Workload_Citrix_Deployment - -
- Tags - - method - - sldn - - workload - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Workload_Citrix_Deployment::getDeployment -

- - -

- -

-

Description

- -

Returns a response object SoftLayer_Workload_Citrix_Deployment_Response which represents the CVAD deployment SoftLayer_Workload_Citrix_Deployment together with all the resources ordered under the CVAD order.

-

The deployment resources are represented by object SoftLayer_Workload_Citrix_Deployment_Resource_Response.

- - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
deploymentIdint
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - -
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Workload_Citrix_Deployment/getObject/index.html b/reference/services/SoftLayer_Workload_Citrix_Deployment/getObject/index.html deleted file mode 100644 index fcdda8b412d..00000000000 --- a/reference/services/SoftLayer_Workload_Citrix_Deployment/getObject/index.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - - - - - - - - - - - getObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getObject

-
-
-
-
-
- Classes - - SoftLayer_Workload_Citrix_Deployment - -
- Tags - - method - - sldn - - workload - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Workload_Citrix_Deployment::getObject -

- - -

- Retrieve a SoftLayer_Workload_Citrix_Deployment record. -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - -
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Workload_Citrix_Deployment/getResources/index.html b/reference/services/SoftLayer_Workload_Citrix_Deployment/getResources/index.html deleted file mode 100644 index 894ce9c2138..00000000000 --- a/reference/services/SoftLayer_Workload_Citrix_Deployment/getResources/index.html +++ /dev/null @@ -1,275 +0,0 @@ - - - - - - - - - - - - - - - - getResources - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getResources

-
-
-
-
-
- Classes - - SoftLayer_Workload_Citrix_Deployment - -
- Tags - - method - - sldn - - workload - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Workload_Citrix_Deployment::getResources -

- - -

- -

-

Description

- - It contains a collection of items under the CVAD deployment. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - -
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Workload_Citrix_Deployment/getStatus/index.html b/reference/services/SoftLayer_Workload_Citrix_Deployment/getStatus/index.html deleted file mode 100644 index 9739cee28b0..00000000000 --- a/reference/services/SoftLayer_Workload_Citrix_Deployment/getStatus/index.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - - - - - - - - - - - getStatus - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getStatus

-
-
-
-
-
- Classes - - SoftLayer_Workload_Citrix_Deployment - -
- Tags - - method - - sldn - - workload - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Workload_Citrix_Deployment::getStatus -

- - -

- -

-

Description

- - Current Status of the CVAD deployment. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - -
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Workload_Citrix_Deployment/getType/index.html b/reference/services/SoftLayer_Workload_Citrix_Deployment/getType/index.html deleted file mode 100644 index 67f9eb452f8..00000000000 --- a/reference/services/SoftLayer_Workload_Citrix_Deployment/getType/index.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - - - - - - - - - - - getType - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getType

-
-
-
-
-
- Classes - - SoftLayer_Workload_Citrix_Deployment - -
- Tags - - method - - sldn - - workload - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Workload_Citrix_Deployment::getType -

- - -

- -

-

Description

- - It shows if the deployment is for Citrix Hypervisor or VMware. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - -
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Workload_Citrix_Deployment/getUser/index.html b/reference/services/SoftLayer_Workload_Citrix_Deployment/getUser/index.html deleted file mode 100644 index 51d7e537a06..00000000000 --- a/reference/services/SoftLayer_Workload_Citrix_Deployment/getUser/index.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - - - - - - - - - - - getUser - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getUser

-
-
-
-
-
- Classes - - SoftLayer_Workload_Citrix_Deployment - -
- Tags - - method - - sldn - - workload - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Workload_Citrix_Deployment::getUser -

- - -

- -

-

Description

- - It is the SoftLayer_User_Customer who placed the order for CVAD. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - -
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Workload_Citrix_Deployment/getVlan/index.html b/reference/services/SoftLayer_Workload_Citrix_Deployment/getVlan/index.html deleted file mode 100644 index 72a31dd8b44..00000000000 --- a/reference/services/SoftLayer_Workload_Citrix_Deployment/getVlan/index.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - - - - - - - - - - - getVlan - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getVlan

-
-
-
-
-
- Classes - - SoftLayer_Workload_Citrix_Deployment - -
- Tags - - method - - sldn - - workload - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Workload_Citrix_Deployment::getVlan -

- - -

- -

-

Description

- - It is the VLAN resource for the CVAD deployment. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - -
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Workload_Citrix_Deployment/index.html b/reference/services/SoftLayer_Workload_Citrix_Deployment/index.html deleted file mode 100644 index d59ba1538bc..00000000000 --- a/reference/services/SoftLayer_Workload_Citrix_Deployment/index.html +++ /dev/null @@ -1,334 +0,0 @@ - - - - - - - - - - - - - SoftLayer_Workload_Citrix_Deployment - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Workload_Citrix_Deployment

-
-
-
-
-
- Classes - - SoftLayer_Workload_Citrix_Deployment - -
- Tags - - service - - sldn - - workload - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Workload_Citrix_Deployment

- - -
- -
- - -

Description

- -

The SoftLayer_Workload_Citrix_Deployment service allows viewing the resources ordered for Citrix Virtual Apps and Desktops.

-

The deployment resources include Cloud Connectors, Active Directory domain controller, Bare Metal servers, File Storage, VLAN, Primary/Portable subnets, DHCP server, and Proxy server.

- - -
-

Methods

-
-
-
- -
-
-
-
- - - - - -
-

createObject

- -

Creates a new Citrix Virtual Apps and Desktops deployment.

- -
- - - -
-

getAccount

- -

The SoftLayer_Account to which the deployment belongs.

- -
- - - -
-

getAllObjects

- -

Get all Citrix Virtual Apps And Desktop deployments.

- -
- - - -
-

getDeployment

- -

Returns a response object SoftLayer_Workload_Citrix_Deployment_Response which represents the CVAD deployment SoftLayer_Workload_Citrix_Deployment together with all the resources ordered under the CVAD order.

-

The deployment resources are represented by object …

- -
- - - -
-

getObject

- -

Retrieve a SoftLayer_Workload_Citrix_Deployment record.

- -
- - - -
-

getResources

- -

It contains a collection of items under the CVAD deployment.

- -
- - - -
-

getStatus

- -

Current Status of the CVAD deployment.

- -
- - - -
-

getType

- -

It shows if the deployment is for Citrix Hypervisor or VMware.

- -
- - - -
-

getUser

- -

It is the SoftLayer_User_Customer who placed the order for CVAD.

- -
- - - -
-

getVlan

- -

It is the VLAN resource for the CVAD deployment.

- -
- - -
-
- -
- -
-
- - - -
- - - - - - - diff --git a/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/createObject/index.html b/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/createObject/index.html deleted file mode 100644 index bfb72b861a0..00000000000 --- a/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/createObject/index.html +++ /dev/null @@ -1,289 +0,0 @@ - - - - - - - - - - - - - - - - createObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

createObject

-
-
-
-
-
- Classes - - SoftLayer_Workload_Citrix_Deployment_Resource - -
- Tags - - method - - sldn - - workload - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Workload_Citrix_Deployment_Resource::createObject -

- - -

- Add the resource into CVAD deployment resources. -

-

Description

- - This will add the resource into CVAD deployment. - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
templateObjectSoftLayer_Workload_Citrix_Deployment_ResourceThe SoftLayer_Workload_Citrix_Deployment_Resource object that you wish to create.
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - -
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/getAllObjects/index.html b/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/getAllObjects/index.html deleted file mode 100644 index cf255c2a0bb..00000000000 --- a/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/getAllObjects/index.html +++ /dev/null @@ -1,273 +0,0 @@ - - - - - - - - - - - - - - - - getAllObjects - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getAllObjects

-
-
-
-
-
- Classes - - SoftLayer_Workload_Citrix_Deployment_Resource - -
- Tags - - method - - sldn - - workload - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Workload_Citrix_Deployment_Resource::getAllObjects -

- - -

- Get all the Citrix deployment resources. -

-

Description

- - Get all the resources of Citrix Deployments. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - -
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/getBillingItem/index.html b/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/getBillingItem/index.html deleted file mode 100644 index f5c1201efad..00000000000 --- a/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/getBillingItem/index.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - - - - - - - - - - - getBillingItem - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getBillingItem

-
-
-
-
-
- Classes - - SoftLayer_Workload_Citrix_Deployment_Resource - -
- Tags - - method - - sldn - - workload - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Workload_Citrix_Deployment_Resource::getBillingItem -

- - -

- -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - -
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/getDeployment/index.html b/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/getDeployment/index.html deleted file mode 100644 index c9191e8d5ba..00000000000 --- a/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/getDeployment/index.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - - - - - - - - - - - getDeployment - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getDeployment

-
-
-
-
-
- Classes - - SoftLayer_Workload_Citrix_Deployment_Resource - -
- Tags - - method - - sldn - - workload - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Workload_Citrix_Deployment_Resource::getDeployment -

- - -

- -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - -
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/getObject/index.html b/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/getObject/index.html deleted file mode 100644 index b7d4fdc1d10..00000000000 --- a/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/getObject/index.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - - - - - - - - - - - getObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getObject

-
-
-
-
-
- Classes - - SoftLayer_Workload_Citrix_Deployment_Resource - -
- Tags - - method - - sldn - - workload - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Workload_Citrix_Deployment_Resource::getObject -

- - -

- Retrieve a SoftLayer_Workload_Citrix_Deployment_Resource record. -

-

Description

- - getObject retrieves the SoftLayer_Workload_Citrix_Deployment_Resource object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Workload_Citrix_Deployment_Resource service. You can only retrieve resources that are assigned to your portal user’s account. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - -
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/getOrder/index.html b/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/getOrder/index.html deleted file mode 100644 index a66eb7a0773..00000000000 --- a/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/getOrder/index.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - - - - - - - - - - - getOrder - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getOrder

-
-
-
-
-
- Classes - - SoftLayer_Workload_Citrix_Deployment_Resource - -
- Tags - - method - - sldn - - workload - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Workload_Citrix_Deployment_Resource::getOrder -

- - -

- -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - -
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/getRole/index.html b/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/getRole/index.html deleted file mode 100644 index a568843c49e..00000000000 --- a/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/getRole/index.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - - - - - - - - - - - getRole - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getRole

-
-
-
-
-
- Classes - - SoftLayer_Workload_Citrix_Deployment_Resource - -
- Tags - - method - - sldn - - workload - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Workload_Citrix_Deployment_Resource::getRole -

- - -

- -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - -
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/index.html b/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/index.html deleted file mode 100644 index d9ff301b555..00000000000 --- a/reference/services/SoftLayer_Workload_Citrix_Deployment_Resource/index.html +++ /dev/null @@ -1,304 +0,0 @@ - - - - - - - - - - - - - SoftLayer_Workload_Citrix_Deployment_Resource - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Workload_Citrix_Deployment_Resource

-
-
-
-
-
- Classes - - SoftLayer_Workload_Citrix_Deployment_Resource - -
- Tags - - service - - sldn - - workload - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Workload_Citrix_Deployment_Resource

- - -
- -
- - -

Description

- - SoftLayer_Workload_Citrix_Deployment_Resource represents the resource of Citrix Virtual Apps & Desktops deployment. - -
-

Methods

-
-
-
- -
-
-
-
- - - - - -
-

createObject

- -

Add the resource into CVAD deployment resources.

- -
- - - -
-

getAllObjects

- -

Get all the Citrix deployment resources.

- -
- - - -
-

getBillingItem

- -

- -
- - - -
-

getDeployment

- -

- -
- - - -
-

getObject

- -

Retrieve a SoftLayer_Workload_Citrix_Deployment_Resource record.

- -
- - - -
-

getOrder

- -

- -
- - - -
-

getRole

- -

- -
- - -
-
- -
- -
-
- - - -
- - - - - - - diff --git a/reference/services/SoftLayer_Workload_Citrix_Deployment_Type/getObject/index.html b/reference/services/SoftLayer_Workload_Citrix_Deployment_Type/getObject/index.html deleted file mode 100644 index 0d75ae56051..00000000000 --- a/reference/services/SoftLayer_Workload_Citrix_Deployment_Type/getObject/index.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - - - - - - - - - - - getObject - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getObject

-
-
-
-
-
- Classes - - SoftLayer_Workload_Citrix_Deployment_Type - -
- Tags - - method - - sldn - - workload - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Workload_Citrix_Deployment_Type::getObject -

- - -

- Retrieve a SoftLayer_Workload_Citrix_Deployment_Type record. -

-

Description

- - - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

- - -

Return Values

- - - - -
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Workload_Citrix_Deployment_Type/index.html b/reference/services/SoftLayer_Workload_Citrix_Deployment_Type/index.html deleted file mode 100644 index be3ff32f75c..00000000000 --- a/reference/services/SoftLayer_Workload_Citrix_Deployment_Type/index.html +++ /dev/null @@ -1,252 +0,0 @@ - - - - - - - - - - - - - SoftLayer_Workload_Citrix_Deployment_Type - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Workload_Citrix_Deployment_Type

-
-
-
-
-
- Classes - - SoftLayer_Workload_Citrix_Deployment_Type - -
- Tags - - service - - sldn - - workload - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Workload_Citrix_Deployment_Type

- - -
- -
- - -

Description

- -

The SoftLayer_Workload_Citrix_Deployment_Type service tells the kind of Citrix Virtual Apps and Desktop deployment order.

-

The Citrix Virtual Apps and Desktop deployment can be in one of the following two types, - Citrix Hypervisor: This type of deployment uses XenServer Hypervisor provided by Citrix to create virtual machines - VMware: This type of deployment uses VMware hypervisor with NFS or VSAN for the storage solution.

- - -
-

Methods

-
-
-
- -
-
-
-
- - - - - -
-

getObject

- -

Retrieve a SoftLayer_Workload_Citrix_Deployment_Type record.

- -
- - -
-
- -
- -
-
- - - -
- - - - - - - diff --git a/reference/services/SoftLayer_Workload_Citrix_Workspace_Order/cancelWorkspaceResources/index.html b/reference/services/SoftLayer_Workload_Citrix_Workspace_Order/cancelWorkspaceResources/index.html deleted file mode 100644 index a800edcefb0..00000000000 --- a/reference/services/SoftLayer_Workload_Citrix_Workspace_Order/cancelWorkspaceResources/index.html +++ /dev/null @@ -1,308 +0,0 @@ - - - - - - - - - - - - - - - - cancelWorkspaceResources - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

cancelWorkspaceResources

-
-
-
-
-
- Classes - - SoftLayer_Workload_Citrix_Workspace_Order - -
- Tags - - method - - sldn - - workload - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Workload_Citrix_Workspace_Order::cancelWorkspaceResources -

- - -

- Cancel the orders associated with resources on the provided VLAN -

-

Description

- - This method will cancel the resources associated with the provided VLAN and have a ‘cvad’ tag reference. - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
vlanIdentifierstringThe name, id or identifier (mex09.bcr22.1157) for the vlan.
cancelImmediatelybooleanThis will trigger an immediate cancellation with a reclaim of the resource.
customerNotestringTracks any additional information that the customer wanted to provide.
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - -
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Workload_Citrix_Workspace_Order/getWorkspaceNames/index.html b/reference/services/SoftLayer_Workload_Citrix_Workspace_Order/getWorkspaceNames/index.html deleted file mode 100644 index a080db58af8..00000000000 --- a/reference/services/SoftLayer_Workload_Citrix_Workspace_Order/getWorkspaceNames/index.html +++ /dev/null @@ -1,267 +0,0 @@ - - - - - - - - - - - - - - - - getWorkspaceNames - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getWorkspaceNames

-
-
-
-
-
- Classes - - SoftLayer_Workload_Citrix_Workspace_Order - -
- Tags - - method - - sldn - - workload - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Workload_Citrix_Workspace_Order::getWorkspaceNames -

- - -

- Get a list of all VLAN names which have ‘cvad’ tags associated with them. -

-

Description

- - This method will return the list of names of VLANs which have a ‘cvad’ tag reference. This name can be used with the cancelWorkspaceOrders method. - -
- -

Parameters

- - - -

None

- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - -
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Workload_Citrix_Workspace_Order/getWorkspaceResources/index.html b/reference/services/SoftLayer_Workload_Citrix_Workspace_Order/getWorkspaceResources/index.html deleted file mode 100644 index ad6dd20c7bb..00000000000 --- a/reference/services/SoftLayer_Workload_Citrix_Workspace_Order/getWorkspaceResources/index.html +++ /dev/null @@ -1,288 +0,0 @@ - - - - - - - - - - - - - - - - getWorkspaceResources - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

getWorkspaceResources

-
-
-
-
-
- Classes - - SoftLayer_Workload_Citrix_Workspace_Order - -
- Tags - - method - - sldn - - workload - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Workload_Citrix_Workspace_Order::getWorkspaceResources -

- - -

- List the orders associated with resources on the provided VLAN -

-

Description

- - This method will return the list of resources which could be cancelled using cancelWorkspaceResources - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
vlanIdentifierstringThe name, id or identifier (e.g. mex09.bcr22.1157) for the vlan.
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - -
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Workload_Citrix_Workspace_Order/index.html b/reference/services/SoftLayer_Workload_Citrix_Workspace_Order/index.html deleted file mode 100644 index 8cd28b2c4a5..00000000000 --- a/reference/services/SoftLayer_Workload_Citrix_Workspace_Order/index.html +++ /dev/null @@ -1,286 +0,0 @@ - - - - - - - - - - - - - SoftLayer_Workload_Citrix_Workspace_Order - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Workload_Citrix_Workspace_Order

-
-
-
-
-
- Classes - - SoftLayer_Workload_Citrix_Workspace_Order - -
- Tags - - service - - sldn - - workload - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Workload_Citrix_Workspace_Order

- - -
- -
- - -

Description

- - This service is used to order an implementation of Citrix Virtual Apps and Desktops running on IBM Cloud - -
-

Methods

-
-
-
- -
-
-
-
- - - - - -
-

cancelWorkspaceResources

- -

Cancel the orders associated with resources on the provided VLAN

- -
- - - -
-

getWorkspaceNames

- -

Get a list of all VLAN names which have ‘cvad’ tags associated with them.

- -
- - - -
-

getWorkspaceResources

- -

List the orders associated with resources on the provided VLAN

- -
- - - - - - - -
-

verifyWorkspaceOrder

- -

Verify that an order may be successfully placed with the details provided.

- -
- - -
-
- -
- -
-
- - - -
- - - - - - - diff --git a/reference/services/SoftLayer_Workload_Citrix_Workspace_Order/placeWorkspaceOrder/index.html b/reference/services/SoftLayer_Workload_Citrix_Workspace_Order/placeWorkspaceOrder/index.html deleted file mode 100644 index 559e277efd6..00000000000 --- a/reference/services/SoftLayer_Workload_Citrix_Workspace_Order/placeWorkspaceOrder/index.html +++ /dev/null @@ -1,289 +0,0 @@ - - - - - - - - - - - - - - - - placeWorkspaceOrder - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

placeWorkspaceOrder

-
-
-
-
-
- Classes - - SoftLayer_Workload_Citrix_Workspace_Order - -
- Tags - - method - - sldn - - workload - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Workload_Citrix_Workspace_Order::placeWorkspaceOrder -

- - -

- -

-

Description

- - - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
orderContainerSoftLayer_Workload_Citrix_Workspace_Order_Container
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - -
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Workload_Citrix_Workspace_Order/verifyWorkspaceOrder/index.html b/reference/services/SoftLayer_Workload_Citrix_Workspace_Order/verifyWorkspaceOrder/index.html deleted file mode 100644 index 397ed228405..00000000000 --- a/reference/services/SoftLayer_Workload_Citrix_Workspace_Order/verifyWorkspaceOrder/index.html +++ /dev/null @@ -1,289 +0,0 @@ - - - - - - - - - - - - - - - - verifyWorkspaceOrder - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

verifyWorkspaceOrder

-
-
-
-
-
- Classes - - SoftLayer_Workload_Citrix_Workspace_Order - -
- Tags - - method - - sldn - - workload - -
-
-
- -
-
- - - -
-
- -

- SoftLayer_Workload_Citrix_Workspace_Order::verifyWorkspaceOrder -

- - -

- Verify that an order may be successfully placed with the details provided. -

-

Description

- - This service is used to verify that an order meets all the necessary requirements to purchase Citrix Virtual Apps and Desktops running on IBM cloud. - -
- -

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
orderContainerSoftLayer_Workload_Citrix_Workspace_Order_Container
- - - - - - - - - - - -

Required Headers

- - -

Optional Headers

-
    - - - - -
  • None

  • - -
- -

Return Values

- - - - -
- -
-
- - -
- - - - - - diff --git a/reference/services/SoftLayer_Workload_Citrix_Workspace_Response/index.html b/reference/services/SoftLayer_Workload_Citrix_Workspace_Response/index.html deleted file mode 100644 index ce306d0442f..00000000000 --- a/reference/services/SoftLayer_Workload_Citrix_Workspace_Response/index.html +++ /dev/null @@ -1,241 +0,0 @@ - - - - - - - - - - - - - SoftLayer_Workload_Citrix_Workspace_Response - https://sldn.softlayer.com/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- -
-
-

SoftLayer_Workload_Citrix_Workspace_Response

-
-
-
-
-
- Classes - - SoftLayer_Workload_Citrix_Workspace_Response - -
- Tags - - service - - sldn - - workload - -
-
-
- -
-
- - - -
-
- -

SoftLayer_Workload_Citrix_Workspace_Response

- - -
- -
- - -

Description

- - The SoftLayer_Workload_Citrix_Response constructs a response object for SoftLayer_Workload_Citrix_Order. - -
-

Methods

-
-
-
- -
-
-
-
- - - - -
-
- -
- -
-
- - - -
- - - - - - -