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 @@ - - - -
- - - - - - - -
-
- Authorization token that’s included on linking calls.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- Pseudonym for destinationAccountAlphanumericId
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- Id for the user given the Cloud Admin role for this domain.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- Name for the user given the Cloud Admin role for this domain.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- Id for the domain this project was added to.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- Id for the user given the Project Admin role for this project.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- Name for the user given the Project Admin role for this project.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The manufacturer’s serial number of the media.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The account to which the media belongs.
-
-
-
-
- Type:
-
-
- SoftLayer_Account
-
-
-
-
- The customer user who created the media object.
-
-
-
-
- Type:
-
-
- SoftLayer_User_Customer
-
-
-
-
- The datacenter where the media resides.
-
-
-
-
- Type:
-
-
- SoftLayer_Location
-
-
-
-
- The employee who last modified the media.
-
-
-
-
- Type:
-
-
- SoftLayer_User_Employee
-
-
-
-
- The customer user who last modified the media.
-
-
-
-
- Type:
-
-
- SoftLayer_User_Customer
-
-
-
-
- The request to which the media belongs.
-
-
-
-
- Type:
-
-
- SoftLayer_Account_Media_Data_Transfer_Request
-
-
-
-
- A guest’s associated EVault network storage service account.
-
-
-
-
- Type:
-
-
- SoftLayer_Network_Storage
-
-
-
-
- The account to which the request belongs.
-
-
-
-
- Type:
-
-
- SoftLayer_Account
-
-
-
-
- The active tickets that are attached to the data transfer request.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Ticket[]
-
-
-
-
- The billing item for the original request.
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item
-
-
-
-
- The customer user who created the request.
-
-
-
-
- Type:
-
-
- SoftLayer_User_Customer
-
-
-
-
- The employee who last modified the request.
-
-
-
-
- Type:
-
-
- SoftLayer_User_Employee
-
-
-
-
- The customer user who last modified the request.
-
-
-
-
- Type:
-
-
- SoftLayer_User_Customer
-
-
-
-
- The shipments of the request.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Account_Shipment[]
-
-
-
-
- The status of the request.
-
-
-
-
- Type:
-
-
- SoftLayer_Account_Media_Data_Transfer_Request_Status
-
-
-
-
- All tickets that are attached to the data transfer request.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Ticket[]
-
-
-
-
- A count of the active tickets that are attached to the data transfer request.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of the shipments of the request.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of all tickets that are attached to the data transfer request.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- The detail object’s associated SoftLayer_Account id
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The date and time the detail object was created
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- The detail object’s associated SoftLayer_Account_Regional_Registry_Detail_Type id
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The date and time the detail object was last modified
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- The detail object’s associated SoftLayer_Account_Rwhois_Handle id
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- [Deprecated] The account that this detail object belongs to.
-
-
-
-
- Type:
-
-
- SoftLayer_Account
-
-
-
Deprecated
- -
-
- [Deprecated] The associated type of this detail object.
-
-
-
-
- Type:
-
-
- SoftLayer_Account_Regional_Registry_Detail_Type
-
-
-
Deprecated
- -
-
- [Deprecated] References to the SoftLayer_Network_Subnet_Registration that consume this detail object.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Network_Subnet_Registration_Details[]
-
-
-
Deprecated
- -
-
- [Deprecated] The individual properties that define this detail object’s values.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Account_Regional_Registry_Detail_Property[]
-
-
-
Deprecated
- -
-
- [Deprecated] The associated RWhois handle of this detail object. Used only when detailed reassignments are necessary.
-
-
-
-
- Type:
-
-
- SoftLayer_Account_Rwhois_Handle
-
-
-
Deprecated
- -
-
- A count of [Deprecated] References to the SoftLayer_Network_Subnet_Registration that consume this detail object.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of [Deprecated] The individual properties that define this detail object’s values.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
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.
- - -
-
- The numeric ID of the related SoftLayer_Account_Regional_Registry_Detail_Property_Type
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The numeric ID of the related SoftLayer_Account_Regional_Registry_Detail
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- When multiple properties exist for a property type, defines the position in the sequence of those properties
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- [Deprecated] The SoftLayer_Account_Regional_Registry_Detail object this property belongs to
-
-
-
-
- Type:
-
-
- SoftLayer_Account_Regional_Registry_Detail
-
-
-
Deprecated
- -
-
- [Deprecated] The SoftLayer_Account_Regional_Registry_Detail_Property_Type object this property belongs to
-
-
-
-
- Type:
-
-
- SoftLayer_Account_Regional_Registry_Detail_Property_Type
-
-
-
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.
- - -
-
- Code-friendly string name of the property type
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- A Perl-compatible regular expression used to describe the valid format of the property
-
-
-
-
- Type:
-
-
- string
-
-
-
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:
-
- Code-friendly string name of the detail type
-
-
-
-
- Type:
-
-
- string
-
-
-
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.
- - -
-
- The detail object’s associated SoftLayer_Account id
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The date and time the detail object was created
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- The detail object’s associated SoftLayer_Account_Regional_Registry_Detail_Type id
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The date and time the detail object was last modified
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- The detail object’s associated SoftLayer_Account_Rwhois_Handle id
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- [Deprecated] The account that this detail object belongs to.
-
-
-
-
- Type:
-
-
- SoftLayer_Account
-
-
-
Deprecated
- -
-
- [Deprecated] The associated type of this detail object.
-
-
-
-
- Type:
-
-
- SoftLayer_Account_Regional_Registry_Detail_Type
-
-
-
Deprecated
- -
-
- [Deprecated] References to the SoftLayer_Network_Subnet_Registration that consume this detail object.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Network_Subnet_Registration_Details[]
-
-
-
Deprecated
- -
-
- [Deprecated] The individual properties that define this detail object’s values.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Account_Regional_Registry_Detail_Property[]
-
-
-
Deprecated
- -
-
- [Deprecated] The associated RWhois handle of this detail object. Used only when detailed reassignments are necessary.
-
-
-
-
- Type:
-
-
- SoftLayer_Account_Rwhois_Handle
-
-
-
Deprecated
- -
-
- A count of [Deprecated] References to the SoftLayer_Network_Subnet_Registration that consume this detail object.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of [Deprecated] The individual properties that define this detail object’s values.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
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.
- - -
-
- The handle object’s associated SoftLayer_Account id
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The handle object’s unique identifier as assigned by the RIR.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- [Deprecated] The account that this handle belongs to.
-
-
-
-
- Type:
-
-
- SoftLayer_Account
-
-
-
Deprecated
- -
-
- Flag to check if a billing item can be cancelled. 1 = yes. 0 = no.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- The date the billing item was created. You can see this date on the invoice.
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The last time this billing item was charged.
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- The domain name is provided for server billing items.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The hostname is provided for server billing items
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD).
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- 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
-
-
-
-
- The labor fee, if any. This is a one time charge.
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- The rate at which labor fees are taxed if you are a taxable customer.
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- The last time this billing item was charged.
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- The date that a billing item was last modified.
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- The date on which your account will be charged for this billing item.
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- The rate at which one time fees are taxed if you are a taxable customer.
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- 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
-
-
-
-
- This is the package id for this billing item.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The unique identifier of the parent of this billing item.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD).
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- The rate at which recurring fees are taxed if you are a taxable customer.
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- The number of months in which the recurring fees will be incurred.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- This is the service provider for this billing item.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The setup fee, if any. This is a one time charge.
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- The rate at which setup fees are taxed if you are a taxable customer.
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- The account that a billing item belongs to.
-
-
-
-
- Type:
-
-
- SoftLayer_Account
-
-
-
-
- A flag indicating that the billing item is under an active agreement.
-
-
-
-
- Type:
-
-
- SoftLayer_Account_Agreement
-
-
-
-
- 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[]
-
-
-
-
- None
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- A Billing Item’s active bundled billing items.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- A service cancellation request item that corresponds to the billing item.
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item_Cancellation_Request_Item
-
-
-
-
- A Billing Item’s active child billing items.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- None
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- A Billing Item’s spare pool bundled billing items.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- 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
-
-
-
-
- A history of billing items which a billing item has been associated with.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item_Association_History[]
-
-
-
-
- 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[]
-
-
-
-
- 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[]
-
-
-
-
- The bandwidth allocation for a billing item.
-
-
-
-
- Type:
-
-
- SoftLayer_Network_Bandwidth_Version1_Allocation
-
-
-
-
- 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[]
-
-
-
-
- A Billing Item’s bundled billing items.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- A Billing Item’s active child billing items.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- The billing item’s cancellation reason.
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item_Cancellation_Reason
-
-
-
-
- This will return any cancellation requests that are associated with this billing item.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item_Cancellation_Request[]
-
-
-
-
- The item category to which the billing item’s item belongs.
-
-
-
-
- Type:
-
-
- SoftLayer_Product_Item_Category
-
-
-
-
- A Billing Item’s child billing items'
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- A Billing Item’s active child billing items.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- For product items which have a downgrade path defined, this will return those product items.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Product_Item[]
-
-
-
-
- A Billing Item’s associated child billing items, excluding some items with a $0.00 recurring fee.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- A flag that will reflect whether this billing item is billed on an hourly basis or not.
-
-
-
-
- Type:
-
-
- boolean
-
-
-
-
- Invoice items associated with this billing item
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Invoice_Item
-
-
-
-
- All invoice items associated with the billing item
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Invoice_Item[]
-
-
-
-
- The entry in the SoftLayer product catalog that a billing item is based upon.
-
-
-
-
- Type:
-
-
- SoftLayer_Product_Item
-
-
-
-
- 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
-
-
-
-
- A Billing Item’s child billing items and associated items'
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- A Billing Item’s total, including any child billing items if they exist.'
-
-
-
-
- Type:
-
-
- float
-
-
-
-
- A Billing Item’s total, including any child billing items if they exist.'
-
-
-
-
- Type:
-
-
- float
-
-
-
-
- A Billing Item’s total, including any child billing items and associated billing items if they exist.'
-
-
-
-
- Type:
-
-
- float
-
-
-
-
- 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
-
-
-
-
- A Billing Item’s associated child billing items, excluding ALL items with a $0.00 recurring fee.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- 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
-
-
-
-
- The original physical location for this billing item–may differ from current.
-
-
-
-
- Type:
-
-
- SoftLayer_Location
-
-
-
-
- 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
-
-
-
-
- A billing item’s parent item. If a billing item has no parent item then this value is null.
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item
-
-
-
-
- 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
-
-
-
-
- This flag indicates whether a billing item is scheduled to be canceled or not.
-
-
-
-
- Type:
-
-
- boolean
-
-
-
-
- The new order item that will replace this billing item.
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Order_Item
-
-
-
-
- Provisioning transaction for this billing item
-
-
-
-
- Type:
-
-
- SoftLayer_Provisioning_Version1_Transaction
-
-
-
-
- The data transfer request to which the billing item points.
-
-
-
-
- Type:
-
-
- SoftLayer_Account_Media_Data_Transfer_Request
-
-
-
-
- A friendly description of software component
-
-
-
-
- Type:
-
-
- SoftLayer_Software_Description
-
-
-
-
- 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
-
-
-
-
- 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[]
-
-
-
-
- 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
-
-
-
-
- A count of
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of a Billing Item’s active bundled billing items.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of a Billing Item’s active child billing items.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of a Billing Item’s spare pool bundled billing items.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of a history of billing items which a billing item has been associated with.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- A count of a Billing Item’s bundled billing items.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of a Billing Item’s active child billing items.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of this will return any cancellation requests that are associated with this billing item.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of a Billing Item’s child billing items'
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of a Billing Item’s active child billing items.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of for product items which have a downgrade path defined, this will return those product items.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of a Billing Item’s associated child billing items, excluding some items with a $0.00 recurring fee.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of all invoice items associated with the billing item
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of a Billing Item’s child billing items and associated items'
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of a Billing Item’s associated child billing items, excluding ALL items with a $0.00 recurring fee.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- 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
-
-
-
-
- Flag to check if a billing item can be cancelled. 1 = yes. 0 = no.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- The date the billing item was created. You can see this date on the invoice.
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The last time this billing item was charged.
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- The domain name is provided for server billing items.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The hostname is provided for server billing items
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD).
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- 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
-
-
-
-
- The labor fee, if any. This is a one time charge.
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- The rate at which labor fees are taxed if you are a taxable customer.
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- The last time this billing item was charged.
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- The date that a billing item was last modified.
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- The date on which your account will be charged for this billing item.
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- The rate at which one time fees are taxed if you are a taxable customer.
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- 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
-
-
-
-
- This is the package id for this billing item.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The unique identifier of the parent of this billing item.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD).
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- The rate at which recurring fees are taxed if you are a taxable customer.
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- The number of months in which the recurring fees will be incurred.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- This is the service provider for this billing item.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The setup fee, if any. This is a one time charge.
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- The rate at which setup fees are taxed if you are a taxable customer.
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- The account that a billing item belongs to.
-
-
-
-
- Type:
-
-
- SoftLayer_Account
-
-
-
-
- A flag indicating that the billing item is under an active agreement.
-
-
-
-
- Type:
-
-
- SoftLayer_Account_Agreement
-
-
-
-
- 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[]
-
-
-
-
- None
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- A Billing Item’s active bundled billing items.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- A service cancellation request item that corresponds to the billing item.
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item_Cancellation_Request_Item
-
-
-
-
- A Billing Item’s active child billing items.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- None
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- A Billing Item’s spare pool bundled billing items.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- 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
-
-
-
-
- A history of billing items which a billing item has been associated with.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item_Association_History[]
-
-
-
-
- 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[]
-
-
-
-
- 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[]
-
-
-
-
- The bandwidth allocation for a billing item.
-
-
-
-
- Type:
-
-
- SoftLayer_Network_Bandwidth_Version1_Allocation
-
-
-
-
- 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[]
-
-
-
-
- A Billing Item’s bundled billing items.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- A Billing Item’s active child billing items.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- The billing item’s cancellation reason.
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item_Cancellation_Reason
-
-
-
-
- This will return any cancellation requests that are associated with this billing item.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item_Cancellation_Request[]
-
-
-
-
- The item category to which the billing item’s item belongs.
-
-
-
-
- Type:
-
-
- SoftLayer_Product_Item_Category
-
-
-
-
- A Billing Item’s child billing items'
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- A Billing Item’s active child billing items.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- For product items which have a downgrade path defined, this will return those product items.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Product_Item[]
-
-
-
-
- A Billing Item’s associated child billing items, excluding some items with a $0.00 recurring fee.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- A flag that will reflect whether this billing item is billed on an hourly basis or not.
-
-
-
-
- Type:
-
-
- boolean
-
-
-
-
- Invoice items associated with this billing item
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Invoice_Item
-
-
-
-
- All invoice items associated with the billing item
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Invoice_Item[]
-
-
-
-
- The entry in the SoftLayer product catalog that a billing item is based upon.
-
-
-
-
- Type:
-
-
- SoftLayer_Product_Item
-
-
-
-
- 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
-
-
-
-
- A Billing Item’s child billing items and associated items'
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- A Billing Item’s total, including any child billing items if they exist.'
-
-
-
-
- Type:
-
-
- float
-
-
-
-
- A Billing Item’s total, including any child billing items if they exist.'
-
-
-
-
- Type:
-
-
- float
-
-
-
-
- A Billing Item’s total, including any child billing items and associated billing items if they exist.'
-
-
-
-
- Type:
-
-
- float
-
-
-
-
- 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
-
-
-
-
- A Billing Item’s associated child billing items, excluding ALL items with a $0.00 recurring fee.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- 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
-
-
-
-
- The original physical location for this billing item–may differ from current.
-
-
-
-
- Type:
-
-
- SoftLayer_Location
-
-
-
-
- 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
-
-
-
-
- A billing item’s parent item. If a billing item has no parent item then this value is null.
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item
-
-
-
-
- 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
-
-
-
-
- This flag indicates whether a billing item is scheduled to be canceled or not.
-
-
-
-
- Type:
-
-
- boolean
-
-
-
-
- The new order item that will replace this billing item.
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Order_Item
-
-
-
-
- Provisioning transaction for this billing item
-
-
-
-
- Type:
-
-
- SoftLayer_Provisioning_Version1_Transaction
-
-
-
-
- The load balancer that a load balancer billing item is associated with.
-
-
-
-
- Type:
-
-
- SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress
-
-
-
-
- A friendly description of software component
-
-
-
-
- Type:
-
-
- SoftLayer_Software_Description
-
-
-
-
- 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
-
-
-
-
- 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[]
-
-
-
-
- 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
-
-
-
-
- A count of
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of a Billing Item’s active bundled billing items.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of a Billing Item’s active child billing items.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of a Billing Item’s spare pool bundled billing items.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of a history of billing items which a billing item has been associated with.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- A count of a Billing Item’s bundled billing items.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of a Billing Item’s active child billing items.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of this will return any cancellation requests that are associated with this billing item.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of a Billing Item’s child billing items'
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of a Billing Item’s active child billing items.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of for product items which have a downgrade path defined, this will return those product items.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of a Billing Item’s associated child billing items, excluding some items with a $0.00 recurring fee.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of all invoice items associated with the billing item
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of a Billing Item’s child billing items and associated items'
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of a Billing Item’s associated child billing items, excluding ALL items with a $0.00 recurring fee.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- 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
-
-
-
-
- Flag to check if a billing item can be cancelled. 1 = yes. 0 = no.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- The date the billing item was created. You can see this date on the invoice.
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The last time this billing item was charged.
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- The domain name is provided for server billing items.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The hostname is provided for server billing items
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD).
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- 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
-
-
-
-
- The labor fee, if any. This is a one time charge.
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- The rate at which labor fees are taxed if you are a taxable customer.
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- The last time this billing item was charged.
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- The date that a billing item was last modified.
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- The date on which your account will be charged for this billing item.
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- The rate at which one time fees are taxed if you are a taxable customer.
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- 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
-
-
-
-
- This is the package id for this billing item.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The unique identifier of the parent of this billing item.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD).
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- The rate at which recurring fees are taxed if you are a taxable customer.
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- The number of months in which the recurring fees will be incurred.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- This is the service provider for this billing item.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The setup fee, if any. This is a one time charge.
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- The rate at which setup fees are taxed if you are a taxable customer.
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- The account that a billing item belongs to.
-
-
-
-
- Type:
-
-
- SoftLayer_Account
-
-
-
-
- A flag indicating that the billing item is under an active agreement.
-
-
-
-
- Type:
-
-
- SoftLayer_Account_Agreement
-
-
-
-
- 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[]
-
-
-
-
- None
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- A Billing Item’s active bundled billing items.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- A service cancellation request item that corresponds to the billing item.
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item_Cancellation_Request_Item
-
-
-
-
- A Billing Item’s active child billing items.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- None
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- A Billing Item’s spare pool bundled billing items.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- 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
-
-
-
-
- A history of billing items which a billing item has been associated with.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item_Association_History[]
-
-
-
-
- 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[]
-
-
-
-
- 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[]
-
-
-
-
- The bandwidth allocation for a billing item.
-
-
-
-
- Type:
-
-
- SoftLayer_Network_Bandwidth_Version1_Allocation
-
-
-
-
- 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[]
-
-
-
-
- A Billing Item’s bundled billing items.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- A Billing Item’s active child billing items.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- The billing item’s cancellation reason.
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item_Cancellation_Reason
-
-
-
-
- This will return any cancellation requests that are associated with this billing item.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item_Cancellation_Request[]
-
-
-
-
- The item category to which the billing item’s item belongs.
-
-
-
-
- Type:
-
-
- SoftLayer_Product_Item_Category
-
-
-
-
- A Billing Item’s child billing items'
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- A Billing Item’s active child billing items.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- For product items which have a downgrade path defined, this will return those product items.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Product_Item[]
-
-
-
-
- A Billing Item’s associated child billing items, excluding some items with a $0.00 recurring fee.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- A flag that will reflect whether this billing item is billed on an hourly basis or not.
-
-
-
-
- Type:
-
-
- boolean
-
-
-
-
- Invoice items associated with this billing item
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Invoice_Item
-
-
-
-
- All invoice items associated with the billing item
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Invoice_Item[]
-
-
-
-
- The entry in the SoftLayer product catalog that a billing item is based upon.
-
-
-
-
- Type:
-
-
- SoftLayer_Product_Item
-
-
-
-
- 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
-
-
-
-
- A Billing Item’s child billing items and associated items'
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- A Billing Item’s total, including any child billing items if they exist.'
-
-
-
-
- Type:
-
-
- float
-
-
-
-
- A Billing Item’s total, including any child billing items if they exist.'
-
-
-
-
- Type:
-
-
- float
-
-
-
-
- A Billing Item’s total, including any child billing items and associated billing items if they exist.'
-
-
-
-
- Type:
-
-
- float
-
-
-
-
- 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
-
-
-
-
- A Billing Item’s associated child billing items, excluding ALL items with a $0.00 recurring fee.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- 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
-
-
-
-
- The original physical location for this billing item–may differ from current.
-
-
-
-
- Type:
-
-
- SoftLayer_Location
-
-
-
-
- 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
-
-
-
-
- A billing item’s parent item. If a billing item has no parent item then this value is null.
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item
-
-
-
-
- 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
-
-
-
-
- This flag indicates whether a billing item is scheduled to be canceled or not.
-
-
-
-
- Type:
-
-
- boolean
-
-
-
-
- The new order item that will replace this billing item.
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Order_Item
-
-
-
-
- Provisioning transaction for this billing item
-
-
-
-
- Type:
-
-
- SoftLayer_Provisioning_Version1_Transaction
-
-
-
-
- A friendly description of software component
-
-
-
-
- Type:
-
-
- SoftLayer_Software_Description
-
-
-
-
- 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
-
-
-
-
- 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[]
-
-
-
-
- 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
-
-
-
-
- A count of
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of a Billing Item’s active bundled billing items.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of a Billing Item’s active child billing items.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of a Billing Item’s spare pool bundled billing items.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of a history of billing items which a billing item has been associated with.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- A count of a Billing Item’s bundled billing items.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of a Billing Item’s active child billing items.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of this will return any cancellation requests that are associated with this billing item.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of a Billing Item’s child billing items'
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of a Billing Item’s active child billing items.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of for product items which have a downgrade path defined, this will return those product items.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of a Billing Item’s associated child billing items, excluding some items with a $0.00 recurring fee.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of all invoice items associated with the billing item
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of a Billing Item’s child billing items and associated items'
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of a Billing Item’s associated child billing items, excluding ALL items with a $0.00 recurring fee.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- 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
-
-
-
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’
- - -
-
- Flag to check if a billing item can be cancelled. 1 = yes. 0 = no.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- The date the billing item was created. You can see this date on the invoice.
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The last time this billing item was charged.
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- The domain name is provided for server billing items.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The hostname is provided for server billing items
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD).
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- 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
-
-
-
-
- The labor fee, if any. This is a one time charge.
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- The rate at which labor fees are taxed if you are a taxable customer.
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- The last time this billing item was charged.
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- The date that a billing item was last modified.
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- The date on which your account will be charged for this billing item.
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- The rate at which one time fees are taxed if you are a taxable customer.
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- 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
-
-
-
-
- This is the package id for this billing item.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The unique identifier of the parent of this billing item.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD).
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- The rate at which recurring fees are taxed if you are a taxable customer.
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- The number of months in which the recurring fees will be incurred.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- This is the service provider for this billing item.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The setup fee, if any. This is a one time charge.
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- The rate at which setup fees are taxed if you are a taxable customer.
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- The account that a billing item belongs to.
-
-
-
-
- Type:
-
-
- SoftLayer_Account
-
-
-
-
- A flag indicating that the billing item is under an active agreement.
-
-
-
-
- Type:
-
-
- SoftLayer_Account_Agreement
-
-
-
-
- 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[]
-
-
-
-
- None
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- A Billing Item’s active bundled billing items.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- A service cancellation request item that corresponds to the billing item.
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item_Cancellation_Request_Item
-
-
-
-
- A Billing Item’s active child billing items.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- None
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- A Billing Item’s spare pool bundled billing items.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- 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
-
-
-
-
- A history of billing items which a billing item has been associated with.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item_Association_History[]
-
-
-
-
- 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[]
-
-
-
-
- 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[]
-
-
-
-
- The bandwidth allocation for a billing item.
-
-
-
-
- Type:
-
-
- SoftLayer_Network_Bandwidth_Version1_Allocation
-
-
-
-
- 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[]
-
-
-
-
- A Billing Item’s bundled billing items.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- A Billing Item’s active child billing items.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- The billing item’s cancellation reason.
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item_Cancellation_Reason
-
-
-
-
- This will return any cancellation requests that are associated with this billing item.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item_Cancellation_Request[]
-
-
-
-
- The item category to which the billing item’s item belongs.
-
-
-
-
- Type:
-
-
- SoftLayer_Product_Item_Category
-
-
-
-
- A Billing Item’s child billing items'
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- A Billing Item’s active child billing items.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- For product items which have a downgrade path defined, this will return those product items.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Product_Item[]
-
-
-
-
- A Billing Item’s associated child billing items, excluding some items with a $0.00 recurring fee.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- A flag that will reflect whether this billing item is billed on an hourly basis or not.
-
-
-
-
- Type:
-
-
- boolean
-
-
-
-
- Invoice items associated with this billing item
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Invoice_Item
-
-
-
-
- All invoice items associated with the billing item
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Invoice_Item[]
-
-
-
-
- The entry in the SoftLayer product catalog that a billing item is based upon.
-
-
-
-
- Type:
-
-
- SoftLayer_Product_Item
-
-
-
-
- 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
-
-
-
-
- A Billing Item’s child billing items and associated items'
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- A Billing Item’s total, including any child billing items if they exist.'
-
-
-
-
- Type:
-
-
- float
-
-
-
-
- A Billing Item’s total, including any child billing items if they exist.'
-
-
-
-
- Type:
-
-
- float
-
-
-
-
- A Billing Item’s total, including any child billing items and associated billing items if they exist.'
-
-
-
-
- Type:
-
-
- float
-
-
-
-
- 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
-
-
-
-
- A Billing Item’s associated child billing items, excluding ALL items with a $0.00 recurring fee.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- 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
-
-
-
-
- The original physical location for this billing item–may differ from current.
-
-
-
-
- Type:
-
-
- SoftLayer_Location
-
-
-
-
- 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
-
-
-
-
- A billing item’s parent item. If a billing item has no parent item then this value is null.
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item
-
-
-
-
- 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
-
-
-
-
- This flag indicates whether a billing item is scheduled to be canceled or not.
-
-
-
-
- Type:
-
-
- boolean
-
-
-
-
- The new order item that will replace this billing item.
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Order_Item
-
-
-
-
- Provisioning transaction for this billing item
-
-
-
-
- Type:
-
-
- SoftLayer_Provisioning_Version1_Transaction
-
-
-
-
- The resource for a global load balancer billing item.
-
-
-
-
- Type:
-
-
- SoftLayer_Network_LoadBalancer_Global_Account
-
-
-
-
- A friendly description of software component
-
-
-
-
- Type:
-
-
- SoftLayer_Software_Description
-
-
-
-
- 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
-
-
-
-
- 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[]
-
-
-
-
- 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
-
-
-
-
- A count of
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of a Billing Item’s active bundled billing items.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of a Billing Item’s active child billing items.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of a Billing Item’s spare pool bundled billing items.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of a history of billing items which a billing item has been associated with.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- A count of a Billing Item’s bundled billing items.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of a Billing Item’s active child billing items.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of this will return any cancellation requests that are associated with this billing item.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of a Billing Item’s child billing items'
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of a Billing Item’s active child billing items.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of for product items which have a downgrade path defined, this will return those product items.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of a Billing Item’s associated child billing items, excluding some items with a $0.00 recurring fee.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of all invoice items associated with the billing item
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of a Billing Item’s child billing items and associated items'
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of a Billing Item’s associated child billing items, excluding ALL items with a $0.00 recurring fee.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- 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
-
-
-
-
- Flag to check if a billing item can be cancelled. 1 = yes. 0 = no.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- The date the billing item was created. You can see this date on the invoice.
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The last time this billing item was charged.
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- The domain name is provided for server billing items.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The hostname is provided for server billing items
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD).
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- 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
-
-
-
-
- The labor fee, if any. This is a one time charge.
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- The rate at which labor fees are taxed if you are a taxable customer.
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- The last time this billing item was charged.
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- The date that a billing item was last modified.
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- The date on which your account will be charged for this billing item.
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- The rate at which one time fees are taxed if you are a taxable customer.
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- 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
-
-
-
-
- This is the package id for this billing item.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The unique identifier of the parent of this billing item.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD).
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- The rate at which recurring fees are taxed if you are a taxable customer.
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- The number of months in which the recurring fees will be incurred.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- This is the service provider for this billing item.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The setup fee, if any. This is a one time charge.
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- The rate at which setup fees are taxed if you are a taxable customer.
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- The account that a billing item belongs to.
-
-
-
-
- Type:
-
-
- SoftLayer_Account
-
-
-
-
- A flag indicating that the billing item is under an active agreement.
-
-
-
-
- Type:
-
-
- SoftLayer_Account_Agreement
-
-
-
-
- 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[]
-
-
-
-
- None
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- A Billing Item’s active bundled billing items.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- A service cancellation request item that corresponds to the billing item.
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item_Cancellation_Request_Item
-
-
-
-
- A Billing Item’s active child billing items.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- None
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- A Billing Item’s spare pool bundled billing items.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- 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
-
-
-
-
- A history of billing items which a billing item has been associated with.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item_Association_History[]
-
-
-
-
- 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[]
-
-
-
-
- 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[]
-
-
-
-
- The bandwidth allocation for a billing item.
-
-
-
-
- Type:
-
-
- SoftLayer_Network_Bandwidth_Version1_Allocation
-
-
-
-
- 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[]
-
-
-
-
- A Billing Item’s bundled billing items.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- A Billing Item’s active child billing items.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- The billing item’s cancellation reason.
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item_Cancellation_Reason
-
-
-
-
- This will return any cancellation requests that are associated with this billing item.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item_Cancellation_Request[]
-
-
-
-
- The item category to which the billing item’s item belongs.
-
-
-
-
- Type:
-
-
- SoftLayer_Product_Item_Category
-
-
-
-
- A Billing Item’s child billing items'
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- A Billing Item’s active child billing items.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- For product items which have a downgrade path defined, this will return those product items.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Product_Item[]
-
-
-
-
- A Billing Item’s associated child billing items, excluding some items with a $0.00 recurring fee.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- A flag that will reflect whether this billing item is billed on an hourly basis or not.
-
-
-
-
- Type:
-
-
- boolean
-
-
-
-
- Invoice items associated with this billing item
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Invoice_Item
-
-
-
-
- All invoice items associated with the billing item
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Invoice_Item[]
-
-
-
-
- The entry in the SoftLayer product catalog that a billing item is based upon.
-
-
-
-
- Type:
-
-
- SoftLayer_Product_Item
-
-
-
-
- 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
-
-
-
-
- A Billing Item’s child billing items and associated items'
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- A Billing Item’s total, including any child billing items if they exist.'
-
-
-
-
- Type:
-
-
- float
-
-
-
-
- A Billing Item’s total, including any child billing items if they exist.'
-
-
-
-
- Type:
-
-
- float
-
-
-
-
- A Billing Item’s total, including any child billing items and associated billing items if they exist.'
-
-
-
-
- Type:
-
-
- float
-
-
-
-
- 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
-
-
-
-
- A Billing Item’s associated child billing items, excluding ALL items with a $0.00 recurring fee.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- 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
-
-
-
-
- The original physical location for this billing item–may differ from current.
-
-
-
-
- Type:
-
-
- SoftLayer_Location
-
-
-
-
- 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
-
-
-
-
- A billing item’s parent item. If a billing item has no parent item then this value is null.
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item
-
-
-
-
- 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
-
-
-
-
- This flag indicates whether a billing item is scheduled to be canceled or not.
-
-
-
-
- Type:
-
-
- boolean
-
-
-
-
- The new order item that will replace this billing item.
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Order_Item
-
-
-
-
- Provisioning transaction for this billing item
-
-
-
-
- Type:
-
-
- SoftLayer_Provisioning_Version1_Transaction
-
-
-
-
- The load balancer’s virtual IP address that the billing item is associated with.
-
-
-
-
- Type:
-
-
- SoftLayer_Network_LoadBalancer_VirtualIpAddress
-
-
-
-
- A friendly description of software component
-
-
-
-
- Type:
-
-
- SoftLayer_Software_Description
-
-
-
-
- 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
-
-
-
-
- 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[]
-
-
-
-
- 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
-
-
-
-
- A count of
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of a Billing Item’s active bundled billing items.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of a Billing Item’s active child billing items.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of a Billing Item’s spare pool bundled billing items.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of a history of billing items which a billing item has been associated with.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- A count of a Billing Item’s bundled billing items.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of a Billing Item’s active child billing items.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of this will return any cancellation requests that are associated with this billing item.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of a Billing Item’s child billing items'
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of a Billing Item’s active child billing items.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of for product items which have a downgrade path defined, this will return those product items.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of a Billing Item’s associated child billing items, excluding some items with a $0.00 recurring fee.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of all invoice items associated with the billing item
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of a Billing Item’s child billing items and associated items'
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of a Billing Item’s associated child billing items, excluding ALL items with a $0.00 recurring fee.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- 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
-
-
-
-
- Flag to check if a billing item can be cancelled. 1 = yes. 0 = no.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- The date the billing item was created. You can see this date on the invoice.
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The last time this billing item was charged.
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- The domain name is provided for server billing items.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The hostname is provided for server billing items
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD).
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- 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
-
-
-
-
- The labor fee, if any. This is a one time charge.
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- The rate at which labor fees are taxed if you are a taxable customer.
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- The last time this billing item was charged.
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- The date that a billing item was last modified.
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- The date on which your account will be charged for this billing item.
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- The rate at which one time fees are taxed if you are a taxable customer.
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- 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
-
-
-
-
- This is the package id for this billing item.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The unique identifier of the parent of this billing item.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD).
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- The rate at which recurring fees are taxed if you are a taxable customer.
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- The number of months in which the recurring fees will be incurred.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- This is the service provider for this billing item.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The setup fee, if any. This is a one time charge.
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- The rate at which setup fees are taxed if you are a taxable customer.
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- The account that a billing item belongs to.
-
-
-
-
- Type:
-
-
- SoftLayer_Account
-
-
-
-
- A flag indicating that the billing item is under an active agreement.
-
-
-
-
- Type:
-
-
- SoftLayer_Account_Agreement
-
-
-
-
- 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[]
-
-
-
-
- None
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- A Billing Item’s active bundled billing items.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- A service cancellation request item that corresponds to the billing item.
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item_Cancellation_Request_Item
-
-
-
-
- A Billing Item’s active child billing items.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- None
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- A Billing Item’s spare pool bundled billing items.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- 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
-
-
-
-
- A history of billing items which a billing item has been associated with.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item_Association_History[]
-
-
-
-
- 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[]
-
-
-
-
- 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[]
-
-
-
-
- The bandwidth allocation for a billing item.
-
-
-
-
- Type:
-
-
- SoftLayer_Network_Bandwidth_Version1_Allocation
-
-
-
-
- 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[]
-
-
-
-
- A Billing Item’s bundled billing items.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- A Billing Item’s active child billing items.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- The billing item’s cancellation reason.
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item_Cancellation_Reason
-
-
-
-
- This will return any cancellation requests that are associated with this billing item.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item_Cancellation_Request[]
-
-
-
-
- The item category to which the billing item’s item belongs.
-
-
-
-
- Type:
-
-
- SoftLayer_Product_Item_Category
-
-
-
-
- A Billing Item’s child billing items'
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- A Billing Item’s active child billing items.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- For product items which have a downgrade path defined, this will return those product items.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Product_Item[]
-
-
-
-
- A Billing Item’s associated child billing items, excluding some items with a $0.00 recurring fee.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- A flag that will reflect whether this billing item is billed on an hourly basis or not.
-
-
-
-
- Type:
-
-
- boolean
-
-
-
-
- Invoice items associated with this billing item
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Invoice_Item
-
-
-
-
- All invoice items associated with the billing item
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Invoice_Item[]
-
-
-
-
- The entry in the SoftLayer product catalog that a billing item is based upon.
-
-
-
-
- Type:
-
-
- SoftLayer_Product_Item
-
-
-
-
- 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
-
-
-
-
- A Billing Item’s child billing items and associated items'
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- A Billing Item’s total, including any child billing items if they exist.'
-
-
-
-
- Type:
-
-
- float
-
-
-
-
- A Billing Item’s total, including any child billing items if they exist.'
-
-
-
-
- Type:
-
-
- float
-
-
-
-
- A Billing Item’s total, including any child billing items and associated billing items if they exist.'
-
-
-
-
- Type:
-
-
- float
-
-
-
-
- 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
-
-
-
-
- A Billing Item’s associated child billing items, excluding ALL items with a $0.00 recurring fee.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item[]
-
-
-
-
- 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
-
-
-
-
- The original physical location for this billing item–may differ from current.
-
-
-
-
- Type:
-
-
- SoftLayer_Location
-
-
-
-
- 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
-
-
-
-
- A billing item’s parent item. If a billing item has no parent item then this value is null.
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item
-
-
-
-
- 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
-
-
-
-
- This flag indicates whether a billing item is scheduled to be canceled or not.
-
-
-
-
- Type:
-
-
- boolean
-
-
-
-
- The new order item that will replace this billing item.
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Order_Item
-
-
-
-
- Provisioning transaction for this billing item
-
-
-
-
- Type:
-
-
- SoftLayer_Provisioning_Version1_Transaction
-
-
-
-
- The IPsec VPN that a network tunnel billing item is associated with.
-
-
-
-
- Type:
-
-
- SoftLayer_Network_Tunnel_Module_Context
-
-
-
-
- A friendly description of software component
-
-
-
-
- Type:
-
-
- SoftLayer_Software_Description
-
-
-
-
- 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
-
-
-
-
- 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[]
-
-
-
-
- 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
-
-
-
-
- A count of
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of a Billing Item’s active bundled billing items.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of a Billing Item’s active child billing items.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of a Billing Item’s spare pool bundled billing items.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of a history of billing items which a billing item has been associated with.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- A count of a Billing Item’s bundled billing items.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of a Billing Item’s active child billing items.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of this will return any cancellation requests that are associated with this billing item.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of a Billing Item’s child billing items'
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of a Billing Item’s active child billing items.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of for product items which have a downgrade path defined, this will return those product items.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of a Billing Item’s associated child billing items, excluding some items with a $0.00 recurring fee.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of all invoice items associated with the billing item
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of a Billing Item’s child billing items and associated items'
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of a Billing Item’s associated child billing items, excluding ALL items with a $0.00 recurring fee.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- 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
-
-
-
-
- Array of server uptime detail containers
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Container_Account_Historical_Summary_Detail[]
-
-
-
-
- The maximum date included in the summary.
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- The minimum date included in the summary.
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- The hardware for uptime details.
-
-
-
-
- Type:
-
-
- SoftLayer_Virtual_Guest
-
-
-
-
- The data associated with a host uptime details.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Metric_Tracking_Object_Data[]
-
-
-
-
- The hardware for uptime details.
-
-
-
-
- Type:
-
-
- SoftLayer_Hardware
-
-
-
-
- The minimum date included in the detail.
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- Array of server uptime detail containers
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Container_Account_Historical_Summary_Detail[]
-
-
-
-
- The maximum date included in the summary.
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- The minimum date included in the summary.
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- This is a unix timestamp that represents the stop date/time for a graph.
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- The front-end or back-end network uplink interface associated with this server.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- This is a human readable name for the server or rack being graphed.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- This is a unix timestamp that represents the begin date/time for a graph.
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- The raw PNG binary data to be displayed once the graph is drawn.
-
-
-
-
- Type:
-
-
- base64Binary
-
-
-
-
- The title that ended up being displayed as part of the graph image.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The maximum date included in this graph.
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- The minimum date included in this graph.
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- Estimated bandwidth usage so far this billing cycle.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- Projected usage for this hardware based on previous usage this billing cycle.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- the text name of the server being monitored.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The minimum date included in this list.
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- The second line in the address of the contact.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The third line in the address of the contact.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The organization name of the contact.
-
-
-
-
- Type:
-
-
- string
-
-
-
- -
The type of contact. The following are the valid types of contacts:
-
-
- Indicates if this is a child of another extended attribute.
-
-
-
-
- Type:
-
-
- boolean
-
-
-
-
- The description of an extended attribute.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The collection of options for an extended attribute.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Option[]
-
-
-
-
- Indicates if extended attribute is required.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- User defined indicates that the value is required from outside sources.
-
-
-
-
- Type:
-
-
- boolean
-
-
-
-
- Extended Attribute that is required for an option.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Container_Dns_Domain_Registration_ExtendedAttribute_Option_Require[]
-
-
-
-
- The name of an extended attribute that is required by an extended attribute option.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The information of the registered domain.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Container_Dns_Domain_Registration_Contact[]
-
-
-
-
- The date that a domain is set to expire.
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- The list of nameservers for the domain.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Container_Dns_Domain_Registration_Nameserver[]
-
-
-
-
- Three-character language tag for the IDN domain that you’re trying to register. This is only required for IDN domains.
-
-
-
-
- Type:
-
-
- string
-
-
-
- -
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.
- - -
-
- The length of the registration period in years. Valid values are 1 – 10.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The list of available and taken domain names.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Container_Dns_Domain_Registration_Lookup_Items[]
-
-
-
-
- The status of the domain name if available and can be registered.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The list of fully qualified names of the nameserver.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Container_Dns_Domain_Registration_Nameserver_List[]
-
-
-
-
- The current status of the verification.
-
-
-
-
- Type:
-
-
- SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status
-
-
-
-
- The adate when the domain will be suspended.
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- The reason why a domain is not transferable.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The status of the latest transfer on the domain.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The date and time of the most recent update to the state of the transfer.
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- Indicates if the domain can be transferred.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- DEPRECATED. ID of the monitoring agent that triggered this alarm
-
-
-
-
- Type:
-
-
- int
-
-
-
Deprecated
- -
-
- The type of network protocol. This can be ftp, ssh and so on.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- Specifies the delimiter to be used when indicating multiple values for a header. Valid delimiter is, a
-
-
- Type:
-
-
- string
-
-
-
-
- The description of modify response header.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- 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[]
-
-
-
-
- The uniqueId of the modify response header to which the existing behavior belongs.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The path, relative to the domain that is accessed via modify response header.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- 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
-
-
-
-
- The uniqueId of the mapping to which the existing behavior belongs.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- Specifies a single character to separate access control list (ACL) fields. The default value is ‘!’.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- The token name. If this value is empty, then it is set to the default value ‘token’.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The path, relative to the domain that is accessed via token authentication.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- Specifies a single character to separate the individual token fields. The default value is ‘~’.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- The uniqueId of the mapping to which the existing behavior belongs.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- A identifier that is unique to purge group.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The Unix timestamp of the last purge.
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- Purge Group name. The favorite group name must be unique, but non-favorite groups do not have this limitation
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- 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
-
-
-
-
- The purge’s status when the input option field is 1 or 3. Status can be SUCCESS, FAILED, or IN_PROGRESS.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- Type of the Purge Group, currently SAVED or UNSAVED.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- A identifier that is unique to domain mapping.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- Purge Group name. The favorite group name must be unique, but un-favorite groups do not have this limitation
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The purge’s status. Status can be SUCCESS, FAILED, or IN_PROGRESS.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- None
-
-
-
-
- Type:
-
-
- SoftLayer_Container_Network_CdnMarketplace_Configuration_Performance_DynamicContentAcceleration
-
-
-
-
- None
-
-
-
-
- Type:
-
-
- SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking
-
-
-
-
- None
-
-
-
-
- Type:
-
-
- SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection
-
-
-
-
- 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
-
-
-
-
- None
-
-
-
-
- Type:
-
-
- SoftLayer_Container_Network_CdnMarketplace_Configuration_Performance_DynamicContentAcceleration
-
-
-
-
- None
-
-
-
-
- Type:
-
-
- SoftLayer_Container_Network_CdnMarketplace_Configuration_Performance_DynamicContentAcceleration
-
-
-
-
- If the file in a directory listing is a directory itself then fileCount is the number of files within the directory.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The name of a directory or a file within a directory listing.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- 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
-
-
-
-
- The width in a video’s width to height aspect ratio
-
-
-
-
- Type:
-
-
- float
-
-
-
-
- The height in a video’s width to height aspect ratio
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- Time to stop showing watermark in milliseconds
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- Filename of image to use as watermark in transcoding job
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- Position to place watermark at
-
-
-
-
- Type:
-
-
- SoftLayer_Container_Network_Media_Transcode_Job_Watermark_Position
-
-
-
-
- Time to start showing watermark in milliseconds
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- Percentage Transparent watermark should be
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The unique id that is used by a Transcode server
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The additional elements for DROPDOWNLIST element
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Container_Network_Media_Transcode_Preset_Element_Option[]
-
-
-
-
- The flag that indicates whether an element is enabled or not
-
-
-
-
- Type:
-
-
- boolean
-
-
-
-
- The extended description of a preset element
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The flag that indicates whether an element is hidden or not
-
-
-
-
- Type:
-
-
- boolean
-
-
-
-
- Line 1 of the address - typically the number and street address the MDMS device will be delivered to
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- First and last name of the customer on the shipping address
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The datacenter name where the MDMS device will be shipped to
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- Name of the company device is being shipped to
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The ID of the SoftLayer_Network_Subnet_Registration object.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The IDs and Subnets of the SoftLayer_Network_Subnet_Registration object.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Container_Network_Subnet_Registration_SubnetReference[]
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- The URL to which PayPal redirects browser after checkout has been canceled before completion of a payment.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- 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
-
-
-
-
- This hash is internally-generated and is used to for tracking order containers.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The currency type chosen at checkout.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- Device Fingerprint Identifier - Optional.
-
-
-
-
- Type:
-
-
- string
-
-
-
Deprecated
- -
-
- This has been deprecated. It is the identifier used to track configurations in legacy order forms.
-
-
-
-
- Type:
-
-
- string
-
-
-
Deprecated
- -
-
- 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
-
-
-
-
- This flag indicates that the customer consented to the GDPR terms for the quote.
-
-
-
-
- Type:
-
-
- boolean
-
-
-
-
- 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[]
-
-
-
-
- An optional virtual disk image template identifier to be used as an installation base for a computing instance order
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- An optional virtual disk image template identifier to be used as an installation base for a computing instance order
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- Flag to identify a “managed” order. This value is set internally.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- 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
- -
-
- 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
-
-
-
-
- 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
-
-
-
-
- A generic message about the order. Does not need to be sent in with any orders.
-
-
-
-
- Type:
-
-
- string
-
-
-
- -
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.
-
- This is deprecated and does not do anything.
-
-
-
-
-
-
- Type:
-
-
- string[]
-
-
-
-
- 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[]
-
-
-
-
- The SoftLayer_Product_Package id for an order container. This is required to place an order.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- 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
-
-
-
-
- The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax.
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- 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
-
-
-
-
- The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax.
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax;
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- The pre-tax setup fee total of the order.
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- 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
-
-
-
-
- A preset configuration id for the package. Is required if not submitting any prices.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- 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[]
-
-
-
-
- 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 to set on replication set servers.
-
-
-
-
-
-
- Type:
-
-
- string[]
-
-
-
-
- Optional promotion code for an order.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- Generic properties.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Container_Product_Order_Property[]
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- 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[]
-
-
-
-
- A custom name to be assigned to the quote.
-
-
-
-
- Type:
-
-
- string
-
-
-
- -
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.
-
- An instance of SoftLayer_Account_Media_Data_Transfer_Request
-
-
-
-
- Type:
-
-
- SoftLayer_Account_Media_Data_Transfer_Request
-
-
-
-
- An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The URL to which PayPal redirects browser after a payment is completed.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- This flag indicates that the quote should be sent to the email address associated with the account or order.
-
-
-
-
- Type:
-
-
- boolean
-
-
-
-
- The number of cores for the server being ordered. This value is set internally.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The token of a requesting service. Do not set.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- An optional computing instance identifier to be used as an installation base for a computing instance order
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- 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[]
-
-
-
-
- An optional parameter for step-based order processing.
-
-
-
-
- Type:
-
-
- int
-
-
-
- -
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.
- - -
-
- 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
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- The total tax portion of the recurring fees.
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- 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[]
-
-
-
-
- An optional flag to use hourly pricing instead of standard monthly pricing.
-
-
-
-
- Type:
-
-
- boolean
-
-
-
-
- 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[]
-
-
-
-
- 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
-
-
-
-
- Flag for identifying an order for Big Data Deployment.
-
-
-
-
- Type:
-
-
- boolean
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- The URL to which PayPal redirects browser after checkout has been canceled before completion of a payment.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- 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
-
-
-
-
- This hash is internally-generated and is used to for tracking order containers.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The currency type chosen at checkout.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- Device Fingerprint Identifier - Optional.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- This has been deprecated. It is the identifier used to track configurations in legacy order forms.
-
-
-
-
- Type:
-
-
- string
-
-
-
Deprecated
- -
-
- 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[]
-
-
-
-
- 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
-
-
-
-
- This flag indicates that the customer consented to the GDPR terms for the quote.
-
-
-
-
- Type:
-
-
- boolean
-
-
-
-
- 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[]
-
-
-
-
- An optional virtual disk image template identifier to be used as an installation base for a computing instance order
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- An optional virtual disk image template identifier to be used as an installation base for a computing instance order
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- Flag to identify a “managed” order. This value is set internally.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- 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[]
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- A generic message about the order. Does not need to be sent in with any orders.
-
-
-
-
- Type:
-
-
- string
-
-
-
- -
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.
-
- This is deprecated and does not do anything.
-
-
-
-
-
-
- Type:
-
-
- string[]
-
-
-
-
- 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[]
-
-
-
-
- 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
-
-
-
-
- The SoftLayer_Product_Package id for an order container. This is required to place an order.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- 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
-
-
-
-
- The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax.
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- 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
-
-
-
-
- The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax.
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax;
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- The pre-tax setup fee total of the order.
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- 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
-
-
-
-
- A preset configuration id for the package. Is required if not submitting any prices.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- 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[]
-
-
-
-
- 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 to set on replication set servers.
-
-
-
-
-
-
- Type:
-
-
- string[]
-
-
-
-
- Flag for identifying a container as Virtual Server (Private Node).
-
-
-
-
- Type:
-
-
- boolean
-
-
-
-
- Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- Optional promotion code for an order.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- Generic properties.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Container_Product_Order_Property[]
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- 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[]
-
-
-
-
- A custom name to be assigned to the quote.
-
-
-
-
- Type:
-
-
- string
-
-
-
- -
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.
-
- The type of a domain registration order. The registration type is Required. Allowed values are new, transfer, and renew
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- An optional resource group identifier specifying the resource group to attach the order to
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- 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
-
-
-
-
- An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The URL to which PayPal redirects browser after a payment is completed.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- This flag indicates that the quote should be sent to the email address associated with the account or order.
-
-
-
-
- Type:
-
-
- boolean
-
-
-
-
- The number of cores for the server being ordered. This value is set internally.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The token of a requesting service. Do not set.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- An optional computing instance identifier to be used as an installation base for a computing instance order
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- 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[]
-
-
-
-
- An optional parameter for step-based order processing.
-
-
-
-
- Type:
-
-
- int
-
-
-
- -
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.
- - -
-
- 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
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- The total tax portion of the recurring fees.
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- 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[]
-
-
-
-
- An optional flag to use hourly pricing instead of standard monthly pricing.
-
-
-
-
- Type:
-
-
- boolean
-
-
-
-
- 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[]
-
-
-
-
- Flag for identifying an order for Big Data Deployment.
-
-
-
-
- Type:
-
-
- boolean
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- The URL to which PayPal redirects browser after checkout has been canceled before completion of a payment.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- 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
-
-
-
-
- This hash is internally-generated and is used to for tracking order containers.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- Amount to be credited to the domain reseller account.
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- The currency type chosen at checkout.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- Device Fingerprint Identifier - Optional.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- This has been deprecated. It is the identifier used to track configurations in legacy order forms.
-
-
-
-
- Type:
-
-
- string
-
-
-
Deprecated
- -
-
- 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
-
-
-
-
- This flag indicates that the customer consented to the GDPR terms for the quote.
-
-
-
-
- Type:
-
-
- boolean
-
-
-
-
- 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[]
-
-
-
-
- An optional virtual disk image template identifier to be used as an installation base for a computing instance order
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- An optional virtual disk image template identifier to be used as an installation base for a computing instance order
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- Flag to identify a “managed” order. This value is set internally.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- 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[]
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- A generic message about the order. Does not need to be sent in with any orders.
-
-
-
-
- Type:
-
-
- string
-
-
-
- -
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.
-
- This is deprecated and does not do anything.
-
-
-
-
-
-
- Type:
-
-
- string[]
-
-
-
-
- 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[]
-
-
-
-
- The SoftLayer_Product_Package id for an order container. This is required to place an order.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- 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
-
-
-
-
- The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax.
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- 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
-
-
-
-
- The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax.
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax;
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- The pre-tax setup fee total of the order.
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- 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
-
-
-
-
- A preset configuration id for the package. Is required if not submitting any prices.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- 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[]
-
-
-
-
- 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 to set on replication set servers.
-
-
-
-
-
-
- Type:
-
-
- string[]
-
-
-
-
- Flag for identifying a container as Virtual Server (Private Node).
-
-
-
-
- Type:
-
-
- boolean
-
-
-
-
- Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- Optional promotion code for an order.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- Generic properties.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Container_Product_Order_Property[]
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- 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[]
-
-
-
-
- A custom name to be assigned to the quote.
-
-
-
-
- Type:
-
-
- string
-
-
-
- -
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.
-
- An optional resource group identifier specifying the resource group to attach the order to
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- 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
-
-
-
-
- An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The URL to which PayPal redirects browser after a payment is completed.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- This flag indicates that the quote should be sent to the email address associated with the account or order.
-
-
-
-
- Type:
-
-
- boolean
-
-
-
-
- The number of cores for the server being ordered. This value is set internally.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The token of a requesting service. Do not set.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- An optional computing instance identifier to be used as an installation base for a computing instance order
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- 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[]
-
-
-
-
- An optional parameter for step-based order processing.
-
-
-
-
- Type:
-
-
- int
-
-
-
- -
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.
- - -
-
- 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
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- The total tax portion of the recurring fees.
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- 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[]
-
-
-
-
- An optional flag to use hourly pricing instead of standard monthly pricing.
-
-
-
-
- Type:
-
-
- boolean
-
-
-
-
- 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[]
-
-
-
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.
- - -
-
- Flag for identifying an order for Big Data Deployment.
-
-
-
-
- Type:
-
-
- boolean
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- The URL to which PayPal redirects browser after checkout has been canceled before completion of a payment.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- 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
-
-
-
-
- This hash is internally-generated and is used to for tracking order containers.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The currency type chosen at checkout.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- Device Fingerprint Identifier - Optional.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- This has been deprecated. It is the identifier used to track configurations in legacy order forms.
-
-
-
-
- Type:
-
-
- string
-
-
-
Deprecated
- -
-
- 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
-
-
-
-
- This flag indicates that the customer consented to the GDPR terms for the quote.
-
-
-
-
- Type:
-
-
- boolean
-
-
-
-
- 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[]
-
-
-
-
- An optional virtual disk image template identifier to be used as an installation base for a computing instance order
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- An optional virtual disk image template identifier to be used as an installation base for a computing instance order
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- Flag to identify a “managed” order. This value is set internally.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- 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[]
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- A generic message about the order. Does not need to be sent in with any orders.
-
-
-
-
- Type:
-
-
- string
-
-
-
- -
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.
-
- This is deprecated and does not do anything.
-
-
-
-
-
-
- Type:
-
-
- string[]
-
-
-
-
- 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[]
-
-
-
-
- The SoftLayer_Product_Package id for an order container. This is required to place an order.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- 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
-
-
-
-
- The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax.
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- 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
-
-
-
-
- The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax.
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax;
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- The pre-tax setup fee total of the order.
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- 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
-
-
-
-
- A preset configuration id for the package. Is required if not submitting any prices.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- 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[]
-
-
-
-
- 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 to set on replication set servers.
-
-
-
-
-
-
- Type:
-
-
- string[]
-
-
-
-
- Flag for identifying a container as Virtual Server (Private Node).
-
-
-
-
- Type:
-
-
- boolean
-
-
-
-
- Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- Optional promotion code for an order.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- Generic properties.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Container_Product_Order_Property[]
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- 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[]
-
-
-
-
- A custom name to be assigned to the quote.
-
-
-
-
- Type:
-
-
- string
-
-
-
- -
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.
-
- An optional resource group identifier specifying the resource group to attach the order to
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- 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
-
-
-
-
- An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The URL to which PayPal redirects browser after a payment is completed.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- This flag indicates that the quote should be sent to the email address associated with the account or order.
-
-
-
-
- Type:
-
-
- boolean
-
-
-
-
- The number of cores for the server being ordered. This value is set internally.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The token of a requesting service. Do not set.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- An optional computing instance identifier to be used as an installation base for a computing instance order
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- 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[]
-
-
-
-
- An optional parameter for step-based order processing.
-
-
-
-
- Type:
-
-
- int
-
-
-
- -
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.
- - -
-
- 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
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- The total tax portion of the recurring fees.
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- 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[]
-
-
-
-
- An optional flag to use hourly pricing instead of standard monthly pricing.
-
-
-
-
- Type:
-
-
- boolean
-
-
-
-
- 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[]
-
-
-
-
- Line 1 of the address - typically the number and street address the MDMS device will be delivered to
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- First and last name of the customer on the shipping address
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The datacenter name where the MDMS device will be shipped to
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- The URL to which PayPal redirects browser after checkout has been canceled before completion of a payment.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- Name of the company device is being shipped to
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- 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
-
-
-
-
- This hash is internally-generated and is used to for tracking order containers.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- Cloud Object Storage Account ID for the data offload destination
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- Cloud Object Storage Bucket for the data offload destination
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The currency type chosen at checkout.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- Device Fingerprint Identifier - Optional.
-
-
-
-
- Type:
-
-
- string
-
-
-
Deprecated
- -
-
- This has been deprecated. It is the identifier used to track configurations in legacy order forms.
-
-
-
-
- Type:
-
-
- string
-
-
-
Deprecated
- -
-
- Default Gateway used for preconfiguring the Eth1 port on the MDMS device to access the user interface
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- Netmask used for preconfiguring the Eth1 port on the MDMS device to access the user interface
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- Static IP Address used for preconfiguring the Eth1 port on the MDMS device to access the user interface
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- Netmask used for preconfiguring the Eth3 port on the MDMS device to enable data transfer
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- Static IP Address used for preconfiguring the Eth3 port on the MDMS device to enable data transfer
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- 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
-
-
-
-
- This flag indicates that the customer consented to the GDPR terms for the quote.
-
-
-
-
- Type:
-
-
- boolean
-
-
-
-
- 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[]
-
-
-
-
- An optional virtual disk image template identifier to be used as an installation base for a computing instance order
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- An optional virtual disk image template identifier to be used as an installation base for a computing instance order
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- Flag to identify a “managed” order. This value is set internally.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- 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
- -
-
- The e-mails of the MDMS key contacts
-
-
-
-
-
-
- Type:
-
-
- string[]
-
-
-
-
- The names of the MDMS key contacts
-
-
-
-
-
-
- Type:
-
-
- string[]
-
-
-
-
- The phone numbers of the MDMS key contacts
-
-
-
-
-
-
- Type:
-
-
- string[]
-
-
-
-
- The roles of the MDMS key contacts
-
-
-
-
-
-
- Type:
-
-
- string[]
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- A generic message about the order. Does not need to be sent in with any orders.
-
-
-
-
- Type:
-
-
- string
-
-
-
- -
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.
-
- This is deprecated and does not do anything.
-
-
-
-
-
-
- Type:
-
-
- string[]
-
-
-
-
- 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[]
-
-
-
-
- The SoftLayer_Product_Package id for an order container. This is required to place an order.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- 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
-
-
-
-
- The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax.
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- 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
-
-
-
-
- The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax.
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax;
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- The pre-tax setup fee total of the order.
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- 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
-
-
-
-
- A preset configuration id for the package. Is required if not submitting any prices.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- 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[]
-
-
-
-
- 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 to set on replication set servers.
-
-
-
-
-
-
- Type:
-
-
- string[]
-
-
-
-
- Optional promotion code for an order.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- Generic properties.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Container_Product_Order_Property[]
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- 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[]
-
-
-
-
- A custom name to be assigned to the quote.
-
-
-
-
- Type:
-
-
- string
-
-
-
- -
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.
-
- Name of the Mass Data Migration Service job request
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The URL to which PayPal redirects browser after a payment is completed.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- This flag indicates that the quote should be sent to the email address associated with the account or order.
-
-
-
-
- Type:
-
-
- boolean
-
-
-
-
- The number of cores for the server being ordered. This value is set internally.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The token of a requesting service. Do not set.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- Shipping address and information where device will be shipped to
-
-
-
-
- Type:
-
-
- SoftLayer_Container_Network_Storage_MassDataMigration_Request_Address
-
-
-
-
- An optional computing instance identifier to be used as an installation base for a computing instance order
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- 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[]
-
-
-
-
- An optional parameter for step-based order processing.
-
-
-
-
- Type:
-
-
- int
-
-
-
- -
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.
- - -
-
- 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
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- The total tax portion of the recurring fees.
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- 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[]
-
-
-
-
- An optional flag to use hourly pricing instead of standard monthly pricing.
-
-
-
-
- Type:
-
-
- boolean
-
-
-
-
- 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[]
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- The URL to which PayPal redirects browser after checkout has been canceled before completion of a payment.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- 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
-
-
-
-
- This hash is internally-generated and is used to for tracking order containers.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The currency type chosen at checkout.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- Device Fingerprint Identifier - Optional.
-
-
-
-
- Type:
-
-
- string
-
-
-
Deprecated
- -
-
- This has been deprecated. It is the identifier used to track configurations in legacy order forms.
-
-
-
-
- Type:
-
-
- string
-
-
-
Deprecated
- -
-
- 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
-
-
-
-
- This flag indicates that the customer consented to the GDPR terms for the quote.
-
-
-
-
- Type:
-
-
- boolean
-
-
-
-
- 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[]
-
-
-
-
- An optional virtual disk image template identifier to be used as an installation base for a computing instance order
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- An optional virtual disk image template identifier to be used as an installation base for a computing instance order
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- Flag to identify a “managed” order. This value is set internally.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- 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
- -
-
- 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
-
-
-
-
- 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
-
-
-
-
- A generic message about the order. Does not need to be sent in with any orders.
-
-
-
-
- Type:
-
-
- string
-
-
-
- -
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.
-
- This is deprecated and does not do anything.
-
-
-
-
-
-
- Type:
-
-
- string[]
-
-
-
-
- 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[]
-
-
-
-
- The SoftLayer_Product_Package id for an order container. This is required to place an order.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- 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
-
-
-
-
- The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax.
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- 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
-
-
-
-
- The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax.
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax;
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- The pre-tax setup fee total of the order.
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- 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
-
-
-
-
- A preset configuration id for the package. Is required if not submitting any prices.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- 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[]
-
-
-
-
- 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 to set on replication set servers.
-
-
-
-
-
-
- Type:
-
-
- string[]
-
-
-
-
- Optional promotion code for an order.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- Generic properties.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Container_Product_Order_Property[]
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- 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[]
-
-
-
-
- A custom name to be assigned to the quote.
-
-
-
-
- Type:
-
-
- string
-
-
-
- -
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.
-
- An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The URL to which PayPal redirects browser after a payment is completed.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- This flag indicates that the quote should be sent to the email address associated with the account or order.
-
-
-
-
- Type:
-
-
- boolean
-
-
-
-
- The number of cores for the server being ordered. This value is set internally.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The token of a requesting service. Do not set.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- An optional computing instance identifier to be used as an installation base for a computing instance order
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- 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[]
-
-
-
-
- An optional parameter for step-based order processing.
-
-
-
-
- Type:
-
-
- int
-
-
-
- -
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.
- - -
-
- 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
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- The total tax portion of the recurring fees.
-
-
-
-
- Type:
-
-
- decimal
-
-
-
-
- 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[]
-
-
-
-
- An optional flag to use hourly pricing instead of standard monthly pricing.
-
-
-
-
- Type:
-
-
- boolean
-
-
-
-
- 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[]
-
-
-
-
- The date that the domain registration will expire.
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- Indicates whether a domain is locked or unlocked.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The SoftLayer customer account that the domain is registered to.
-
-
-
-
- Type:
-
-
- SoftLayer_Account
-
-
-
-
- The domain registration status.
-
-
-
-
- Type:
-
-
- SoftLayer_Dns_Domain_Registration_Status
-
-
-
-
- The registrant verification status.
-
-
-
-
- Type:
-
-
- SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status
-
-
-
[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.
- - -
-
- The description of the registrant verification status.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The unique identifier of the registrant verification status
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The unique keyname of the registrant verification status.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The name of the registrant verification status.
-
-
-
-
- Type:
-
-
- string
-
-
-
[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.
- - -
-
- The description of the domain registration status names.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The unique identifier of the domain registration status
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The unique keyname of the domain registration status.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The data recorded by a tracking object.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Metric_Tracking_Object_Data[]
-
-
-
-
- The identifier of the existing resource this object is attempting to track.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The date this tracker began tracking this particular resource.
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- The type of data that a tracking object polls.
-
-
-
-
- Type:
-
-
- SoftLayer_Metric_Tracking_Object_Type
-
-
-
-
- The data recorded by a tracking object.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Metric_Tracking_Object_Data[]
-
-
-
-
- The identifier of the existing resource this object is attempting to track.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The date this tracker began tracking this particular resource.
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- The virtual storage repository that this tracking object tracks.
-
-
-
-
- Type:
-
-
- SoftLayer_Virtual_Storage_Repository
-
-
-
-
- The type of data that a tracking object polls.
-
-
-
-
- Type:
-
-
- SoftLayer_Metric_Tracking_Object_Type
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- The internal identifier of the network component that backbone is connected to.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- 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
-
-
-
-
- [Deprecated] A backbone’s status.
-
-
-
-
- Type:
-
-
- string
-
-
-
Deprecated
- -
-
- [Deprecated] Which of the SoftLayer datacenters a backbone is connected to.
-
-
-
-
- Type:
-
-
- SoftLayer_Location
-
-
-
Deprecated
- -
-
- [Deprecated] A backbone’s primary network component.
-
-
-
-
- Type:
-
-
- SoftLayer_Network_Component
-
-
-
Deprecated
- -
-
- Bandwidth allotment detail for this hardware.
-
-
-
-
- Type:
-
-
- SoftLayer_Network_Bandwidth_Version1_Allotment_Detail
-
-
-
-
- SoftLayer account to which the CDN account belongs.
-
-
-
-
- Type:
-
-
- SoftLayer_Account
-
-
-
Deprecated
- -
-
- An associated parent billing item which is active.
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item
-
-
-
Deprecated
- -
-
- Time interval after which purge will occur repeatedly
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The maximum number of hosts that a global load balancer account is allowed to have.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The average amount of connections per second used within the current billing cycle. This number is updated daily.
-
-
-
-
- Type:
-
-
- float
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- The hostname of a global load balancer account that is being load balanced.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The unique identifier of a global load balancer account.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The identifier of the load balance method for a global load balancer account.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- Additional customer defined information for a global load balancer account.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- Your SoftLayer customer account.
-
-
-
-
- Type:
-
-
- SoftLayer_Account
-
-
-
-
- The current billing item for a Global Load Balancer account.
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item
-
-
-
-
- The hosts in the load balancing pool for a global load balancer account.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Network_LoadBalancer_Global_Host[]
-
-
-
-
- The load balance method of a global load balancer account
-
-
-
-
- Type:
-
-
- SoftLayer_Network_LoadBalancer_Global_Type
-
-
-
-
- A flag indicating that the global load balancer is a managed resource.
-
-
-
-
- Type:
-
-
- boolean
-
-
-
-
- A count of the hosts in the load balancing pool for a global load balancer account.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- The IP address of the host that will be returned by the global load balancers in response to a dns request.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The port of the host that will be used for health checks.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- Whether the host is enabled or not. The value can be ‘0’ for disabled, or ‘1’ for enabled.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The health check type of a host. Valid values include ’none’, ‘http’, and ’tcp’.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The number of times the host was selected by the load balance method.
-
-
-
-
- Type:
-
-
- float
-
-
-
-
- The unique identifier of a global load balancer host.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- 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
-
-
-
-
- The location of a host in a datacenter.serverRoom format.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- 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
-
-
-
-
- The load balance weight of a host. The total weight of all hosts in the load balancing pool must not exceed 100.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The global load balancer account a host belongs to.
-
-
-
-
- Type:
-
-
- SoftLayer_Network_LoadBalancer_Global_Account
-
-
-
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.
- - -
-
- The internal identifier of a SoftLayer account
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The SoftLayer account information
-
-
-
-
- Type:
-
-
- SoftLayer_Account
-
-
-
-
- Transcode jobs
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Network_Media_Transcode_Job[]
-
-
-
-
- The auto-deletion duration in seconds. This value determines how long the input file will be kept on the storage.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The internal identifier of SoftLayer account
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The unique id of a pre-defined output format
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The name of a transcode output preset
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The internal identifier of a transcode status
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The internal identifier of the user who created a transcode job
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- Watermark to apply to job
-
-
-
-
- Type:
-
-
- SoftLayer_Container_Network_Media_Transcode_Job_Watermark
-
-
-
-
- None
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Network_Media_Transcode_Job_History[]
-
-
-
-
- The transcode service account
-
-
-
-
- Type:
-
-
- SoftLayer_Network_Media_Transcode_Account
-
-
-
-
- The status information of a transcode job
-
-
-
-
- Type:
-
-
- SoftLayer_Network_Media_Transcode_Job_Status
-
-
-
-
- The SoftLayer user that created the transcode job
-
-
-
-
- Type:
-
-
- SoftLayer_User_Customer
-
-
-
-
- The internal identifier of a transcode job
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The description of a transcode job status
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The date that a service’s status was created.
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- The date that a service’s status was last changed.
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- A service’s location.
-
-
-
-
- Type:
-
-
- SoftLayer_Location
-
-
-
Deprecated
- -
-
- The status portion of a service/status relationship.
-
-
-
-
- Type:
-
-
- SoftLayer_Network_Service_Health_Status
-
-
-
Deprecated
- -
-
- The status of a SoftLayer service. This is typically “Up” or “Down”.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- SoftLayer_Locale_Country Id.
-
-
-
-
- Type:
-
-
- SoftLayer_Locale_Country
-
-
-
-
- Location Group ID of CleverSafe cross region.
-
-
-
-
- Type:
-
-
- SoftLayer_Location_Group
-
-
-
-
- The address id of address assigned to this request.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The account to which the request belongs.
-
-
-
-
- Type:
-
-
- SoftLayer_Account
-
-
-
-
- The active tickets that are attached to the MDMS request.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Ticket[]
-
-
-
-
- The customer address where the device is shipped to.
-
-
-
-
- Type:
-
-
- SoftLayer_Account_Address
-
-
-
-
- An associated parent billing item which is active. Includes billing items which are scheduled to be cancelled in the future.
-
-
-
-
- Type:
-
-
- SoftLayer_Billing_Item
-
-
-
-
- The employee user who created the request.
-
-
-
-
- Type:
-
-
- SoftLayer_User_Employee
-
-
-
-
- The customer user who created the request.
-
-
-
-
- Type:
-
-
- SoftLayer_User_Customer
-
-
-
-
- The device configurations.
-
-
-
-
- Type:
-
-
- SoftLayer_Network_Storage_MassDataMigration_Request_DeviceConfiguration
-
-
-
-
- The model of device assigned to this request.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The key contacts for this requests.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact[]
-
-
-
-
- The employee who last modified the request.
-
-
-
-
- Type:
-
-
- SoftLayer_User_Employee
-
-
-
-
- The customer user who last modified the request.
-
-
-
-
- Type:
-
-
- SoftLayer_User_Customer
-
-
-
-
- The shipments of the request.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Account_Shipment[]
-
-
-
-
- The status of the request.
-
-
-
-
- Type:
-
-
- SoftLayer_Network_Storage_MassDataMigration_Request_Status
-
-
-
-
- Ticket that is attached to this mass data migration request.
-
-
-
-
- Type:
-
-
- SoftLayer_Ticket
-
-
-
-
- All tickets that are attached to the mass data migration request.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Ticket[]
-
-
-
-
- A count of the active tickets that are attached to the MDMS request.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of the key contacts for this requests.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of the shipments of the request.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of all tickets that are attached to the mass data migration request.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- The eth1 gateway for connecting to private network in datacenter.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The eth1 IP address for connecting to private network in datacenter.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The eth1 netmask for connecting to private network in datacenter.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The eth3 gateway for connecting to private network at customer’s location.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The eth3 IP address for connecting to private network at customer location.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The eth3 netmask for connecting to private network in at customer’s location.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The password for configuring network share.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The pool lock password for configuring network share.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The username for configuring network share.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The request this device configurations belongs to.
-
-
-
-
- Type:
-
-
- SoftLayer_Network_Storage_MassDataMigration_Request
-
-
-
-
- The storage account to use for this request.
-
-
-
-
- Type:
-
-
- SoftLayer_Network_Storage_Hub_Cleversafe_Account
-
-
-
-
- An account number that is linked to a KeyContact.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The date a KeyContact was last modified.
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- A request id that is linked to a KeyContact.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The request this key contact belongs to.
-
-
-
-
- Type:
-
-
- SoftLayer_Account
-
-
-
-
- The request this key contact belongs to.
-
-
-
-
- Type:
-
-
- SoftLayer_Network_Storage_MassDataMigration_Request
-
-
-
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.
- - -
-
- The registration object’s associated SoftLayer_Account id
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The RIR-specific handle or name of the registered subnet. This field is read-only.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The base IP address of the registered subnet
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The registration object’s associated SoftLayer_Account_Rwhois_Handle id
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The registration object’s associated SoftLayer_Network_Regional_Internet_Registry id
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The registration object’s associated SoftLayer_Network_Subnet_Registration_Status id
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- [Deprecated] The account that this registration belongs to.
-
-
-
-
- Type:
-
-
- SoftLayer_Account
-
-
-
Deprecated
- -
-
- [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
- -
-
- [Deprecated] The related registration events.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Network_Subnet_Registration_Event[]
-
-
-
Deprecated
- -
-
- [Deprecated] The “network” detail object.
-
-
-
-
- Type:
-
-
- SoftLayer_Account_Regional_Registry_Detail
-
-
-
Deprecated
- -
-
- [Deprecated] The “person” detail object.
-
-
-
-
- Type:
-
-
- SoftLayer_Account_Regional_Registry_Detail
-
-
-
Deprecated
- -
-
- [Deprecated] The related Regional Internet Registry.
-
-
-
-
- Type:
-
-
- SoftLayer_Network_Regional_Internet_Registry
-
-
-
Deprecated
- -
-
- [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
- -
-
- [Deprecated] The status of this registration.
-
-
-
-
- Type:
-
-
- SoftLayer_Network_Subnet_Registration_Status
-
-
-
Deprecated
- -
-
- [Deprecated] The subnet that this registration pertains to.
-
-
-
-
- Type:
-
-
- SoftLayer_Network_Subnet
-
-
-
Deprecated
- -
-
- A count of [Deprecated] The cross-reference records that tie the SoftLayer_Account_Regional_Registry_Detail objects to the registration object.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of [Deprecated] The related registration events.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
The APNIC subnet registration type has been deprecated.
-APNIC-specific registration object. For more detail see SoftLayer_Network_Subnet_Registration.
- - -
-
- The registration object’s associated SoftLayer_Account id
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The RIR-specific handle or name of the registered subnet. This field is read-only.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The base IP address of the registered subnet
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The registration object’s associated SoftLayer_Account_Rwhois_Handle id
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The registration object’s associated SoftLayer_Network_Regional_Internet_Registry id
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The registration object’s associated SoftLayer_Network_Subnet_Registration_Status id
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- [Deprecated] The account that this registration belongs to.
-
-
-
-
- Type:
-
-
- SoftLayer_Account
-
-
-
Deprecated
- -
-
- [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
- -
-
- [Deprecated] The related registration events.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Network_Subnet_Registration_Event[]
-
-
-
Deprecated
- -
-
- [Deprecated] The “network” detail object.
-
-
-
-
- Type:
-
-
- SoftLayer_Account_Regional_Registry_Detail
-
-
-
Deprecated
- -
-
- [Deprecated] The “person” detail object.
-
-
-
-
- Type:
-
-
- SoftLayer_Account_Regional_Registry_Detail
-
-
-
Deprecated
- -
-
- [Deprecated] The related Regional Internet Registry.
-
-
-
-
- Type:
-
-
- SoftLayer_Network_Regional_Internet_Registry
-
-
-
Deprecated
- -
-
- [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
- -
-
- [Deprecated] The status of this registration.
-
-
-
-
- Type:
-
-
- SoftLayer_Network_Subnet_Registration_Status
-
-
-
Deprecated
- -
-
- [Deprecated] The subnet that this registration pertains to.
-
-
-
-
- Type:
-
-
- SoftLayer_Network_Subnet
-
-
-
Deprecated
- -
-
- A count of [Deprecated] The cross-reference records that tie the SoftLayer_Account_Regional_Registry_Detail objects to the registration object.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of [Deprecated] The related registration events.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
The ARIN subnet registration type has been deprecated.
-ARIN-specific registration object. For more detail see SoftLayer_Network_Subnet_Registration.
- - -
-
- The registration object’s associated SoftLayer_Account id
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The RIR-specific handle or name of the registered subnet. This field is read-only.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The base IP address of the registered subnet
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The registration object’s associated SoftLayer_Account_Rwhois_Handle id
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The registration object’s associated SoftLayer_Network_Regional_Internet_Registry id
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The registration object’s associated SoftLayer_Network_Subnet_Registration_Status id
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- [Deprecated] The account that this registration belongs to.
-
-
-
-
- Type:
-
-
- SoftLayer_Account
-
-
-
Deprecated
- -
-
- [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
- -
-
- [Deprecated] The related registration events.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Network_Subnet_Registration_Event[]
-
-
-
Deprecated
- -
-
- [Deprecated] The “network” detail object.
-
-
-
-
- Type:
-
-
- SoftLayer_Account_Regional_Registry_Detail
-
-
-
Deprecated
- -
-
- [Deprecated] The “person” detail object.
-
-
-
-
- Type:
-
-
- SoftLayer_Account_Regional_Registry_Detail
-
-
-
Deprecated
- -
-
- [Deprecated] The related Regional Internet Registry.
-
-
-
-
- Type:
-
-
- SoftLayer_Network_Regional_Internet_Registry
-
-
-
Deprecated
- -
-
- [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
- -
-
- [Deprecated] The status of this registration.
-
-
-
-
- Type:
-
-
- SoftLayer_Network_Subnet_Registration_Status
-
-
-
Deprecated
- -
-
- [Deprecated] The subnet that this registration pertains to.
-
-
-
-
- Type:
-
-
- SoftLayer_Network_Subnet
-
-
-
Deprecated
- -
-
- A count of [Deprecated] The cross-reference records that tie the SoftLayer_Account_Regional_Registry_Detail objects to the registration object.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of [Deprecated] The related registration events.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
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.
- - -
-
- Numeric ID of the related SoftLayer_Account_Regional_Registry_Detail object
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- Numeric ID of the related SoftLayer_Network_Subnet_Registration object
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- [Deprecated] The related SoftLayer_Account_Regional_Registry_Detail.
-
-
-
-
- Type:
-
-
- SoftLayer_Account_Regional_Registry_Detail
-
-
-
Deprecated
- -
-
- [Deprecated] The related SoftLayer_Network_Subnet_Registration.
-
-
-
-
- Type:
-
-
- SoftLayer_Network_Subnet_Registration
-
-
-
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. *
- - -
-
- A string message indicating what took place during this event
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The numeric ID of the related SoftLayer_Network_Subnet_Registration object
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The numeric ID of the associated SoftLayer_Network_Subnet_Registration_Event_Type object
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- [Deprecated] The registration this event pertains to.
-
-
-
-
- Type:
-
-
- SoftLayer_Network_Subnet_Registration
-
-
-
Deprecated
- -
-
- [Deprecated] The type of this event.
-
-
-
-
- Type:
-
-
- SoftLayer_Network_Subnet_Registration_Event_Type
-
-
-
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:
-
- Code-friendly string name of the event type
-
-
-
-
- Type:
-
-
- string
-
-
-
The RIPE subnet registration type has been deprecated.
-RIPE-specific registration object. For more detail see SoftLayer_Network_Subnet_Registration.
- - -
-
- The registration object’s associated SoftLayer_Account id
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The RIR-specific handle or name of the registered subnet. This field is read-only.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The base IP address of the registered subnet
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The registration object’s associated SoftLayer_Account_Rwhois_Handle id
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The registration object’s associated SoftLayer_Network_Regional_Internet_Registry id
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The registration object’s associated SoftLayer_Network_Subnet_Registration_Status id
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- [Deprecated] The account that this registration belongs to.
-
-
-
-
- Type:
-
-
- SoftLayer_Account
-
-
-
Deprecated
- -
-
- [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
- -
-
- [Deprecated] The related registration events.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Network_Subnet_Registration_Event[]
-
-
-
Deprecated
- -
-
- [Deprecated] The “network” detail object.
-
-
-
-
- Type:
-
-
- SoftLayer_Account_Regional_Registry_Detail
-
-
-
Deprecated
- -
-
- [Deprecated] The “person” detail object.
-
-
-
-
- Type:
-
-
- SoftLayer_Account_Regional_Registry_Detail
-
-
-
Deprecated
- -
-
- [Deprecated] The related Regional Internet Registry.
-
-
-
-
- Type:
-
-
- SoftLayer_Network_Regional_Internet_Registry
-
-
-
Deprecated
- -
-
- [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
- -
-
- [Deprecated] The status of this registration.
-
-
-
-
- Type:
-
-
- SoftLayer_Network_Subnet_Registration_Status
-
-
-
Deprecated
- -
-
- [Deprecated] The subnet that this registration pertains to.
-
-
-
-
- Type:
-
-
- SoftLayer_Network_Subnet
-
-
-
Deprecated
- -
-
- A count of [Deprecated] The cross-reference records that tie the SoftLayer_Account_Regional_Registry_Detail objects to the registration object.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- A count of [Deprecated] The related registration events.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
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:
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.
- - -
-
- 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
-
-
-
-
- An account’s RWHOIS data’s associated account identifier.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The first line of the mailing address associated with an account’s RWHOIS data.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The second line of the mailing address associated with an account’s RWHOIS data.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The city of the mailing address associated with an account’s RWHOIS data.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The company name associated with an account’s RWHOIS data.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- A two-letter abbreviation of the country of the mailing address associated with an account’s RWHOIS data.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The date an account’s RWHOIS data was created.
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- The first name associated with an account’s RWHOIS data.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The last name associated with an account’s RWHOIS data.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The date an account’s RWHOIS data was last modified.
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- The postal code of the mailing address associated with an account’s RWHOIS data.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- Whether an account’s RWHOIS data refers to a private residence or not.
-
-
-
-
- Type:
-
-
- boolean
-
-
-
-
- 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
-
-
-
-
- The SoftLayer customer account associated with this reverse WHOIS data.
-
-
-
-
- Type:
-
-
- SoftLayer_Account
-
-
-
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:
-
-
- A Name describing which state a SWIP transaction is in.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- ID Number of the Subnet for this SWIP transaction.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The Account whose RWHOIS data was used to SWIP this subnet
-
-
-
-
- Type:
-
-
- SoftLayer_Account
-
-
-
-
- The subnet that this SWIP transaction was created for.
-
-
-
-
- Type:
-
-
- SoftLayer_Network_Subnet
-
-
-
-
- The internal identifier of an item that is attached to a ticket.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The date that an item was attached to a ticket.
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- The internal identifier of the ticket that an item is attached to.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The Mass Data Migration request that is attached to a ticket.
-
-
-
-
- Type:
-
-
- SoftLayer_Network_Storage_MassDataMigration_Request
-
-
-
-
- The Mass Data Migration request that is attached to a ticket.
-
-
-
-
- Type:
-
-
- SoftLayer_Network_Storage_MassDataMigration_Request
-
-
-
-
- The ticket that an item is attached to.
-
-
-
-
- Type:
-
-
- SoftLayer_Ticket
-
-
-
-
- messageId of Citrix account validation response.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- status message of Citrix account validation.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- messageId of Citrix account validation response.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- status message of Citrix account validation.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The account ID to which the deployment belongs.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- Topology used for the Citrix Virtual Apps And Desktop deployment.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The date when this record was created.
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- The date when this record was last modified.
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- The SoftLayer_Workload_Citrix_Deployment_Status of the deployment.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The SoftLayer_Workload_Citrix_Deployment_Type of the deployment.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- The identifier for the customer who placed the CVAD order.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- It is an internal identifier for the VMware solution. It gets set if the CVAD order is for VMware.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The SoftLayer_Account to which the deployment belongs.
-
-
-
-
- Type:
-
-
- SoftLayer_Account
-
-
-
-
- It contains a collection of items under the CVAD deployment.
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Workload_Citrix_Deployment_Resource[]
-
-
-
-
- Current Status of the CVAD deployment.
-
-
-
-
- Type:
-
-
- SoftLayer_Workload_Citrix_Deployment_Status
-
-
-
-
- It shows if the deployment is for Citrix Hypervisor or VMware.
-
-
-
-
- Type:
-
-
- SoftLayer_Workload_Citrix_Deployment_Type
-
-
-
-
- It is the SoftLayer_User_Customer who placed the order for CVAD.
-
-
-
-
- Type:
-
-
- SoftLayer_User_Customer
-
-
-
-
- It is the VLAN resource for the CVAD deployment.
-
-
-
-
- Type:
-
-
- SoftLayer_Network_Vlan
-
-
-
-
- A count of it contains a collection of items under the CVAD deployment.
-
-
-
-
- Type:
-
-
- unsignedLong
-
-
-
-
- The point in time at which the resource was ordered.
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- The last time when the resource was modified.
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- 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
-
-
-
-
- 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
-
-
-
-
- None
-
-
-
-
- Type:
-
-
- SoftLayer_Workload_Citrix_Deployment_Resource_Role
-
-
-
-
- Represents the hardware resource of the CVAD deployment.
-
-
-
-
- Type:
-
-
- SoftLayer_Hardware
-
-
-
-
- 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
-
-
-
-
- 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 resource for the CVAD deployment.
-
-
-
-
- Type:
-
-
- SoftLayer_Network_Storage
-
-
-
-
- Represents the subnet resource of the CVAD deployment.
-
-
-
-
- Type:
-
-
- SoftLayer_Network_Subnet
-
-
-
-
- It contains the category of the item which is set for the current response.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- VSI resource for the CVAD deployment.
-
-
-
-
- Type:
-
-
- SoftLayer_Virtual_Guest
-
-
-
-
- Represents the VLAN resource of the CVAD deployment.
-
-
-
-
- Type:
-
-
- SoftLayer_Network_Vlan
-
-
-
-
- The account ID to which the deployment belongs.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- Topology used for the CVAD deployment
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The date when this deployment was created.
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- The date when this deployment was modified.
-
-
-
-
- Type:
-
-
- dateTime
-
-
-
-
- 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 of the deployment.
-
-
-
-
- Type:
-
-
- SoftLayer_Workload_Citrix_Deployment_Status
-
-
-
-
- Represents if the deployment is for Citrix Hypervisor or VMware
-
-
-
-
- Type:
-
-
- SoftLayer_Workload_Citrix_Deployment_Type
-
-
-
-
- The identifier for the customer who placed the CVAD order.
-
-
-
-
- Type:
-
-
- int
-
-
-
-
- It is an internal identifier for the VMware solution. It gets set if the CVAD order is for VMware.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The description of the deployment status.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The active directory domain name
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The active directory netbios name (optional)
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The active directory safe mode password
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The active directory topology
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The Citrix resource location name
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The default domain to be used for all server orders where the domain is not specified.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The specific SoftLayer_Location_Datacenter id where the order should be provisioned.
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- 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[]
-
-
-
-
- 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
-
-
-
-
- The name of the product (e.g. vcenter, nsx, vsphere, vsan)
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The size of the storage (e.g. STORAGE_SPACE_FOR_2_IOPS_PER_GB)
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The domain for the ordered hosts (e.g. example.org)
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- Customer provided license keys (optional)
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Workload_Citrix_Workspace_Order_LicenseKey[]
-
-
-
-
- The bare metal shared nfs storage (optional)
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Workload_Citrix_Workspace_Order_SharedStorage[]
-
-
-
-
- The subdomain for the ordered hosts (e.g. corp).
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The vSphere version. Valid values are: “6.7” and “7.0”
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- The bare metal vsan cache disks (optional)
-
-
-
-
-
-
- Type:
-
-
- string[]
-
-
-
-
- the id of the resource (HARDWARE, GUEST, VLAN, SUBNET, VMWARE)
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- the name associated with the resource (e.g. name, hostname)
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- the type of resource (HARDWARE, GUEST, NETWORK_VLAN, SUBNET)
-
-
-
-
- Type:
-
-
- string
-
-
-
-
- identification and operation result for each item
-
-
-
-
-
-
- Type:
-
-
- SoftLayer_Workload_Citrix_Workspace_Response[]
-
-
-
- Returns the average disk usage for all archive repositories for the timeframe based on the parameters provided. -
-| Name | -Type | -Description | -
|---|---|---|
| startDateTime | - -dateTime | - -datetime of the start date of the graph | -
| endDateTime | - -dateTime | - -datetime of the ending date of the graph | -
None
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [dateTime, dateTime]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account/getAverageArchiveUsageMetricDataByDate'
-- Returns the average disk usage for all public repositories for the timeframe based on the parameters provided. -
-| Name | -Type | -Description | -
|---|---|---|
| startDateTime | - -dateTime | - -datetime of the start date of the graph | -
| endDateTime | - -dateTime | - -datetime of the ending date of the graph | -
None
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [dateTime, dateTime]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account/getAveragePublicUsageMetricDataByDate'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account/{SoftLayer_AccountID}/getDomainRegistrations'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account/{SoftLayer_AccountID}/getGlobalLoadBalancerAccounts'
--
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.
- - -| Name | -Type | -Description | -
|---|---|---|
| numberOfHosts | - -int | - -Number of hosts to adjust the current server count by | -
| locationId | - -int | - -Deprecated | -
None
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [int, int]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account/getLargestAllowedSubnetCidr'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account/{SoftLayer_AccountID}/getLegacyBandwidthAllotments'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account/{SoftLayer_AccountID}/getMediaDataTransferRequests'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account/{SoftLayer_AccountID}/getMetricTrackingObject'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account/{SoftLayer_AccountID}/getNextBillingPublicAllotmentHardwareBandwidthDetails'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account/{SoftLayer_AccountID}/getOpenStackAccountLinks'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account/{SoftLayer_AccountID}/getOpenStackObjectStorage'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account/{SoftLayer_AccountID}/getPrivateAllotmentHardwareBandwidthDetails'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account/{SoftLayer_AccountID}/getPublicAllotmentHardwareBandwidthDetails'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account/{SoftLayer_AccountID}/getRwhoisData'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account/{SoftLayer_AccountID}/getSubnetRegistrationDetails'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account/{SoftLayer_AccountID}/getSubnetRegistrations'
-- -
-None
- - - - - - - - - - - -- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account/{SoftLayer_AccountID}/getVdrUpdatesInProgressFlag'
-- -
-| Name | -Type | -Description | -
|---|---|---|
| startDateTime | - -string | - -- |
| endDateTime | - -string | - -- |
| accountId | - -int | - -Unused, necessary to keep API contract with parent. | -
None
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'
-- -
-| Name | -Type | -Description | -
|---|---|---|
| startDateTime | - -string | - -- |
| endDateTime | - -string | - -- |
| accountId | - -int | - -Unused, necessary to keep API contract with parent method. | -
None
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'
-- -
-| Name | -Type | -Description | -
|---|---|---|
| configurationValueId | - -int | - -- |
| startDateTime | - -string | - -- |
| endDateTime | - -string | - -- |
None
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'
-- -
-| Name | -Type | -Description | -
|---|---|---|
| configurationValueId | - -int | - -- |
| startDate | - -string | - -format: YYYY-MM-DD (2008-11-01) | -
| endDate | - -string | - -format: YYYY-MM-DD (2008-11-01) | -
None
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'
-- -
-| Name | -Type | -Description | -
|---|---|---|
| configurationValueId | - -int | - -- |
| startDateTime | - -string | - -- |
| endDateTime | - -string | - -- |
None
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'
-- -
-| Name | -Type | -Description | -
|---|---|---|
| configurationValueId | - -int | - -- |
| startDate | - -string | - -format: YYYY-MM-DD (2008-11-01) | -
| endDate | - -string | - -format: YYYY-MM-DD (2008-11-01) | -
None
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'
-- -
-| Name | -Type | -Description | -
|---|---|---|
| request | - - -SoftLayer_Account_Link_OpenStack_LinkRequest | - -- |
None
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'
-- -
-| Name | -Type | -Description | -
|---|---|---|
| request | - - -SoftLayer_Account_Link_OpenStack_LinkRequest | - -- |
None
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'
-- -
-| Name | -Type | -Description | -
|---|---|---|
| domainId | - -string | - -- |
None
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Link_OpenStack/deleteOSDomain'
-- -
-| Name | -Type | -Description | -
|---|---|---|
| projectId | - -string | - -- |
None
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Link_OpenStack/deleteOSProject'
-- Remove an account link. -
-None
- - - - - - - - - - - -None
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'
-- -
-None
- - - - - - - - - - - -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'
-- -
-| Name | -Type | -Description | -
|---|---|---|
| projectId | - -string | - -- |
None
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Link_OpenStack/getOSProject'
-- Retrieve a SoftLayer_Account_Link_OpenStack record. -
-None
- - - - - - - - - - - -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'
-- -
-None
- - - - - - - - - - - -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'
-Remove an account link.
- -Retrieve a SoftLayer_Account_Link_OpenStack record.
- -- -
-None
- - - - - - - - - - - -None
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Link_OpenStack/listOSProjects'
-- Edit a media. -
-| Name | -Type | -Description | -
|---|---|---|
| templateObject | - - -SoftLayer_Account_Media | - -A skeleton SoftLayer_Account_Media object with only the properties defined that you wish to change. Unchanged properties are left alone. | -
None
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'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Media/{SoftLayer_Account_MediaID}/getAccount'
-- Retrieve a list supported media types. -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Media/getAllMediaTypes'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Media/{SoftLayer_Account_MediaID}/getCreateUser'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Media/{SoftLayer_Account_MediaID}/getDatacenter'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Media/{SoftLayer_Account_MediaID}/getModifyEmployee'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Media/{SoftLayer_Account_MediaID}/getModifyUser'
-- Retrieve a SoftLayer_Account_Media record. -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Media/{SoftLayer_Account_MediaID}/getObject'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Media/{SoftLayer_Account_MediaID}/getRequest'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Media/{SoftLayer_Account_MediaID}/getType'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Media/{SoftLayer_Account_MediaID}/getVolume'
-Edit a media.
- -The account to which the media belongs.
- -Retrieve a list supported media types.
- -The customer user who created the media object.
- -The datacenter where the media resides.
- -The employee who last modified the media.
- -The customer user who last modified the media.
- -Retrieve a SoftLayer_Account_Media record.
- -The request to which the media belongs.
- -The media’s type.
- -A guest’s associated EVault network storage service account.
- -Remove a media from a SoftLayer account’s list of media.
- -- Remove a media from a SoftLayer account’s list of media. -
-| Name | -Type | -Description | -
|---|---|---|
| mediaTemplate | - - -SoftLayer_Account_Media | - -A template of the media to be hidden from the available media list. | -
None
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'
-- Edit a data transfer request. -
-| Name | -Type | -Description | -
|---|---|---|
| templateObject | - - -SoftLayer_Account_Media_Data_Transfer_Request | - -A skeleton SoftLayer_Account_Media_Data_Transfer_Request object with only the properties defined that you wish to change. Unchanged properties are left alone. | -
None
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'
-- -
-None
- - - - - - - - - - - -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'
-- -
-None
- - - - - - - - - - - -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'
-- Retrieves a list of all the possible statuses to which a request may be set. -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Media_Data_Transfer_Request/getAllRequestStatuses'
-- -
-None
- - - - - - - - - - - -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'
-- -
-None
- - - - - - - - - - - -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'
-- -
-None
- - - - - - - - - - - -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'
-- -
-None
- - - - - - - - - - - -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'
-- -
-None
- - - - - - - - - - - -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'
-- Retrieve a SoftLayer_Account_Media_Data_Transfer_Request record. -
-None
- - - - - - - - - - - -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'
-- -
-None
- - - - - - - - - - - -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'
-- -
-None
- - - - - - - - - - - -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'
-- -
-None
- - - - - - - - - - - -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'
-Edit a data transfer request.
- -The account to which the request belongs.
- -The active tickets that are attached to the data transfer request.
- -Retrieves a list of all the possible statuses to which a request may be set.
- -The billing item for the original request.
- -The customer user who created the request.
- -The media of the request.
- -The employee who last modified the request.
- -The customer user who last modified the request.
- -Retrieve a SoftLayer_Account_Media_Data_Transfer_Request record.
- -The shipments of the request.
- -The status of the request.
- -All tickets that are attached to the data transfer request.
- -- [Deprecated] Create a new detail object -
-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 regionalInternetRegistryHandleId | Name | -Type | -Description | -
|---|---|---|
| templateObject | - - -SoftLayer_Account_Regional_Registry_Detail | - -The SoftLayer_Account_Regional_Registry_Detail object that you wish to create. | -
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'
-- [Deprecated] Delete an existing detail object -
-The subnet registration detail service has been deprecated.
-This method will delete an existing SoftLayer_Account_Regional_Registry_Detail object.
- - -None
- - - - - - - - - - - -None
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'
-- [Deprecated] Edit an existing detail object -
-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.
- - -| Name | -Type | -Description | -
|---|---|---|
| templateObject | - - -SoftLayer_Account_Regional_Registry_Detail | - -A skeleton SoftLayer_Account_Regional_Registry_Detail object with only the properties defined that you wish to change. Unchanged properties are left alone. | -
None
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'
-- -
-None
- - - - - - - - - - - -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'
-- -
-None
- - - - - - - - - - - -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'
-- -
-None
- - - - - - - - - - - -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'
-- Retrieve a SoftLayer_Account_Regional_Registry_Detail record. -
-None
- - - - - - - - - - - -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'
-- -
-None
- - - - - - - - - - - -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'
-- -
-None
- - - - - - - - - - - -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'
-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.
- - -[Deprecated] Create a new detail object
- -[Deprecated] Delete an existing detail object
- -[Deprecated] Edit an existing detail object
- -[Deprecated] The account that this detail object belongs to.
- -[Deprecated] The associated type of this detail object.
- -[Deprecated] References to the SoftLayer_Network_Subnet_Registration that consume this detail object.
- -Retrieve a SoftLayer_Account_Regional_Registry_Detail record.
- -[Deprecated] The individual properties that define this detail object’s values.
- -[Deprecated] The associated RWhois handle of this detail object. Used only when detailed reassignments are necessary.
- -[Deprecated] Create a transaction to update the registrations that reference this detail object.
- -[Deprecated] Validate an existing person detail object.
- -- [Deprecated] Create a transaction to update the registrations that reference this detail object. -
-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.
- - -None
- - - - - - - - - - - -None
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'
-- [Deprecated] Validate an existing person detail object. -
-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.
- - -None
- - - - - - - - - - - -None
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'
-- [Deprecated] Create a new property object -
-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 propertyTypeId sequencePosition value | Name | -Type | -Description | -
|---|---|---|
| templateObject | - - -SoftLayer_Account_Regional_Registry_Detail_Property | - -The SoftLayer_Account_Regional_Registry_Detail_Property object that you wish to create. | -
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'
-- [Deprecated] Create multiple property objects. -
-The subnet registration detail property service has been deprecated.
-Edit multiple SoftLayer_Account_Regional_Registry_Detail_Property objects.
- - -| Name | -Type | -Description | -
|---|---|---|
| templateObjects | - - -SoftLayer_Account_Regional_Registry_Detail_Property[] | - -An array of SoftLayer_Account_Regional_Registry_Detail_Property objects that you wish to create. | -
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'
-- [Deprecated] Delete an existing property object -
-The subnet registration detail property service has been deprecated.
-This method will delete an existing SoftLayer_Account_Regional_Registry_Detail_Property object.
- - -None
- - - - - - - - - - - -None
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'
-- [Deprecated] Edit an existing property object -
-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.
- - -| Name | -Type | -Description | -
|---|---|---|
| templateObject | - - -SoftLayer_Account_Regional_Registry_Detail_Property | - -A skeleton SoftLayer_Account_Regional_Registry_Detail_Property object with only the properties defined that you wish to change. Unchanged properties are left alone. | -
None
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'
-- [Deprecated] Edit multiple property objects. -
-The subnet registration detail property service has been deprecated.
-Edit multiple SoftLayer_Account_Regional_Registry_Detail_Property objects.
- - -| Name | -Type | -Description | -
|---|---|---|
| templateObjects | - - -SoftLayer_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. | -
None
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'
-- -
-None
- - - - - - - - - - - -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'
-- Retrieve a SoftLayer_Account_Regional_Registry_Detail_Property record. -
-None
- - - - - - - - - - - -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'
-- -
-None
- - - - - - - - - - - -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'
-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.
- - -[Deprecated] Create a new property object
- -[Deprecated] Create multiple property objects.
- -[Deprecated] Delete an existing property object
- -[Deprecated] Edit an existing property object
- -[Deprecated] Edit multiple property objects.
- -[Deprecated] The SoftLayer_Account_Regional_Registry_Detail object this property belongs to
- -Retrieve a SoftLayer_Account_Regional_Registry_Detail_Property record.
- -[Deprecated] The SoftLayer_Account_Regional_Registry_Detail_Property_Type object this property belongs to
- -- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Regional_Registry_Detail_Property_Type/getAllObjects'
-- Retrieve a SoftLayer_Account_Regional_Registry_Detail_Property_Type record. -
-None
- - - - - - - - - - - -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'
-Retrieve a SoftLayer_Account_Regional_Registry_Detail_Property_Type record.
- -- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Account_Regional_Registry_Detail_Type/getAllObjects'
-- Retrieve a SoftLayer_Account_Regional_Registry_Detail_Type record. -
-None
- - - - - - - - - - - -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'
-Retrieve a SoftLayer_Account_Regional_Registry_Detail_Type record.
- -- -
-| Name | -Type | -Description | -
|---|---|---|
| target | - -enum | - -
|
-
None
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [enum]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Auxiliary_Network_Status/getNetworkStatus'
-- Adds nameservers to a domain. -
-| Name | -Type | -Description | -
|---|---|---|
| nameservers | - -string[] | - -Array of fully qualified name of the nameservers | -
None
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'
-- Deletes a registered nameserver. -
-| Name | -Type | -Description | -
|---|---|---|
| nameserver | - -string | - -The fully qualified name of the nameserver | -
None
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'
-- -
-None
- - - - - - - - - - - -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'
-- Get the authentication code for a domain. -
-None
- - - - - - - - - - - -None
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'
-- Retrieve all domain information. -
-None
- - - - - - - - - - - -None
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'
-- Retrieve domain nameservers. -
-None
- - - - - - - - - - - -None
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'
-- -
-None
- - - - - - - - - - - -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'
-- Retrieves extended attributes. -
-| Name | -Type | -Description | -
|---|---|---|
| domainName | - -string | - -The domain name (i.e. example.us). | -
None
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration/getExtendedAttributes'
-- Retrieve a SoftLayer_Dns_Domain_Registration record. -
-None
- - - - - - - - - - - -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'
-- Retrieves a registered nameserver. -
-None
- - - - - - - - - - - -None
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'
-- -
-None
- - - - - - - - - - - -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'
-- Retrieves registrant verification status. -
-None
- - - - - - - - - - - -None
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'
-- -
-None
- - - - - - - - - - - -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'
-- Retrieve domain transfer information. -
-| Name | -Type | -Description | -
|---|---|---|
| domainName | - -string | - -Domain Name | -
None
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration/getTransferInformation'
-Adds nameservers to a domain.
- -Deletes a registered nameserver.
- -The SoftLayer customer account that the domain is registered to.
- -Get the authentication code for a domain.
- -Retrieve all domain information.
- -Retrieve domain nameservers.
- -The domain registration status.
- -Retrieves extended attributes.
- -Retrieve a SoftLayer_Dns_Domain_Registration record.
- -Retrieves a registered nameserver.
- -The registrant verification status.
- -Retrieves registrant verification status.
- -Retrieve domain transfer information.
- -Locks a domain.
- -Lookup available domains and suggests other similar domain names
- -Modifies contact information for a domain.
- -Modifies a registered nameserver.
- -Creates a nameserver.
- -Removes nameservers from a domain.
- -Sends the authentication code
- -Sends verification email to the registrant.
- -Resends a transfer approval email message.
- -Sets the authentication code for a domain.
- -Unlocks a domain.
- -- Locks a domain. -
-The lockDomain method locks a domain to prevent unauthorized, unwanted or accidental changes to the domain name. When set, the following actions are prohibited:
-None
- - - - - - - - - - - -None
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'
-- Lookup available domains and suggests other similar domain names -
-| Name | -Type | -Description | -
|---|---|---|
| domainName | - -string | - -The domain name (i.e. example.com). | -
None
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration/lookupDomain'
-- Modifies contact information for a domain. -
-| Name | -Type | -Description | -
|---|---|---|
| contact | - - -SoftLayer_Container_Dns_Domain_Registration_Contact | - -Contact information | -
None
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'
-- Modifies a registered nameserver. -
-| Name | -Type | -Description | -
|---|---|---|
| oldNameserver | - -string | - -The old, fully qualified domain name of the nameserver | -
| newNameserver | - -string | - -The new, fully qualified domain name for the nameserver | -
| ipAddress | - -string | - -The IP Address of the nameserver | -
None
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'
-- Creates a nameserver. -
-| Name | -Type | -Description | -
|---|---|---|
| nameserver | - -string | - -The fully qualified name of the nameserver | -
| ipAddress | - -string | - -The IP Address of the nameserver | -
None
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'
-- Removes nameservers from a domain. -
-| Name | -Type | -Description | -
|---|---|---|
| nameservers | - -string[] | - -Array of fully qualified name of the nameservers | -
None
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'
-- Sends the authentication code -
-None
- - - - - - - - - - - -None
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'
-- Sends verification email to the registrant. -
-None
- - - - - - - - - - - -None
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'
-- Resends a transfer approval email message. -
-None
- - - - - - - - - - - -None
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'
-- Sets the authentication code for a domain. -
-| Name | -Type | -Description | -
|---|---|---|
| authenticationCode | - -string | - -Authentication Code | -
None
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'
-- Unlocks a domain. -
-None
- - - - - - - - - - - -None
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'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status/getAllObjects'
-- Retrieve a SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status record. -
-None
- - - - - - - - - - - -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'
-Retrieve a SoftLayer_Dns_Domain_Registration_Registrant_Verification_Status record.
- -- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Dns_Domain_Registration_Status/getAllObjects'
-- Retrieve a SoftLayer_Dns_Domain_Registration_Status record. -
-None
- - - - - - - - - - - -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'
-Retrieve a SoftLayer_Dns_Domain_Registration_Status record.
- -- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Hardware/{SoftLayer_HardwareID}/getDownstreamNetworkHardwareWithIncidents'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Hardware/{SoftLayer_HardwareID}/getNetworkStatusAttribute'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Hardware/{SoftLayer_HardwareID}/getStorageNetworkComponents'
-- -
-None
- - - - - - - - - - - -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'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getBoundSubnets'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getDownstreamNetworkHardwareWithIncidents'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getNetworkStatusAttribute'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Hardware_Router/{SoftLayer_Hardware_RouterID}/getStorageNetworkComponents'
-- Retrieve a bandwidth image and textual description of that image for this server. -
-| Name | -Type | -Description | -
|---|---|---|
| networkType | - -enum | - -
|
-
| snapshotRange | - -enum | - -
|
-
| draw | - -boolean | - -TRUE to generate binary image otherwise just return text | -
| dateSpecified | - -dateTime | - -Include this parameter when snapshot is ‘specified_day’ or ‘specified_range’. Needs to be formatted as: ‘MM/DD/YYYY’ | -
| dateSpecifiedEnd | - -dateTime | - -Include this parameter when snapshotRange is ‘specified_range’. Also formatted as ‘MM/DD/YYYY’. | -
None
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'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getDownstreamNetworkHardwareWithIncidents'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getIsNfsCapable'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getNetworkStatusAttribute'
-- Retrieve a graph of a server’s private network usage. -
-| Name | -Type | -Description | -
|---|---|---|
| startTime | - -string | - -The starting point to retrieve bandwidth data from, specified as a dateTime. | -
| endTime | - -string | - -The end point to retrieve bandwidth data to, specified as a dateTime. | -
None
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'
-- Retrieve a backend network VLAN by searching for an IP address. -
-| Name | -Type | -Description | -
|---|---|---|
| ipAddress | - -string | - -The server’s IP address you are searching for. | -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Hardware_SecurityModule/getPrivateVlanByIpAddress'
-- Retrieve a graph of a server’s public network usage. -
-| Name | -Type | -Description | -
|---|---|---|
| startTime | - -dateTime | - -The starting point to retrieve bandwidth data from, specified as a dateTime. | -
| endTime | - -dateTime | - -The end point to retrieve bandwidth data to, specified as a dateTime. | -
None
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'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Hardware_SecurityModule/{SoftLayer_Hardware_SecurityModuleID}/getStorageNetworkComponents'
-- Retrieve a bandwidth image and textual description of that image for this server. -
-| Name | -Type | -Description | -
|---|---|---|
| networkType | - -enum | - -
|
-
| snapshotRange | - -enum | - -
|
-
| draw | - -boolean | - -TRUE to generate binary image otherwise just return text | -
| dateSpecified | - -dateTime | - -Include this parameter when snapshot is ‘specified_day’ or ‘specified_range’. Needs to be formatted as: ‘MM/DD/YYYY’ | -
| dateSpecifiedEnd | - -dateTime | - -Include this parameter when snapshotRange is ‘specified_range’. Also formatted as ‘MM/DD/YYYY’. | -
None
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'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getDownstreamNetworkHardwareWithIncidents'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getIsNfsCapable'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getNetworkStatusAttribute'
-- Retrieve a graph of a server’s private network usage. -
-| Name | -Type | -Description | -
|---|---|---|
| startTime | - -string | - -The starting point to retrieve bandwidth data from, specified as a dateTime. | -
| endTime | - -string | - -The end point to retrieve bandwidth data to, specified as a dateTime. | -
None
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'
-- Retrieve a backend network VLAN by searching for an IP address. -
-| Name | -Type | -Description | -
|---|---|---|
| ipAddress | - -string | - -The server’s IP address you are searching for. | -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Hardware_SecurityModule750/getPrivateVlanByIpAddress'
-- Retrieve a graph of a server’s public network usage. -
-| Name | -Type | -Description | -
|---|---|---|
| startTime | - -dateTime | - -The starting point to retrieve bandwidth data from, specified as a dateTime. | -
| endTime | - -dateTime | - -The end point to retrieve bandwidth data to, specified as a dateTime. | -
None
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'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Hardware_SecurityModule750/{SoftLayer_Hardware_SecurityModule750ID}/getStorageNetworkComponents'
-- Retrieve a bandwidth image and textual description of that image for this server. -
-| Name | -Type | -Description | -
|---|---|---|
| networkType | - -enum | - -
|
-
| snapshotRange | - -enum | - -
|
-
| draw | - -boolean | - -TRUE to generate binary image otherwise just return text | -
| dateSpecified | - -dateTime | - -Include this parameter when snapshot is ‘specified_day’ or ‘specified_range’. Needs to be formatted as: ‘MM/DD/YYYY’ | -
| dateSpecifiedEnd | - -dateTime | - -Include this parameter when snapshotRange is ‘specified_range’. Also formatted as ‘MM/DD/YYYY’. | -
None
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'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getDownstreamNetworkHardwareWithIncidents'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getIsNfsCapable'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getNetworkStatusAttribute'
-- Retrieve a graph of a server’s private network usage. -
-| Name | -Type | -Description | -
|---|---|---|
| startTime | - -string | - -The starting point to retrieve bandwidth data from, specified as a dateTime. | -
| endTime | - -string | - -The end point to retrieve bandwidth data to, specified as a dateTime. | -
None
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'
-- Retrieve a backend network VLAN by searching for an IP address. -
-| Name | -Type | -Description | -
|---|---|---|
| ipAddress | - -string | - -The server’s IP address you are searching for. | -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Hardware_Server/getPrivateVlanByIpAddress'
-- Retrieve a graph of a server’s public network usage. -
-| Name | -Type | -Description | -
|---|---|---|
| startTime | - -dateTime | - -The starting point to retrieve bandwidth data from, specified as a dateTime. | -
| endTime | - -dateTime | - -The end point to retrieve bandwidth data to, specified as a dateTime. | -
None
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'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/getStorageNetworkComponents'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Location/{SoftLayer_LocationID}/getBackboneDependents'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Location/{SoftLayer_LocationID}/getMetricTrackingObject'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Location/{SoftLayer_LocationID}/getOnlineSslVpnUserCount'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Location_Datacenter/{SoftLayer_Location_DatacenterID}/getBackboneDependents'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Location_Datacenter/{SoftLayer_Location_DatacenterID}/getMetricTrackingObject'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Location_Datacenter/{SoftLayer_Location_DatacenterID}/getOnlineSslVpnUserCount'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Location_Datacenter/{SoftLayer_Location_DatacenterID}/getRoutableBoundSubnets'
-- [DEPRECATED] Retrieve a graph of a SoftLayer backbone’s recent traffic activity. -
-| Name | -Type | -Description | -
|---|---|---|
| graphTitle | - -string | - -An optional name to override a backbone graph image’s title | -
None
- [DEPRECATED] Retrieve a bandwidth graph. -
-| Name | -Type | -Description | -
|---|---|---|
| startDateTime | - -dateTime | - -The starting date of the range of graph data you wish to retrieve. | -
| endDateTime | - -dateTime | - -The ending date of the range of graph data you wish to retrieve. | -
| graphType | - -string | - -$graphType The type type of the bandwidth graph you wish to retrieve, either “public” or “private”. | -
| fontSize | - -int | - -$fontSize Size to draw the font on the graph labels and legend. | -
| graphWidth | - -int | - -$graphWidth Number of pixel wide you would like to draw the graph. | -
| graphHeight | - -int | - -$graphHeight Number of pixel high you would like to draw the graph. | -
| doNotShowTimeZone | - -boolean | - -$doNotShowTimeZone Whether or not you’d like the timezone printed on the graph margin. | -
None
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'
-- Retrieve metric detail data over a date range. -
-| Name | -Type | -Description | -
|---|---|---|
| startDate | - -dateTime | - -The starting date of the range of data you wish to collect. | -
| endDate | - -dateTime | - -The ending date of the range of data you wish to collect. | -
| graphType | - -string[] | - -The type of metric to gather data for (InstanceCount, HostMemoryUsage, HostReservedMemoryUsage). | -
None
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'
-- [DEPRECATED] Retrieve a graph of a virtual hosting platform’s per instance use. -
-| Name | -Type | -Description | -
|---|---|---|
| startDateTime | - -dateTime | - -timestamp of the starting date of the graph | -
| endDateTime | - -dateTime | - -timestamp of the ending date of the graph | -
| graphType | - -string[] | - -type of the graph (“public” or “private” for bandwidth, “InstanceCount” or “HostMemoryUsage” or “HostReservedMemoryUsage” for virtual hosts) | -
None
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'
-- Retrieve metric summary. -
-| Name | -Type | -Description | -
|---|---|---|
| graphType | - -string | - -The type of metric to gather data for (InstanceCount, HostMemoryUsage, HostReservedMemoryUsage). | -
None
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'
-- Retrieve a SoftLayer_Network record. -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network/{SoftLayer_NetworkID}/getObject'
-- Retrieve a visual representation of the amount of network traffic that occurred for the specified time frame for an application delivery controller. -
-| Name | -Type | -Description | -
|---|---|---|
| startDateTime | - -dateTime | - -datetime of the start date of the graph | -
| endDateTime | - -dateTime | - -datetime of the ending date of the graph | -
| networkType | - -string | - -$networkType type of the graph, either “public” or “private” | -
None
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'
-- Get the connection or status graph image for an application delivery controller service. -
-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.
- - -| Name | -Type | -Description | -
|---|---|---|
| service | - - -SoftLayer_Network_LoadBalancer_Service | - -The load balancer object you wish to retrieve a graph for | -
| graphType | - -string | - -The string “connections” or “status” depending on the type of graph you wish to retrieve | -
| metric | - -string | - -The string “day”, “week”, or “month” depending on the duration of data you wish to retrieve in your graph | -
None
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'
-- -
-None
- - - - - - - - - - - -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'
-- Retrieve a list of all SoftLayer Backbones -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Backbone/getAllBackbones'
-- Retrieve a list of all SoftLayer Backbones for a location name -
-| Name | -Type | -Description | -
|---|---|---|
| locationName | - -string | - -name for the location address | -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Backbone/getBackbonesForLocationName'
-- [DEPRECATED] Retrieve a graph of a SoftLayer backbone’s last 24 hours of activity. -
-None
- - - - - - - - - - - -None
- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Backbone/{SoftLayer_Network_BackboneID}/getHealth'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Backbone/{SoftLayer_Network_BackboneID}/getLocation'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Backbone/{SoftLayer_Network_BackboneID}/getNetworkComponent'
-- Retrieve a SoftLayer_Network_Backbone record. -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Backbone/{SoftLayer_Network_BackboneID}/getObject'
-Retrieve a list of all SoftLayer Backbones
- -Retrieve a list of all SoftLayer Backbones for a location name
- -[Deprecated] A backbone’s status.
- -[Deprecated] Which of the SoftLayer datacenters a backbone is connected to.
- -[Deprecated] A backbone’s primary network component.
- -Retrieve a SoftLayer_Network_Backbone record.
- -- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Backbone_Location_Dependent/getAllObjects'
-- -
-None
- - - - - - - - - - - -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'
-- Retrieve a SoftLayer_Network_Backbone_Location_Dependent record. -
-None
- - - - - - - - - - - -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'
-- -
-| Name | -Type | -Description | -
|---|---|---|
| locationName | - -string | - -- |
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'
-- -
-None
- - - - - - - - - - - -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'
-Retrieve a SoftLayer_Network_Backbone_Location_Dependent record.
- -- generate a graph image of all the bandwidth usage for an entire allotment of servers. -
-| Name | -Type | -Description | -
|---|---|---|
| networkType | - -enum | - -
|
-
| snapshotRange | - -enum | - -
|
-
| draw | - -boolean | - -TRUE to generate binary image otherwise just return text. Deprecated, images return fast enough now. | -
| dateSpecified | - -dateTime | - -Include this parameter when snapshot is ‘specified_day’ or ‘specified_range’. Needs to be formatted as: ‘MM/DD/YYYY’ | -
| dateSpecifiedEnd | - -dateTime | - -Include this parameter when snapshotRange is ‘specified_range’. Also formatted as ‘MM/DD/YYYY’ | -
None
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'
-- -
-None
- - - - - - - - - - - -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'
-- -
-None
- - - - - - - - - - - -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'
-- -
-None
- - - - - - - - - - - -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'
-- -
-None
- - - - - - - - - - - -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'
-- -
-None
- - - - - - - - - - - -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'
-- Retrieve a SoftLayer_Network_CdnMarketplace_Account record. -
-None
- - - - - - - - - - - -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'
-SoftLayer account to which the CDN account belongs.
- -An associated parent billing item which is active.
- -Retrieve a SoftLayer_Network_CdnMarketplace_Account record.
- -DEPRECATED
- -- DEPRECATED -
-| Name | -Type | -Description | -
|---|---|---|
| vendorName | - -string | - -- |
None
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Account/verifyCdnAccountExists'
-- -
-| Name | -Type | -Description | -
|---|---|---|
| input | - - -SoftLayer_Container_Network_CdnMarketplace_Configuration_Input | - -- |
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'
-- -
-| Name | -Type | -Description | -
|---|---|---|
| input | - - -SoftLayer_Container_Network_CdnMarketplace_Configuration_Input | - -- |
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'
-- -
-| Name | -Type | -Description | -
|---|---|---|
| input | - - -SoftLayer_Container_Network_CdnMarketplace_Configuration_Input | - -- |
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'
-- -
-| Name | -Type | -Description | -
|---|---|---|
| uniqueId | - -string | - -- |
None
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'
-- Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking record. -
-None
- - - - - - - - - - - -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'
-Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking record.
- -- -
-| Name | -Type | -Description | -
|---|---|---|
| input | - - -SoftLayer_Container_Network_CdnMarketplace_Configuration_Input | - -- |
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'
-- -
-| Name | -Type | -Description | -
|---|---|---|
| input | - - -SoftLayer_Container_Network_CdnMarketplace_Configuration_Input | - -- |
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'
-- -
-| Name | -Type | -Description | -
|---|---|---|
| input | - - -SoftLayer_Container_Network_CdnMarketplace_Configuration_Input | - -- |
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'
-- -
-| Name | -Type | -Description | -
|---|---|---|
| input | - - -SoftLayer_Container_Network_CdnMarketplace_Configuration_Input | - -- |
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'
-- Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection record. -
-None
- - - - - - - - - - - -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'
-Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection record.
- -- -
-| Name | -Type | -Description | -
|---|---|---|
| input | - - -SoftLayer_Container_Network_CdnMarketplace_Configuration_Input | - -- |
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'
-- DEPRECATED -
-| Name | -Type | -Description | -
|---|---|---|
| input | - - -SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader | - -- |
None
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'
-- DEPRECATED -
-| Name | -Type | -Description | -
|---|---|---|
| uniqueId | - -string | - -- |
| modResHeaderUniqueId | - -string | - -- |
None
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'
-- Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader record. -
-None
- - - - - - - - - - - -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'
-DEPRECATED
- -DEPRECATED
- -Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader record.
- -DEPRECATED
- -DEPRECATED
- -- DEPRECATED -
-| Name | -Type | -Description | -
|---|---|---|
| uniqueId | - -string | - -- |
None
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'
-- DEPRECATED -
-| Name | -Type | -Description | -
|---|---|---|
| input | - - -SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader | - -- |
None
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'
-- DEPRECATED -
-| Name | -Type | -Description | -
|---|---|---|
| input | - - -SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_TokenAuth | - -- |
None
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'
-- DEPRECATED -
-| Name | -Type | -Description | -
|---|---|---|
| uniqueId | - -string | - -- |
| path | - -string | - -- |
None
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'
-- Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth record. -
-None
- - - - - - - - - - - -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'
-DEPRECATED
- -DEPRECATED
- -Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth record.
- -DEPRECATED
- -DEPRECATED
- -- DEPRECATED -
-| Name | -Type | -Description | -
|---|---|---|
| uniqueId | - -string | - -- |
None
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'
-- DEPRECATED -
-| Name | -Type | -Description | -
|---|---|---|
| input | - - -SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_TokenAuth | - -- |
None
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'
-- DEPRECATED -
-| Name | -Type | -Description | -
|---|---|---|
| uniqueId | - -string | - -- |
| path | - -string | - -- |
None
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'
-- Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge record. -
-None
- - - - - - - - - - - -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'
-- DEPRECATED -
-| Name | -Type | -Description | -
|---|---|---|
| uniqueId | - -string | - -- |
| saved | - -int | - -- |
None
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'
-- DEPRECATED -
-| Name | -Type | -Description | -
|---|---|---|
| uniqueId | - -string | - -- |
| path | - -string | - -- |
None
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'
-DEPRECATED
- -Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge record.
- -DEPRECATED
- -DEPRECATED
- -DEPRECATED
- -- DEPRECATED -
-| Name | -Type | -Description | -
|---|---|---|
| uniqueId | - -string | - -- |
| path | - -string | - -- |
| saveOrUnsave | - -int | - -- |
None
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'
-- DEPRECATED -
-| Name | -Type | -Description | -
|---|---|---|
| uniqueId | - -string | - -Domain mapping uniqueID | -
| groupName | - -string | - -Name of purge group | -
| paths | - -string[] | - -Array of paths | -
| option | - -int | - -- |
None
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'
-- Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup record. -
-None
- - - - - - - - - - - -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'
-- DEPRECATED -
-| Name | -Type | -Description | -
|---|---|---|
| uniqueId | - -string | - -Domain mapping uniqueID | -
| groupUniqueId | - -string | - -Purge group uniqueID | -
None
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'
-- DEPRECATED -
-None
- - - - - - - - - - - -None
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup/getPurgeGroupQuota'
-DEPRECATED
- -Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup record.
- -DEPRECATED
- -DEPRECATED
- -DEPRECATED
- -DEPRECATED
- -DEPRECATED
- -DEPRECATED
- -DEPRECATED
- -- DEPRECATED -
-| Name | -Type | -Description | -
|---|---|---|
| uniqueId | - -string | - -Domain mapping uniqueID | -
None
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'
-- DEPRECATED -
-| Name | -Type | -Description | -
|---|---|---|
| uniqueId | - -string | - -Domain mapping uniqueID | -
None
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'
-- DEPRECATED -
-| Name | -Type | -Description | -
|---|---|---|
| uniqueId | - -string | - -Domain mapping uniqueID | -
| groupUniqueIds | - -string[] | - -Array of purge group uniqueID | -
None
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'
-- DEPRECATED -
-| Name | -Type | -Description | -
|---|---|---|
| uniqueId | - -string | - -Domain mapping uniqueID | -
| groupUniqueId | - -string | - -Purge group uniqueID | -
None
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'
-- DEPRECATED -
-| Name | -Type | -Description | -
|---|---|---|
| uniqueId | - -string | - -Domain mapping uniqueID | -
| groupUniqueId | - -string | - -Purge group uniqueID | -
None
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'
-- Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory record. -
-None
- - - - - - - - - - - -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'
-Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory record.
- -DEPRECATED
- -- DEPRECATED -
-| Name | -Type | -Description | -
|---|---|---|
| uniqueId | - -string | - -Domain mapping uniqueID | -
None
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'
-- DEPRECATED -
-| Name | -Type | -Description | -
|---|---|---|
| uniqueId | - -string | - -- |
| pathName | - -string | - -- |
| ttl | - -string | - -- |
None
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'
-- -
-| Name | -Type | -Description | -
|---|---|---|
| uniqueId | - -string | - -- |
| pathName | - -string | - -- |
None
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'
-- Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive record. -
-None
- - - - - - - - - - - -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'
-DEPRECATED
- -Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive record.
- -DEPRECATED
- -- -
-| Name | -Type | -Description | -
|---|---|---|
| uniqueId | - -string | - -- |
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'
-- DEPRECATED -
-| Name | -Type | -Description | -
|---|---|---|
| uniqueId | - -string | - -- |
| oldPath | - -string | - -- |
| newPath | - -string | - -- |
| oldTtl | - -string | - -- |
| newTtl | - -string | - -- |
None
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'
-- DEPRECATED -
-| Name | -Type | -Description | -
|---|---|---|
| input | - - -SoftLayer_Container_Network_CdnMarketplace_Configuration_Input | - -- |
None
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'
-- DEPRECATED -
-| Name | -Type | -Description | -
|---|---|---|
| uniqueId | - -string | - -- |
None
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'
-- Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Mapping record. -
-None
- - - - - - - - - - - -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'
-DEPRECATED
- -DEPRECATED
- -Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Mapping record.
- -DEPRECATED
- -DEPRECATED
- -DEPRECATED
- -DEPRECATED
- -DEPRECATED
- -DEPRECATED
- -DEPRECATED
- -DEPRECATED
- -- DEPRECATED -
-| Name | -Type | -Description | -
|---|---|---|
| uniqueId | - -string | - -- |
None
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'
-- DEPRECATED -
-None
- - - - - - - - - - - -None
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Configuration_Mapping/listDomainMappings'
-- DEPRECATED -
-| Name | -Type | -Description | -
|---|---|---|
| uniqueId | - -string | - -- |
None
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'
-- DEPRECATED -
-| Name | -Type | -Description | -
|---|---|---|
| uniqueId | - -string | - -- |
None
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'
-- DEPRECATED -
-| Name | -Type | -Description | -
|---|---|---|
| uniqueId | - -string | - -- |
None
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'
-- DEPRECATED -
-| Name | -Type | -Description | -
|---|---|---|
| input | - - -SoftLayer_Container_Network_CdnMarketplace_Configuration_Input | - -- |
None
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'
-- DEPRECATED -
-| Name | -Type | -Description | -
|---|---|---|
| cname | - -string | - -- |
None
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'
-- DEPRECATED -
-| Name | -Type | -Description | -
|---|---|---|
| uniqueId | - -int | - -- |
None
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'
-- DEPRECATED -
-| Name | -Type | -Description | -
|---|---|---|
| input | - - -SoftLayer_Container_Network_CdnMarketplace_Configuration_Input | - -- |
None
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'
-- DEPRECATED -
-| Name | -Type | -Description | -
|---|---|---|
| uniqueId | - -string | - -- |
| path | - -string | - -- |
None
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'
-- Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path record. -
-None
- - - - - - - - - - - -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'
-DEPRECATED
- -DEPRECATED
- -Retrieve a SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path record.
- -DEPRECATED
- -DEPRECATED
- -- DEPRECATED -
-| Name | -Type | -Description | -
|---|---|---|
| uniqueId | - -string | - -- |
None
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'
-- DEPRECATED -
-| Name | -Type | -Description | -
|---|---|---|
| input | - - -SoftLayer_Container_Network_CdnMarketplace_Configuration_Input | - -- |
None
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'
-- DEPRECATED -
-| Name | -Type | -Description | -
|---|---|---|
| vendorName | - -string | - -- |
| startDate | - -int | - -The start data timestamp(UTC+0), the date can not be earlier than 93 days ago | -
| endDate | - -int | - -The end data timestamp(UTC+0), the date can not be later than 3 days ago | -
| frequency | - -string | - -The frequency for query, supported type ‘day’, ‘aggregate’ | -
None
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'
-- DEPRECATED -
-| Name | -Type | -Description | -
|---|---|---|
| vendorName | - -string | - -- |
| startTime | - -int | - -- |
| endTime | - -int | - -- |
| timeInterval | - -int | - -- |
None
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'
-- DEPRECATED -
-| Name | -Type | -Description | -
|---|---|---|
| vendorName | - -string | - -- |
| startDate | - -int | - -- |
| endDate | - -int | - -- |
| frequency | - -string | - -- |
None
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'
-- DEPRECATED -
-| Name | -Type | -Description | -
|---|---|---|
| mappingUniqueId | - -string | - -- |
| startDate | - -int | - -- |
| endDate | - -int | - -- |
| frequency | - -string | - -- |
None
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'
-- DEPRECATED -
-| Name | -Type | -Description | -
|---|---|---|
| mappingUniqueId | - -string | - -- |
| startDate | - -int | - -- |
| endDate | - -int | - -- |
| frequency | - -string | - -- |
None
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'
-- DEPRECATED -
-| Name | -Type | -Description | -
|---|---|---|
| mappingUniqueId | - -string | - -- |
| startDate | - -int | - -- |
| endDate | - -int | - -- |
| frequency | - -string | - -- |
None
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'
-- DEPRECATED -
-| Name | -Type | -Description | -
|---|---|---|
| mappingUniqueId | - -string | - -- |
| startDate | - -int | - -- |
| endDate | - -int | - -- |
| frequency | - -string | - -- |
None
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'
-- DEPRECATED -
-| Name | -Type | -Description | -
|---|---|---|
| mappingUniqueId | - -string | - -- |
| startTime | - -int | - -- |
| endTime | - -int | - -- |
| frequency | - -string | - -- |
None
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'
-- DEPRECATED -
-| Name | -Type | -Description | -
|---|---|---|
| mappingUniqueId | - -string | - -- |
| startTime | - -int | - -- |
| endTime | - -int | - -- |
| timeInterval | - -int | - -- |
None
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'
-- DEPRECATED -
-| Name | -Type | -Description | -
|---|---|---|
| mappingUniqueId | - -string | - -- |
| startDate | - -int | - -- |
| endDate | - -int | - -- |
| frequency | - -string | - -- |
None
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'
-DEPRECATED
- -DEPRECATED
- -DEPRECATED
- -DEPRECATED
- -DEPRECATED
- -DEPRECATED
- -DEPRECATED
- -DEPRECATED
- -DEPRECATED
- -DEPRECATED
- -- Retrieve a SoftLayer_Network_CdnMarketplace_Vendor record. -
-None
- - - - - - - - - - - -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'
-Retrieve a SoftLayer_Network_CdnMarketplace_Vendor record.
- -DEPRECATED
- -- DEPRECATED -
-None
- - - - - - - - - - - -None
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_CdnMarketplace_Vendor/listVendors'
-- Retrieve various network statistics for the specific port. -
-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:
-None
- - - - - - - - - - - -None
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Component/{SoftLayer_Network_ComponentID}/getPortStatistics'
-- Change Juniper vSRX version on a Gateway -
-| Name | -Type | -Description | -
|---|---|---|
| versionId | - -int | - -Id of upgrade record in SoftLayer_Network_Gateway_VersionUpgrade | -
| rollbackVersion | - -boolean | - -[optional] [default false] If true, then rollback version. If false, then Upgrade version | -
None
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'
-- -
-| Name | -Type | -Description | -
|---|---|---|
| accountId | - -int | - -- |
| category | - -string | - -- |
None
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [int, string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Gateway/checkAccountWhiteList'
-- Create a new server gateway -
-| Name | -Type | -Description | -
|---|---|---|
| templateObject | - - -SoftLayer_Network_Gateway | - -The SoftLayer_Network_Gateway object that you wish to create. | -
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'
-- Edit Gateway -
-| Name | -Type | -Description | -
|---|---|---|
| templateObject | - - -SoftLayer_Network_Gateway | - -A skeleton SoftLayer_Network_Gateway object with only the properties defined that you wish to change. Unchanged properties are left alone. | -
None
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'
-- -
-| Name | -Type | -Description | -
|---|---|---|
| category | - -string | - -- |
None
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'
-- -
-None
- - - - - - - - - - - -None
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Gateway/{SoftLayer_Network_GatewayID}/isRollbackAllowed'
-- -
-| Name | -Type | -Description | -
|---|---|---|
| upgradePkgUrlId | - -int | - -
|
-
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [int]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Gateway_VersionUpgrade/getAllByUpgradePkgUrlId'
-- -
-| Name | -Type | -Description | -
|---|---|---|
| accountId | - -int | - -- |
| validate | - -boolean | - -- |
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'
-- -
-None
- - - - - - - - - - - -None
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Interconnect_Tenant/isAdnAccount'
-- [Deprecated] Add the required nameserver resource record for a global load balancer account. -
-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.
- - -None
- - - - - - - - - - - -None
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'
-- [Deprecated] Edit a global load balancer account and the hosts that make up the load balancing pool. -
-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.
- - -| Name | -Type | -Description | -
|---|---|---|
| templateObject | - - -SoftLayer_Network_LoadBalancer_Global_Account | - -A skeleton SoftLayer_Network_LoadBalancer_Global_Account object with only the properties defined that you wish to change. Unchanged properties are left alone. | -
None
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'
-- -
-None
- - - - - - - - - - - -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'
-- -
-None
- - - - - - - - - - - -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'
-- -
-None
- - - - - - - - - - - -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'
-- -
-None
- - - - - - - - - - - -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'
-- -
-None
- - - - - - - - - - - -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'
-- Retrieve a SoftLayer_Network_LoadBalancer_Global_Account record. -
-None
- - - - - - - - - - - -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'
-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.
- - -[Deprecated] Add the required nameserver resource record for a global load balancer account.
- -[Deprecated] Edit a global load balancer account and the hosts that make up the load balancing pool.
- -Your SoftLayer customer account.
- -The current billing item for a Global Load Balancer account.
- -The hosts in the load balancing pool for a global load balancer account.
- -The load balance method of a global load balancer account
- -A flag indicating that the global load balancer is a managed resource.
- -Retrieve a SoftLayer_Network_LoadBalancer_Global_Account record.
- -[Deprecated] Remove the required nameserver resource record for a global load balancer account.
- -- [Deprecated] Remove the required nameserver resource record for a global load balancer account. -
-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.
- - -None
- - - - - - - - - - - -None
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'
-- [Deprecated] Remove a host from the load balancing pool of a global load balancer account. -
-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.
- - -None
- - - - - - - - - - - -None
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'
-- -
-None
- - - - - - - - - - - -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'
-- Retrieve a SoftLayer_Network_LoadBalancer_Global_Host record. -
-None
- - - - - - - - - - - -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'
-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.
- - -[Deprecated] Remove a host from the load balancing pool of a global load balancer account.
- -The global load balancer account a host belongs to.
- -Retrieve a SoftLayer_Network_LoadBalancer_Global_Host record.
- -- Creates a new transcode account -
-None
- - - - - - - - - - - -None
- Creates a transcode job -
-‘‘‘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:
-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.
- - -| Name | -Type | -Description | -
|---|---|---|
| newJob | - - -SoftLayer_Network_Media_Transcode_Job | - -A template object with details of a new job | -
None
- -
-None
- - - - - - - - - - - -- Returns a directory listing -
-| Name | -Type | -Description | -
|---|---|---|
| directoryName | - -string | - -comma separated Extensions to restrict results to | -
| extensionFilter | - -string | - -A directory name | -
None
- Returns detailed information on a video or audio file -
-| Name | -Type | -Description | -
|---|---|---|
| source | - -string | - -The name of a source file | -
None
- Returns Transcode FTP login credentials -
-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.
- - -None
- - - - - - - - - - - -None
- Retrieve a SoftLayer_Network_Media_Transcode_Account record. -
-None
- - - - - - - - - - - -- Returns details on a transcode output preset -
-| Name | -Type | -Description | -
|---|---|---|
| guid | - -string | - -The unique id of a preset | -
None
- Returns an array of transcoding preset objects -
-None
- - - - - - - - - - - -None
- -
-None
- - - - - - - - - - - -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.
- - -Creates a new transcode account
- -Creates a transcode job
- -The SoftLayer account information
- -Returns a directory listing
- -Returns detailed information on a video or audio file
- -Returns Transcode FTP login credentials
- -Retrieve a SoftLayer_Network_Media_Transcode_Account record.
- -Returns details on a transcode output preset
- -Returns an array of transcoding preset objects
- -Transcode jobs
- -- Creates a 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:
-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.
- - -| Name | -Type | -Description | -
|---|---|---|
| templateObject | - - -SoftLayer_Network_Media_Transcode_Job | - -The SoftLayer_Network_Media_Transcode_Job object that you wish to create. | -
- -
-None
- - - - - - - - - - - -- Retrieve a SoftLayer_Network_Media_Transcode_Job record. -
-None
- - - - - - - - - - - -- -
-None
- - - - - - - - - - - -- -
-None
- - - - - - - - - - - -- -
-None
- - - - - - - - - - - -- -
-None
- - - - - - - - - - - -Creates a transcode job
- -Retrieve a SoftLayer_Network_Media_Transcode_Job record.
- -The transcode service account
- -The status information of a transcode job
- -The status of a transcode job
- -The SoftLayer user that created the transcode job
- -- Returns all transcode job statuses -
-None
- - - - - - - - - - - -- Retrieve a SoftLayer_Network_Media_Transcode_Job_Status record. -
-None
- - - - - - - - - - - -Returns all transcode job statuses
- -Retrieve a SoftLayer_Network_Media_Transcode_Job_Status record.
- -- -
-None
- - - - - - - - - - - -None
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Storage/{SoftLayer_Network_StorageID}/getCdnUrls'
-- [DEPRECATED] Retrieve a graph representing the bandwidth used by a Storage account. -
-{{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.
- - -| Name | -Type | -Description | -
|---|---|---|
| startDate | - -dateTime | - -The starting date of the range of data you wish to collect. | -
| endDate | - -dateTime | - -The ending date of the range of data you wish to collect. | -
| type | - -string | - -The type of data you wish to graph. Either “usage”, “upload”, “download” or “bandwidth”. | -
None
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'
-- -
-None
- - - - - - - - - - - -None
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'
-- [DEPRECATED] Retrieve a graph representing the bandwidth used by a Storage account. -
-{{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.
- - -| Name | -Type | -Description | -
|---|---|---|
| startDate | - -dateTime | - -The starting date of the range of data you wish to collect. | -
| endDate | - -dateTime | - -The ending date of the range of data you wish to collect. | -
| type | - -string | - -The type of data you wish to graph. Either “usage”, “upload”, “download” or “bandwidth”. | -
None
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'
-- -
-None
- - - - - - - - - - - -None
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'
-- [DEPRECATED] Retrieve a graph representing the bandwidth used by a Storage account. -
-{{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.
- - -| Name | -Type | -Description | -
|---|---|---|
| startDate | - -dateTime | - -The starting date of the range of data you wish to collect. | -
| endDate | - -dateTime | - -The ending date of the range of data you wish to collect. | -
| type | - -string | - -The type of data you wish to graph. Either “usage”, “upload”, “download” or “bandwidth”. | -
None
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'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref/getAllObjects'
-- -
-None
- - - - - - - - - - - -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'
-- -
-None
- - - - - - - - - - - -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'
-- Retrieve a SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref record. -
-None
- - - - - - - - - - - -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'
-- return countries assigned to the region having pricing info set. -
-| Name | -Type | -Description | -
|---|---|---|
| locationGroupName | - -string | - -- |
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'
-SoftLayer_Locale_Country Id.
- -Location Group ID of CleverSafe cross region.
- -Retrieve a SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref record.
- -return countries assigned to the region having pricing info set.
- -- -
-None
- - - - - - - - - - - -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'
-- -
-None
- - - - - - - - - - - -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'
-- -
-None
- - - - - - - - - - - -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'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Storage_MassDataMigration_Request/getAllObjects'
-- Retrieves a list of all the possible statuses -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Storage_MassDataMigration_Request/getAllRequestStatuses'
-- -
-None
- - - - - - - - - - - -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'
-- -
-None
- - - - - - - - - - - -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'
-- -
-None
- - - - - - - - - - - -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'
-- -
-None
- - - - - - - - - - - -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'
-- -
-None
- - - - - - - - - - - -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'
-- -
-None
- - - - - - - - - - - -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'
-- -
-None
- - - - - - - - - - - -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'
-- -
-None
- - - - - - - - - - - -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'
-- Retrieve a SoftLayer_Network_Storage_MassDataMigration_Request record. -
-None
- - - - - - - - - - - -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'
-- Returns placeholder MDMS requests for any MDMS order pending approval. -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Storage_MassDataMigration_Request/getPendingRequests'
-- -
-None
- - - - - - - - - - - -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'
-- -
-None
- - - - - - - - - - - -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'
-- -
-None
- - - - - - - - - - - -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'
-- -
-None
- - - - - - - - - - - -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'
-The account to which the request belongs.
- -The active tickets that are attached to the MDMS request.
- -The customer address where the device is shipped to.
- -Retrieves a list of all the possible statuses
- -An associated parent billing item which is active. Includes billing items which are scheduled to be cancelled in the future.
- -The employee user who created the request.
- -The customer user who created the request.
- -The device configurations.
- -The model of device assigned to this request.
- -The key contacts for this requests.
- -The employee who last modified the request.
- -The customer user who last modified the request.
- -Retrieve a SoftLayer_Network_Storage_MassDataMigration_Request record.
- -Returns placeholder MDMS requests for any MDMS order pending approval.
- -The shipments of the request.
- -The status of the request.
- -Ticket that is attached to this mass data migration request.
- -All tickets that are attached to the mass data migration request.
- -- -
-None
- - - - - - - - - - - -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'
-- Retrieve a SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact record. -
-None
- - - - - - - - - - - -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'
-- -
-None
- - - - - - - - - - - -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'
-The request this key contact belongs to.
- -Retrieve a SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact record.
- -The request this key contact belongs to.
- -- Retrieve a SoftLayer_Network_Storage_MassDataMigration_Request_Status record. -
-None
- - - - - - - - - - - -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'
-- create a new transaction to modify a subnet route. -
-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.
- - -| Name | -Type | -Description | -
|---|---|---|
| newEndPointIpAddress | - -string | - -The IP address to route the subnet to | -
None
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'
-- create a SWIP transaction for a subnet -
-None
- - - - - - - - - - - -None
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/createSwipTransaction'
-- Retrieve a list of subnets along with their SWIP transaction statuses. -
-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.
- - -None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Subnet/findAllSubnetsAndActiveSwipTransactionStatus'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/getActiveRegistration'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/getActiveSwipTransaction'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/getBoundRouters'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/getRegistrations'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Subnet/{SoftLayer_Network_SubnetID}/getSwipTransaction'
-- -
-None
- - - - - - - - - - - -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'
-- -
-None
- - - - - - - - - - - -None
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'
-- [Deprecated] Clear an existing registration -
-The subnet registration service has been deprecated.
-This method will initiate the removal of a subnet registration.
- - -None
- - - - - - - - - - - -None
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'
-- [Deprecated] Create a new subnet registration -
-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 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.
| Name | -Type | -Description | -
|---|---|---|
| templateObject | - - -SoftLayer_Network_Subnet_Registration | - -The SoftLayer_Network_Subnet_Registration object that you wish to create. | -
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'
-- [Deprecated] Create registrations for multiple subnets -
-The subnet registration service has been deprecated.
-Create registrations with respective registrars to associate multiple assigned subnets with the provided contact details.
- - -| Name | -Type | -Description | -
|---|---|---|
| templateObjects | - - -SoftLayer_Network_Subnet_Registration[] | - -An array of SoftLayer_Network_Subnet_Registration objects that you wish to create. | -
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'
-- [Deprecated] Edit an existing registration object -
-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.
- - -| Name | -Type | -Description | -
|---|---|---|
| templateObject | - - -SoftLayer_Network_Subnet_Registration | - -A skeleton SoftLayer_Network_Subnet_Registration object with only the properties defined that you wish to change. Unchanged properties are left alone. | -
None
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'
-- [Deprecated] Modify the link between a SoftLayer_Network_Subnet_Registration object and two SoftLayer_Account_Regional_Registry_Detail objects simultaneously. -
-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.
- - -| Name | -Type | -Description | -
|---|---|---|
| personObjectSkeleton | - - -SoftLayer_Network_Subnet_Registration_Details | - -- |
| networkObjectSkeleton | - - -SoftLayer_Network_Subnet_Registration_Details | - -- |
None
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'
-- -
-None
- - - - - - - - - - - -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'
-- -
-None
- - - - - - - - - - - -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'
-- -
-None
- - - - - - - - - - - -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'
-- -
-None
- - - - - - - - - - - -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'
-- Retrieve a SoftLayer_Network_Subnet_Registration record. -
-None
- - - - - - - - - - - -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'
-- -
-None
- - - - - - - - - - - -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'
-- -
-None
- - - - - - - - - - - -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'
-- -
-None
- - - - - - - - - - - -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'
-- -
-None
- - - - - - - - - - - -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'
-- -
-None
- - - - - - - - - - - -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'
-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.
- - -[Deprecated] Clear an existing registration
- -[Deprecated] Create a new subnet registration
- -[Deprecated] Create registrations for multiple subnets
- -[Deprecated] Edit an existing registration object
- -[Deprecated] Modify the link between a SoftLayer_Network_Subnet_Registration object and two SoftLayer_Account_Regional_Registry_Detail objects simultaneously.
- -[Deprecated] The account that this registration belongs to.
- -[Deprecated] The cross-reference records that tie the SoftLayer_Account_Regional_Registry_Detail objects to the registration object.
- -[Deprecated] The related registration events.
- -[Deprecated] The “network” detail object.
- -Retrieve a SoftLayer_Network_Subnet_Registration record.
- -[Deprecated] The “person” detail object.
- -[Deprecated] The related Regional Internet Registry.
- -[Deprecated] The RIR handle that this registration object belongs to. This field may not be populated until the registration is complete.
- -[Deprecated] The status of this registration.
- -[Deprecated] The subnet that this registration pertains to.
- -- [Deprecated] Create a new association between a SoftLayer_Network_Subnet_Registration object and a SoftLayer_Account_Regional_Registry_Detail object. -
-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
detailId registrationId | Name | -Type | -Description | -
|---|---|---|
| templateObject | - - -SoftLayer_Network_Subnet_Registration_Details | - -The SoftLayer_Network_Subnet_Registration_Details object that you wish to create. | -
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'
-- [Deprecated] Remove an existing association between a SoftLayer_Network_Subnet_Registration object and a SoftLayer_Account_Regional_Registry_Detail object. -
-The subnet registration details service has been deprecated.
-This method will delete an existing SoftLayer_Account_Regional_Registry_Detail object.
- - -None
- - - - - - - - - - - -None
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'
-- -
-None
- - - - - - - - - - - -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'
-- Retrieve a SoftLayer_Network_Subnet_Registration_Details record. -
-None
- - - - - - - - - - - -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'
-- -
-None
- - - - - - - - - - - -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'
-[Deprecated] Create a new association between a SoftLayer_Network_Subnet_Registration object and a SoftLayer_Account_Regional_Registry_Detail object.
- -[Deprecated] Remove an existing association between a SoftLayer_Network_Subnet_Registration object and a SoftLayer_Account_Regional_Registry_Detail object.
- -[Deprecated] The related SoftLayer_Account_Regional_Registry_Detail.
- -Retrieve a SoftLayer_Network_Subnet_Registration_Details record.
- -[Deprecated] The related SoftLayer_Network_Subnet_Registration.
- -- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Subnet_Registration_Status/getAllObjects'
-- Retrieve a SoftLayer_Network_Subnet_Registration_Status record. -
-None
- - - - - - - - - - - -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'
-Retrieve a SoftLayer_Network_Subnet_Registration_Status record.
- --
Edit the RWHOIS record by passing in a modified version of the record object. All fields are editable. The fields are as follows:
-| Name | -Type | -Description | -
|---|---|---|
| templateObject | - - -SoftLayer_Network_Subnet_Rwhois_Data | - -A skeleton SoftLayer_Network_Subnet_Rwhois_Data object with only the properties defined that you wish to change. Unchanged properties are left alone. | -
None
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'
-- -
-None
- - - - - - - - - - - -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'
-- Retrieve a SoftLayer_Network_Subnet_Rwhois_Data record. -
-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.
- - -None
- - - - - - - - - - - -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'
-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.
- - -Edit the RWHOIS record by passing in a modified version of the record object. All fields are editable. The fields are as follows:
-The SoftLayer customer account associated with this reverse WHOIS data.
- -Retrieve a SoftLayer_Network_Subnet_Rwhois_Data record.
- -- returns SWIP transaction objects that are currently in transaction with ARIN. -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Subnet_Swip_Transaction/findMyTransactions'
-- -
-None
- - - - - - - - - - - -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'
-- Retrieve a SoftLayer_Network_Subnet_Swip_Transaction record. -
-None
- - - - - - - - - - - -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'
-- -
-None
- - - - - - - - - - - -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'
-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.
- - -returns SWIP transaction objects that are currently in transaction with ARIN.
- -The Account whose RWHOIS data was used to SWIP this subnet
- -Retrieve a SoftLayer_Network_Subnet_Swip_Transaction record.
- -The subnet that this SWIP transaction was created for.
- -Removes registration information from ARIN for all your subnets
- -Deletes registration information from ARIN for a single subnet
- -Sends updated RWHOIS information to ARIN for a single subnet.
- -create SWIP transactions for all subnets that do not already have a SWIP transaction in progress.
- -Update all subnets on the account with an “OK” status.
- -- Removes registration information from ARIN for all your subnets -
-None
- - - - - - - - - - - -None
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Subnet_Swip_Transaction/removeAllSubnetSwips'
-- Deletes registration information from ARIN for a single subnet -
-None
- - - - - - - - - - - -None
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'
-- Sends updated RWHOIS information to ARIN for a single subnet. -
-None
- - - - - - - - - - - -None
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'
-- create SWIP transactions for all subnets that do not already have a SWIP transaction in progress. -
-None
- - - - - - - - - - - -None
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Subnet_Swip_Transaction/swipAllSubnets'
-- Update all subnets on the account with an “OK” status. -
-None
- - - - - - - - - - - -None
curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Subnet_Swip_Transaction/updateAllSubnetSwips'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/getExtensionRouter'
-- [DEPRECATED] Retrieve the IP addresses routed on this VLAN that are protectable by a Hardware Firewall. -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/getFirewallProtectableIpAddresses'
-- [DEPRECATED] Retrieve the subnets routed on this VLAN that are protectable by a Hardware Firewall. -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/getFirewallProtectableSubnets'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/getNetwork'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/getNetworkSpace'
-- [DEPRECATED] Retrieve the private network VLAN associated with an IP address. -
-| Name | -Type | -Description | -
|---|---|---|
| ipAddress | - -string | - -The IPv4 address to search for | -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Vlan/getPrivateVlanByIpAddress'
-- [DEPRECATED] Retrieve a public VLAN by an associated host’s fully-qualified domain name -
-| Name | -Type | -Description | -
|---|---|---|
| fqdn | - -string | - -The fully-qualified domain name of the server you wish to search for. This follows the naming convention “{hostname}.{domain}”. | -
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Vlan/getPublicVlanByFqdn'
-- [DEPRECATED] DNS PTR records associated with IP addresses routed on this VLAN. -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/getReverseDomainRecords'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/getSecondaryRouter'
-- [DEPRECATED] Update the firewall associated to this VLAN to allow or disallow intra-VLAN communication. -
-| Name | -Type | -Description | -
|---|---|---|
| enabled | - -boolean | - -Whether or not intra-VLAN communication should be enabled. | -
None
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'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getCdnItems'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getDeploymentPackages'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Product_Package/{SoftLayer_Product_PackageID}/getDeployments'
-- Perform a nameserver lookup on given address. -
-| Name | -Type | -Description | -
|---|---|---|
| address | - -string | - -An IP address or hostname to nslookup. | -
| type | - -string | - -The type of record to return A, MX, NS, CNAME, TXT. | -
None
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string, string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Utility_Network/nsLookup'
-- Perform a WHOIS lookup on a given address. -
-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.
-
- | Name | -Type | -Description | -
|---|---|---|
| address | - -string | - -An IP address or hostname to whois. | -
None
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Utility_Network/whois'
-- Retrieve a visual representation of the amount of network traffic that occurred for the specified time frame for a computing instance. -
-| Name | -Type | -Description | -
|---|---|---|
| networkType | - -enum | - -
|
-
| snapshotRange | - -enum | - -
|
-
| dateSpecified | - -dateTime | - -Include this parameter when snapshot is ‘specified_day’ or ‘specified_range’. Needs to be formatted as: ‘MM/DD/YYYY’ | -
| dateSpecifiedEnd | - -dateTime | - -Include this parameter when snapshotRange is ‘specified_range’. Also formatted as ‘MM/DD/YYYY’.’ | -
None
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'
-- Retrieve a visual representation of the amount of network traffic that occurred for the specified time frame for a computing instance. -
-| Name | -Type | -Description | -
|---|---|---|
| startDateTime | - -dateTime | - -datetime of the start date of the graph | -
| endDateTime | - -dateTime | - -datetime of the ending date of the graph | -
| networkType | - -string | - -type of the graph, either “public” or “private” | -
None
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'
-- 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. -
-| Name | -Type | -Description | -
|---|---|---|
| snapshotRange | - -enum | - -
|
-
| dateSpecified | - -dateTime | - -Include this parameter when snapshot is ‘specified_day’. Needs to be formatted as: ‘MM/DD/YYYY HH:00’ | -
None
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'
-- 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. -
-| Name | -Type | -Description | -
|---|---|---|
| startDateTime | - -dateTime | - -datetime of the start date of the graph | -
| endDateTime | - -dateTime | - -datetime of the ending date of the graph | -
| cpuIndexes | - -int[] | - -reserved for future use. An array of cpu index numbers to specify which cpus to graph | -
None
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'
-- Retrieve a visual representation of the amount of memory used for the specified time frame for a computing instance. -
-| Name | -Type | -Description | -
|---|---|---|
| snapshotRange | - -enum | - -
|
-
| dateSpecified | - -dateTime | - -Include this parameter when snapshot is ‘specified_day’ or ‘specified_range’. Needs to be formatted as: ‘MM/DD/YYYY’ | -
None
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'
-- Retrieve a visual representation of the amount of memory used for the specified time frame for a computing instance. -
-| Name | -Type | -Description | -
|---|---|---|
| startDateTime | - -dateTime | - -datetime of the start date of the graph | -
| endDateTime | - -dateTime | - -datetime of the ending date of the graph | -
None
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'
-- -
-| Name | -Type | -Description | -
|---|---|---|
| secret | - -string | - -- |
None
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'
-- -
-None
- - - - - - - - - - - -curl -g -u $SL_USER:$SL_APIKEY -X GET \
-'https://api.softlayer.com/rest/v3.1/SoftLayer_Virtual_Host/{SoftLayer_Virtual_HostID}/getMetricTrackingObject'
-- Returns the average disk usage for the timeframe based on the parameters provided. -
-| Name | -Type | -Description | -
|---|---|---|
| startDateTime | - -dateTime | - -datetime of the start date of the graph | -
| endDateTime | - -dateTime | - -datetime of the ending date of the graph | -
None
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'
-- Retrieve the metric data for disk space usage for a storage repository. -
-| Name | -Type | -Description | -
|---|---|---|
| startDateTime | - -dateTime | - -datetime of the start date of the graph | -
| endDateTime | - -dateTime | - -datetime of the ending date of the graph | -
None
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'
-- Retrieve an image of the disk usage data on a SoftLayer_Virtual_Guest image for the time range you provide. -
-| Name | -Type | -Description | -
|---|---|---|
| startDateTime | - -dateTime | - -datetime of the start date of the graph | -
| endDateTime | - -dateTime | - -datetime of the ending date of the graph | -
None
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'
-- -
-| Name | -Type | -Description | -
|---|---|---|
| citrixCredentials | - - -SoftLayer_Workload_Citrix_Request | - -null $citrixCredentials | -
None
- -
-| Name | -Type | -Description | -
|---|---|---|
| citrixCredentials | - - -SoftLayer_Workload_Citrix_Request | - -null $citrixCredentials | -
None
- -
-| Name | -Type | -Description | -
|---|---|---|
| citrixCredentials | - - -SoftLayer_Workload_Citrix_Request | - -null $citrixCredentials | -
None
- -
-| Name | -Type | -Description | -
|---|---|---|
| templateObject | - - -SoftLayer_Workload_Citrix_Deployment | - -The SoftLayer_Workload_Citrix_Deployment object that you wish to create. | -
- -
-None
- - - - - - - - - - - -- -
-None
- - - - - - - - - - - -- -
-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.
- - -| Name | -Type | -Description | -
|---|---|---|
| deploymentId | - -int | - -- |
- Retrieve a SoftLayer_Workload_Citrix_Deployment record. -
-None
- - - - - - - - - - - -- -
-None
- - - - - - - - - - - -- -
-None
- - - - - - - - - - - -- -
-None
- - - - - - - - - - - -- -
-None
- - - - - - - - - - - -- -
-None
- - - - - - - - - - - -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.
- - -Creates a new Citrix Virtual Apps and Desktops deployment.
- -The SoftLayer_Account to which the deployment belongs.
- -Get all Citrix Virtual Apps And Desktop deployments.
- -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 …
- -Retrieve a SoftLayer_Workload_Citrix_Deployment record.
- -It contains a collection of items under the CVAD deployment.
- -Current Status of the CVAD deployment.
- -It shows if the deployment is for Citrix Hypervisor or VMware.
- -It is the SoftLayer_User_Customer who placed the order for CVAD.
- -It is the VLAN resource for the CVAD deployment.
- -- Add the resource into CVAD deployment resources. -
-| Name | -Type | -Description | -
|---|---|---|
| templateObject | - - -SoftLayer_Workload_Citrix_Deployment_Resource | - -The SoftLayer_Workload_Citrix_Deployment_Resource object that you wish to create. | -
- Get all the Citrix deployment resources. -
-None
- - - - - - - - - - - -- -
-None
- - - - - - - - - - - -- -
-None
- - - - - - - - - - - -- Retrieve a SoftLayer_Workload_Citrix_Deployment_Resource record. -
-None
- - - - - - - - - - - -- -
-None
- - - - - - - - - - - -- -
-None
- - - - - - - - - - - -Add the resource into CVAD deployment resources.
- -Get all the Citrix deployment resources.
- -Retrieve a SoftLayer_Workload_Citrix_Deployment_Resource record.
- -- Retrieve a SoftLayer_Workload_Citrix_Deployment_Type record. -
-None
- - - - - - - - - - - -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.
- - -Retrieve a SoftLayer_Workload_Citrix_Deployment_Type record.
- -- Cancel the orders associated with resources on the provided VLAN -
-| Name | -Type | -Description | -
|---|---|---|
| vlanIdentifier | - -string | - -The name, id or identifier (mex09.bcr22.1157) for the vlan. | -
| cancelImmediately | - -boolean | - -This will trigger an immediate cancellation with a reclaim of the resource. | -
| customerNote | - -string | - -Tracks any additional information that the customer wanted to provide. | -
None
- Get a list of all VLAN names which have ‘cvad’ tags associated with them. -
-None
- - - - - - - - - - - -None
- List the orders associated with resources on the provided VLAN -
-| Name | -Type | -Description | -
|---|---|---|
| vlanIdentifier | - -string | - -The name, id or identifier (e.g. mex09.bcr22.1157) for the vlan. | -
None
Cancel the orders associated with resources on the provided VLAN
- -Get a list of all VLAN names which have ‘cvad’ tags associated with them.
- -List the orders associated with resources on the provided VLAN
- -Verify that an order may be successfully placed with the details provided.
- -- -
-| Name | -Type | -Description | -
|---|---|---|
| orderContainer | - - -SoftLayer_Workload_Citrix_Workspace_Order_Container | - -- |
None
- Verify that an order may be successfully placed with the details provided. -
-| Name | -Type | -Description | -
|---|---|---|
| orderContainer | - - -SoftLayer_Workload_Citrix_Workspace_Order_Container | - -- |
None